latestSwagger 2.02026-08-12187723.0 MB

c4a12725cdb5

advanced

API usage

The API Usage endpoint provides detailed information on your current API usage statistics. It returns data such as the number of requests made, remaining requests, and the reset time for your usage limits. This endpoint is essential for monitoring and managing your API consumption to ensure you stay within your allocated limits.

get/api_usage

Query parameters

format'JSON' | 'CSV'

Output format

delimiterstring

Specify the delimiter used when downloading the CSV file

timezonestring

Timezone at which output datetime will be displayed. Supports:

<ul> <li>1. <code>UTC</code> for datetime at universal UTC standard</li> <li>2. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="blank">here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i>

Response

timestampstring required

Current timestamp in UTC timezone

current_usageinteger required

Number of requests made in last minute

plan_limitinteger required

Your personal API limit (requests/minute) depending on the plan

daily_usageinteger

Number of requests made in the current day. Returned only when the plan has a daily limit.

plan_daily_limitinteger

Your personal API limit (requests/day) depending on the plan. Returned only when the plan has a daily limit.

plan_categorystring

Plan category name

Example response

{
  "timestamp": "2025-05-07 11:10:12",
  "current_usage": 4003,
  "plan_limit": 20000,
  "daily_usage": 12500,
  "plan_daily_limit": 100000,
  "plan_category": "enterprise"
}