Usage

Check API key status and usage

Changed on

Returns your API key status and credit consumption for the current billing period. Takes no parameters beyond authentication.

On unlimited plans requests_remaining reports a fixed placeholder value and requests_made stays at 0. Use the free request_usage report to review historical consumption.

Credit cost: free. This endpoint does not deduct credits.

get/api/v0/stat

Request

Response

API key status and credit usage.

Example response

{
  "data": {
    "user_id": "YOUR_API_KEY",
    "key_status": "Valid",
    "requests_made": 112,
    "requests_remaining": 888,
    "addons": true
  },
  "meta": {
    "duration": 0.012,
    "endpoint": "/api/v0/vessel",
    "success": true,
    "next": "00e32b7a-4067-d6b2-8d73-2bdda4fe72bb"
  }
}

Changes

    • warning

      deleted the query request parameter api-key

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status