Ranksy API

The Ranksy public REST API (v1) is a read-only interface to the Shopify partner metrics for the apps your team tracks — MRR, installs, churn, trial conversion, LTV, NRR, and more. Ranksy is the SaaS that Shopify app developers use to observe their apps; this API hands you the same numbers, programmatically.

What this API is

The v1 API exposes one thing well: the partner metrics for each Shopify app on your Ranksy team. It is read-only. Every request is authenticated with a team-scoped key, and every response resolves to that key's team — you only ever see your own apps. Ranksy itself is not a Shopify app; it is the observer that pulls these figures from the Shopify Partner API on your behalf.

# Base URL
https://ranksyapp.com/api/v1

30-second quickstart

Grab an API key from your team settings, then fetch a point-in-time MRR snapshot for one of your apps. Pass the app's ULID and the metric name in the path:

cURL

curl https://ranksyapp.com/api/v1/apps/01JN4HKQX0000000000000000/metrics/mrr \
  -H "Authorization: Bearer rk_live_..."

Response

{
  "object": "metric",
  "id": "mrr",
  "app": "01JN4HKQX0000000000000000",
  "date": "2026-05-29",
  "value": 2331.52,
  "currency": "USD",
  "metadata": { "partner_sync_status": "complete", "currency_basis": "base" }
}

Add start_date and/or end_date to the same URL to get a paginated time series instead of a snapshot. See Metrics for every parameter and the full catalog.

The surface area

The entire metrics surface is a single endpoint:

GET /api/v1/apps/{app}/metrics/{metric} — where {app} is your team app's ULID and {metric} is one of the 12 catalog metrics. With no date params it returns a snapshot; with dates it returns a series.

There is also a trivial health check that needs no authentication:

cURL

curl https://ranksyapp.com/api/v1/__ping

Response

{ "object": "ping", "ok": true }

Next steps

Authentication — Requests carry a team-scoped Bearer key (rk_live_ / rk_test_) with the metrics:read scope. Learn about authentication.

Errors & rate limits — One consistent error envelope, stable error codes, and per-key limits of 120 requests/minute and 50,000 requests/day. Read the reference.

Guides

Authentication

Authenticate requests with a team-scoped Bearer key (rk_live_ / rk_test_).

Read more

Metrics

The single metrics endpoint: snapshots and time series for 12 partner metrics.

Read more

Errors & rate limits

The error envelope, every error code, and the per-key rate limits.

Read more

OpenAPI spec

Download the OpenAPI 3.1 description of the v1 API for codegen and tooling.

Read more

Resources

Authentication

Use a team-scoped Bearer key (rk_live_ or rk_test_) with the metrics:read scope. Issue keys in team settings.

Metrics

One endpoint exposes 12 Shopify partner metrics per tracked app, as a point-in-time snapshot or a paginated time series.

Errors & rate limits

A single error envelope with stable codes, plus the per-key rate limits (120/min and 50,000/day).

OpenAPI spec

Download the OpenAPI 3.1 document describing the v1 metrics endpoint for client generation and tooling.

Was this page helpful?