System

API Plan & Usage Status

Description

Returns the authenticated user's current plan, rate limit (RPM), and credit usage for the active billing period.

Tip: Poll it to monitor quota and build adaptive request throttling.

Access

  • Available from: Sandbox
  • Cost: Free
get/v3/status

Request

  • Base URL: https://api.cryptorank.io
  • URL: https://api.cryptorank.io/v3/status
  • Auth: API key in header X-Api-Key

Response

currentPeriodEndstring required

End of the current credit period. ISO 8601

currentPeriodStartstring required

Start of the current credit period, inclusive. ISO 8601

endpointsstring[] required

API endpoints available on the current plan, as path templates

planstring required

Subscription plan name

rateLimitPerMinutenumber required

User's current rate limit, requests per minute

Example response

{
  "credits": {
    "dailyLimit": 250000,
    "dailyRemaining": 248800,
    "dailyUsed": 1200,
    "monthlyLimit": 5000000,
    "monthlyRemaining": 4995800,
    "monthlyUsed": 4200
  },
  "currentPeriodEnd": "2026-06-11T07:38:09.723Z",
  "currentPeriodStart": "2026-05-11T07:38:09.723Z",
  "endpoints": [
    "/v3/currencies/list",
    "/v3/currencies/map",
    "/v3/currencies/{id}",
    "/v3/global/market"
  ],
  "plan": "Business",
  "rateLimitPerMinute": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.