Key

Parameters

This endpoint takes no parameters.

Request

curl -s "https://api.cantoncap.cc/v1/key/info" \
  -H "X-API-Key: $CANTONCAP_API_KEY"

Response

200 The calling key's plan, limits and usage.

{
  "status": {
    "timestamp": "2026-10-11T14:00:00.000Z",
    "elapsed_ms": 18,
    "error_code": 0,
    "error_message": null,
    "request_id": "req_7Hk2pQ9xLm"
  },
  "data": {
    "plan": {
      "plan_id": "developer",
      "version": "2026-11",
      "status": "active",
      "paid_through": null,
      "credit_limit_monthly": 150000,
      "credit_limit_monthly_reset": "In 28 days, 14 hours, 45 minutes",
      "credit_limit_monthly_reset_timestamp": "2026-12-01T00:00:00.000Z",
      "rate_limit_minute": 300,
      "connection_limit": 0,
      "key_limit": 5
    },
    "usage": {
      "current_minute": {
        "requests_made": 4,
        "requests_left": 296
      },
      "current_day": {
        "credits_used": 2
      },
      "current_month": {
        "credits_used": 42,
        "credits_left": 149958
      },
      "connections": {
        "open": 0,
        "left": 0
      },
      "keys": {
        "count": 2,
        "left": 3
      }
    }
  }
}

• dataobject

  The calling key's plan, limits and usage, shared by every key of its account. The credit fields are null for a key with limits of its own, which has no monthly allowance.

  26 child fields

  • planobject

    The plan the key is held to and its limits, shared by every key of the account.

    10 child fields

    • plan_idstring

      The plan, such as free, developer or pro.

    • versionstringnullable

      The plan catalogue version, such as 2026-11; null for a key with limits of its own.

    • statusenum

      The account's status. Only an active account is served; keys of other accounts are refused with 402 or 403.

      One ofactivenot_activatedpayment_expiredsuspended
    • paid_throughdate-timenullable

      When paid access ends; null when nothing is prepaid.

    • credit_limit_monthlyintegernullable

      Credits the account may use each period; null when it has no monthly allowance.

    • credit_limit_monthly_resetstringnullable

      Time until the credits reset, rounded up to the minute, such as In 28 days, 14 hours, 45 minutes.

    • credit_limit_monthly_reset_timestampdate-timenullable

      When the next period starts and the credits reset, 00:00 UTC on the 1st.

    • rate_limit_minuteinteger

      Requests per minute, shared by the account's keys.

    • connection_limitinteger

      Concurrent WebSocket connections per account; 0 when the plan does not stream.

    • key_limitinteger

      Keys an account may hold.

  • usageobject

    What the account has used, counted from the same state admission checks.

    14 child fields

    • current_minuteobject

      The account's requests in the current minute window, which the X-RateLimit headers also report.

      2 child fields

      • requests_madeinteger

        Requests this minute, this one included, as X-RateLimit-Remaining counts them.

      • requests_leftinteger
    • current_dayobject

      Credits used in the current UTC day. Only reported; no daily limit applies.

      1 child field

      • credits_usedintegernullable

        Credits used since 00:00 UTC; null without a monthly allowance.

    • current_monthobject

      Credits used and left in the current credit period, which CoinMarketCap calls the month.

      2 child fields

      • credits_usedintegernullable

        Credits used this period; it can pass the limit by the cost of requests in flight when the allowance ran out.

      • credits_leftintegernullable
    • connectionsobject

      The account's open WebSocket connections and the slots left under connection_limit.

      2 child fields

      • openinteger

        Open WebSocket connections of the account.

      • leftinteger
    • keysobject

      The account's keys and how many more it may hold under key_limit.

      2 child fields

      • countinteger

        The account's keys, disabled ones included.

      • leftinteger

Headers

• X-RateLimit-Limit Maximum requests admitted in the current plan window, which every key of an account shares.
• X-RateLimit-Remaining Requests remaining in the current plan window, across every key of the account.
• X-RateLimit-Reset Unix timestamp in seconds when the current plan window resets.
• Cache-Control private, no-store Prevents every cache, private or shared, from storing the response. Every error response carries it.

Errors