Skip to content
ScoutingAPI
Docs

Endpoint reference

Account

Check your plan, credit balance and rate limit — programmatically.

GET/v1/account

Check your plan, credit balance and rate limit — programmatically.

Credits0 credits
Cache TTLNone (real-time)
ReturnsAccount
ShapeSingle

Synchronous control-plane endpoint

This is a control-plane call: it always returns synchronously — never an async 202/jobId — and uses a bare { data } envelope with no metered meta block. It is free and works with both scout_test_ and scout_live_ keys.

Programmatic account introspection for the authenticated key: credit balance, plan (code / name / subscription status), key environment (live | sandbox) and the per-plan rate limit (requests per minute). Works for both live and sandbox keys, is read-only, synchronous and free — use it to check your balance from code instead of inferring it from meta.creditsCharged on each call.

Parameters

None — this endpoint takes no query parameters. Authenticate with your Bearer API key; the response describes the account that key belongs to.

Request & response

/v1/account
Request
GET /v1/account
Host: api.scoutingapi.com
Authorization: Bearer scout_live_…
Accept: application/json
Response
{
  "data": {
    "plan": { "code": "free", "name": "Free / Sandbox", "status": "active" },
    "key": { "env": "sandbox" },
    "credits": { "balance": 100 },
    "rateLimit": { "requestsPerMinute": 30 }
  }
}

Code samples

The same call in every language that matters — all returning the identical unified schema.

curl -sS "https://api.scoutingapi.com/v1/account" \
  -H "Authorization: Bearer $SCOUTINGAPI_KEY"

Try it

Run this endpoint against the deterministic sandbox right now — a real 200, zero credits, no sign-up. The credit cost of the equivalent live call is 0 credits.

Try itsandbox · 0 credits · no sign-up
GET/v1/account

Runs GET /v1/account with the shared demo sandbox key — a real 200, zero credits. It reports that demo account’s plan, balance and rate limit; paste your own key to see yours.

Response

Run the call to see a live, deterministic sandbox response.

Copy as curl
curl -sS "https://api.scoutingapi.com/v1/account" \
  -H "Authorization: Bearer $SCOUTINGAPI_KEY"

Notes & gotchas

Synchronous control-plane — never a 202

Unlike the data endpoints, /v1/account is control-plane: it always returns synchronously, never a 202/jobId, and its envelope is a bare { data } with no metered meta block. Errors follow the standard taxonomy — 401 authentication_error for a missing/invalid key, 429 rate_limited (with Retry-After) if you exceed your plan’s requests-per-minute.

balance is the ledger balance at auth time

credits.balance is the latest credit-ledger balance resolved when the key authenticates — a real-time read, not a cached figure. rateLimit.requestsPerMinute echoes your plan’s limit (Free 30, Starter 60, Pro 120, Scale 300; Enterprise is custom).