Documentation menu

← Account

API reference

Retrieve usage

GET/v1/usage

Returns requests and credits used in the period, in total and by day, endpoint and API key.

Parameters

query

daysinteger
Number of days to include, ending now, between 1 and 365. Defaults to 30.

Responses

200
usage object
The usage summary.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.

Credits

Free.

Example request

curl -X GET 'https://api.placestack.com/v1/usage' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "object": "usage_summary",
  "organization_id": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
  "since": "2026-09-13T12:00:00Z",
  "until": "2026-09-13T12:00:00Z",
  "requests": 1,
  "credits_spent": 1,
  "free_requests": 1,
  "credit_balance": 1,
  "included_credits": 1,
  "daily": [
    {
      "day": "2026-09-13T12:00:00Z",
      "requests": 1,
      "credits": 1
    }
  ],
  "by_endpoint": [
    {
      "name": "/v1/parcel",
      "requests": 1,
      "credits": 1
    }
  ],
  "by_key": [
    {
      "name": "/v1/parcel",
      "requests": 1,
      "credits": 1
    }
  ]
}

Next steps

GET /credit

Retrieve credit balance

Continue