Skip to main content

​
Endpoint

GET https://api.screenshotly.dev/v1/screenshots/usage

​
Headers

HeaderRequiredDescription
X-API-KeyYesYour API key

​
Response

​
200 OK

{
  "success": true,
  "data": {
    "subscription": {
      "status": "active",
      "plan": "STARTER"
    },
    "plan": {
      "id": "starter",
      "name": "Starter",
      "limits": {
        "monthly": {
          "screenshots": 5000,
          "storage": "5 GB"
        }
      }
    },
    "limit": 5000,
    "usage": 1234,
    "remaining": 3766,
    "percentUsed": 25
  }
}

​
Response fields

​
data.subscription
object
Your current subscription status and plan name.
​
data.plan
object
Details of your plan including limits and features.
​
data.limit
number
Total monthly screenshot allowance.
​
data.usage
number
Screenshots captured this month.
​
data.remaining
number
Remaining screenshots available this month.
​
data.percentUsed
number
Percentage of monthly limit used (0–100).

​
Example

curl https://api.screenshotly.dev/v1/screenshots/usage \
  -H "X-API-Key: $SCREENSHOTLY_API_KEY"