Sign in
GET/me

Your account, balance and limits

Everything an integration needs for its own status page: balance in credits and pounds, rate limits, licence version and today's usage. Usage is written a few seconds behind the calls it counts, so a request made moments ago may not appear yet; usage.asOf says what the figures are true as of. Free.

View as Markdown
All endpoints

Cost

Free

per request

Scope

any key

Same data as

—

the DepositScout website

Request

GET https://depositscout.com/api/developer/v1/me

No parameters.

Example

shell
curl "https://depositscout.com/api/developer/v1/me" \
  -H "Authorization: Bearer $DS_API_KEY"

Try it

Runs against this site. A ds_test_ key is free and returns sample data in the real shape; a live key returns real data and spends credits. The key is kept in this tab only.

No key yet? Create an account or sign in for a free test key.
GET /api/developer/v1/me
as curl
curl "/api/developer/v1/me" \
  -H "Authorization: Bearer ds_test_…"

Response

data is a single object. Every 2xx also sets X-DS-Request-Id, X-DS-Credits-Charged, X-DS-Credits-Balance, the X-RateLimit-* trio and an ETag.

response.json
{
  "data": {
    "…": "the item"
  },
  "meta": {
    "requestId": "req_7f3a9c2d1b4e5a6f7c8d",
    "generatedAt": "2026-09-21T09:00:00.000Z",
    "creditsCharged": 0,
    "creditsBalance": 199,
    "attribution": "Rates powered by DepositScout — depositscout.com"
  }
}

Errors follow the shared error contract. Back to all endpoints.