> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptorank.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Plan & Usage Status

> Returns the authenticated user's current plan, rate limit (RPM), and credit usage for the active billing period.<br/><br/>Available from&#58; <Badge color="gray">Sandbox</Badge><br/>Cost&#58; <Badge color="surface">Free</Badge>

<Tip>
  Poll it to monitor quota and build adaptive request throttling.
</Tip>


## OpenAPI

````yaml https://api.cryptorank.io/v3/documentation-json get /v3/status
openapi: 3.0.0
info:
  title: Cryptorank API V3
  description: >
    # Overview


    Cryptorank Public API v3 — comprehensive cryptocurrency data for B2B clients
    and partners.


    Useful Links:

    - [API Plans](https://cryptorank.io/public-api)

    - [Dashboard](https://cryptorank.io/public-api/dashboard)


    # Getting Started


    Primary Server URL:
    [https://api.cryptorank.io/v3/](https://api.cryptorank.io/v3/)


    **Authentication**


    Generate an API key in the
    [dashboard](https://cryptorank.io/public-api/dashboard) and pass it in the
    `X-Api-Key` header.


    Keep your keys secret — never commit them to public repositories or expose
    them in client-side code.
  version: 3.0.0
  contact:
    name: Cryptorank Team
    url: https://cryptorank.io
    email: info@cryptorank.io
servers:
  - url: https://api.cryptorank.io
security: []
tags: []
paths:
  /v3/status:
    get:
      tags:
        - System
      summary: API Plan & Usage Status
      description: >-
        **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
      operationId: SystemController_status
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponseDto'
        '401':
          description: API key is missing or invalid
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - status
                    properties:
                      code:
                        type: string
                        enum:
                          - API_KEY_MISSING
                          - API_KEY_INVALID
                        example: API_KEY_MISSING
                      message:
                        type: string
                        example: API key is missing
                      status:
                        type: number
                        example: 401
        '403':
          description: No active subscription found
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - status
                    properties:
                      code:
                        type: string
                        enum:
                          - NO_ACTIVE_SUBSCRIPTION
                        example: NO_ACTIVE_SUBSCRIPTION
                      message:
                        type: string
                        example: No active subscription found
                      status:
                        type: number
                        example: 403
      security:
        - X-Api-Key: []
components:
  schemas:
    StatusResponseDto:
      type: object
      properties:
        plan:
          type: string
          example: Business
          description: Subscription plan name
        rateLimitPerMinute:
          type: number
          example: 200
          description: User's current rate limit, requests per minute
        credits:
          description: Monthly and daily credit usage for the user
          allOf:
            - $ref: '#/components/schemas/CreditsDto'
        currentPeriodStart:
          type: string
          example: '2026-05-11T07:38:09.723Z'
          description: Start of the current credit period, inclusive. ISO 8601
        currentPeriodEnd:
          type: string
          example: '2026-06-11T07:38:09.723Z'
          description: End of the current credit period. ISO 8601
        endpoints:
          example:
            - /v3/currencies/list
            - /v3/currencies/map
            - /v3/currencies/{id}
            - /v3/global/market
          description: API endpoints available on the current plan, as path templates
          type: array
          items:
            type: string
      required:
        - plan
        - rateLimitPerMinute
        - credits
        - currentPeriodStart
        - currentPeriodEnd
        - endpoints
    CreditsDto:
      type: object
      properties:
        dailyLimit:
          type: number
          example: 250000
          description: Daily credit limit
        dailyUsed:
          type: number
          example: 1200
          description: Credits used today
        dailyRemaining:
          type: number
          example: 248800
          description: Credits remaining today
        monthlyLimit:
          type: number
          example: 5000000
          description: Monthly credit limit
        monthlyUsed:
          type: number
          example: 4200
          description: Credits used in the current credit period
        monthlyRemaining:
          type: number
          example: 4995800
          description: Credits remaining in the current credit period
      required:
        - dailyLimit
        - dailyUsed
        - dailyRemaining
        - monthlyLimit
        - monthlyUsed
        - monthlyRemaining
  securitySchemes:
    X-Api-Key:
      name: X-Api-Key
      type: apiKey
      in: header

````