v1

latestOpenAPI 3.1.0Commercial License2026-07-132434129.1 KB

Rate Limit Information API

Get rate limit information for authenticated user

Retrieves comprehensive rate limit information including current usage, limits, and renewal date.

Authentication:

Requires a valid API key passed as a query parameter (api_key)
Works with both active and expired API keys
This endpoint does not support anonymous/IP-based access

Response Includes:

Current subscription plan ID and name
IP API quota (limit, remaining, used, usage percentage)
Email API quota (limit, remaining, used, usage percentage)
Rate limit interval in seconds
Next renewal/reset date (ISO 8601 format)
Subscription status (active, past_due, cancelled, etc.)

Rate Limit Intervals:

Daily: 86400 seconds
Monthly: 2678400 seconds (~31 days)
Yearly: 31536000 seconds (~365 days)

Use Cases:

Display usage dashboard in client applications
Monitor quota consumption to prevent rate limit errors
Plan upgrades based on usage patterns
Billing and subscription management

Example Response:

{
  "plan_id": "550712",
  "plan_name": "Professional Monthly",
  "ip_api": {
    "limit": 100000,
    "remaining": 87532,
    "used": 12468,
    "usage_percent": 12.47
  },
  "email_api": {
    "limit": 10000,
    "remaining": 9850,
    "used": 150,
    "usage_percent": 1.50
  },
  "interval_seconds": 2678400,
  "next_renewal_date": "2025-11-26",
  "status": "active"
}

get/api/v1/ratelimit

Query parameters

api_keystring required

API key for authentication (required).

API Key Format: 32-character alphanumeric string Required: This parameter is mandatory for accessing rate limit information Note: Works with both active and expired API keys

Example: ?api_key=your_api_key_here

Response

Rate limit information retrieved successfully

plan_idstring required

Subscription plan ID or 'default' for free tier users

plan_namestring

Human-readable plan name (if available)

interval_secondsinteger required

Rate limit interval in seconds (time period for quota renewal)

next_renewal_datestring date

Next billing/renewal date when the quota will be reset (ISO 8601 date format)

statusstring nullable

Subscription status (active, past_due, cancelled, etc.)

Example response

{
  "plan_id": "550712",
  "plan_name": "Professional Monthly",
  "ip_api": {
    "limit": 100000,
    "remaining": 87532,
    "used": 12468,
    "usage_percent": 12.47
  },
  "email_api": {
    "limit": 100000,
    "remaining": 87532,
    "used": 12468,
    "usage_percent": 12.47
  },
  "interval_seconds": 2678400,
  "next_renewal_date": "2025-11-26",
  "status": "active"
}