Get Usage

You can get your current plan usage with your ScreenshotOne API key:

GET https://api.screenshotone.com/usage?access_key=<YOUR ACCESS KEY>

{
    "total": 10000,
    "available": 950,
    "used": 9050,
    "concurrency": {
        "limit": 20,
        "remaining": 20,
        "reset": 1681646947775437264
    }
}

A bit of clarification:

• total is the total number of requests allowed in the current billing plan period;
• available is the number of available requests until the end of the current period;
• used is the number of successfully executed requests.
• concurrency.limit is the number of screenshot requests you can start during the current one-minute request bucket;
• concurrency.remaining is the number of requests you can still start before the bucket resets;
• concurrency.reset is the time when the bucket resets, in UNIX timestamp format in nanoseconds.

The concurrency values are request-bucket values, not active render counts. For example, if your plan allows 40 requests per minute and concurrency.remaining is 5, you can start 5 requests at once. After that, wait until concurrency.reset before starting more requests.

For bulk or queue-based workloads, use concurrency.remaining and concurrency.reset to decide how many queued requests to drain into the API.

Errors

If the access key is missing or invalid, the endpoint responds with HTTP 400 and the error in the body:

{
    "is_successful": false,
    "is_internal": false,
    "error_code": "access_key_invalid",
    "error_message": "\"access_key\" is invalid"
}

Checking usage is free, so you can use it to verify an access key.