Status Endpoint

The status endpoint returns information about your current quota.

Requests to this endpoint do not count against your quota or rate limit.

GET/v1/status

Check API Status

This status endpoint returns information about your current quota.

Response Properties

Name
account_id
Type
integer
Description
The ID of the account the API key belongs to.
Name
quotas
Type
object
Description
Contains information about your request quota, split into a month and a grace bucket.
Name
quotas.month
Type
object
Description
Your regular monthly request quota. Resets at the start of each billing month.
Name
quotas.grace
Type
object
Description
A temporary grace quota that keeps your integration running while a subscription payment is still being processed. All values are 0 unless a grace allowance is currently active.

Each quota bucket contains the same three fields:

Name
total
Type
integer
Description
The total number of requests included in this bucket.
Name
used
Type
integer
Description
The number of requests you have already used in this bucket.
Name
remaining
Type
integer
Description
The number of requests left in this bucket (total - used).

Request

GET

/v1/status

curl -G https://api.screenshotbase.com/v1/status \
    -H "apikey: YOUR-API-KEY"

Response

{
    "account_id": 313373133731337,
    "quotas": {
        "month": {
            "total": 300,
            "used": 72,
            "remaining": 228
        },
        "grace": {
            "total": 0,
            "used": 0,
            "remaining": 0
        }
    }
}