GET
/
v1
/
usage
curl --request GET \
  --url https://api.screenshotmax.com/v1/usage
{
  "hits": {
    "quota": 123,
    "used": 123,
    "remaining": 123
  },
  "concurrency": {
    "limit": 123,
    "remaining": 123,
    "reset": 123
  }
}

It’s simple to use: you only need to submit your access_key. The API will return the usage statistics for your account.

Requests to this endpoint are not counted against your usage quota, but they are still subject to rate limiting. This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.

​
Getting started

​
REST

The Usage API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

​
HTTPS

The Usage API requires all communications to be secured TLS 1.2 or greater.

​
API Versions

All of ScreenshotMAX’s APIs are versioned. The Usage API is currently on Version 1.

​
Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs. To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests. For POST requests, you can include your access key in the request body as a JSON object. You can also use the X-Access-Key header to pass your access key. You can find your access key in your account dashboard.

​
Base URL

https://api.screenshotmax.com/v1/usage

​
Validation endpoint

ScreenshotMAX’s Usage API simply requires your unique access key. The API will return usage statistics for your account.

https://api.screenshotmax.com/v1/usage
? access_key=YOUR_ACCESS_KEY

This was a successful request, so the API returned a 200 OK response with the usage statistics for your account.

{
  "hits": {
    "quota": 1000,
    "used": 500,
    "remaining": 500
  },
  "concurrency": {
    "limit": 100,
    "remaining": 50,
    "reset": 1633036868
  }
}

​
Request parameters

​
access_key
string
required

Your unique access key. You can find your access key in your account dashboard.

​
Response parameters

The API response is returned in a universal and lightweight JSON format.

​
hits
object

Usage statistics for your account.

​
concurrency
object

Usage statistics for your account.

​
Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

CodeTypeDetails
200OKThe request was successful.
401UnauthorizedThe request was rejected due to an invalid access key.
500Internal server errorThe request failed due to an internal server error.