Usage Endpoint

Api will return usage information for your account.

Endpoint

GET /usage

Request Object

Parameters

apiKey string REQUIRED
Your unique API key. Note This may also be passed via x-api-key header.

success boolean
true if the request was successful, false if there was an error.

error string
error message if the request was unsuccessful.

plan string
Your current plan.

quota integer
Your current quota.

used integer
Your usage since start of month.

Response JSON

{
  "success": true,
  "plan": "lite",
  "quota": 2000,
  "used": 0
}