Skip to main content
GET
Get current usage

Authorizations

X-API-Key
string
header
required

Programmatic auth for the /v1/screenshots and /v1/usage endpoints. Create a key from the dashboard (POST /v1/keys); the plaintext value is shown once at creation.

Response

OK

plan
enum<string>
required
Available options:
free,
pro
used
integer
required

Screenshots consumed in the current monthly period.

limit
integer
required

Monthly quota for the account's plan (Free 100, Pro 5000).

resets_at
string<date-time>
required

When used resets to zero.