Ranksy API

The Ranksy public REST API (v1) is how Shopify app developers reach their app data from their own code. Read your revenue, customers, rankings, reviews, and traffic; send merchant data back in with identify, track, and conversion signals. Ranksy observes your apps through the Shopify Partner API and the public App Store, and this API hands you the same data.

What this API is

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. Most endpoints read data (metrics, customers, rankings, reviews, traffic, catalog); a few write it in (identify, track, conversion signals, and customer notes). Ranksy itself is not a Shopify app; it is the observer that pulls these figures from the Shopify Partner API and the App Store 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 https://ranksyapp.com/api/v1/apps/01JN4HKQX0000000000000000/metrics/mrr \
  -H "Authorization: Bearer rk_live_..."

{
  "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 for a paginated time series instead of a snapshot. See Metrics for the full catalog.

The surface area

The API is grouped by what you're working with:

• Apps — list your team's apps and read a single app's overview. Every other endpoint takes an app ULID.
• Revenue — Metrics (MRR, ARR, churn, LTV, NRR, and more), plus the rows behind them: Subscriptions, Transactions, and LTV cohorts.
• CRM — merchant profiles and their Notes.
• Sending data in — Identify a merchant, Track events, and push Conversion signals.
• Usage — the Usage events log and per-handle Usage metrics.
• Growth — Rankings and Traffic & installs.
• Reputation — Reviews, Scorecard, and Competitors.
• Catalog — the public App Store category data, across every app.

There is also a health check that needs no authentication:

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

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

Next steps

Authentication — Requests carry a team-scoped Bearer key (rk_live_ / rk_test_), scoped to what each key may read or write. 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.