StatusSupportGet API keyDashboard
AccountRequest rate against the runaway-protection ceiling

Account

Request rate against the runaway-protection ceiling

Use with AI

GET /v1/usage/rate

How close the account runs to its runaway-protection ceiling (max_rps in GET /v1/account): per time bucket, the requests the ceiling counted, the busiest second (peak_rps), the average rate and the requests refused with rate_limited. The ceiling is a safety limit that stops a runaway client, not a plan limit: plans have no rate limit. Account-wide (every key and the dashboard). Buckets are listed oldest first, cursor-paged. Data is complete to within about 5 minutes. Free.

Auth: an API key with the account:read scope, or the dashboard session.

Example

cURL
curl 'https://socialtap.dev/v1/usage/rate' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

Authorizations

x-api-keystringheaderrequired

Your API key, with the account:read scope. Authentication

Query parameters

sincestringmax 40 chars

Start, inclusive: RFC 3339 or a date (UTC), rounded down to the bucket. Default: one full page of buckets before until.

untilstringmax 40 chars

End, exclusive: RFC 3339 or a date (UTC). Default: now.

bucket_widthstring

Bucket size. Default 10m. At most 144 ten-minute, 168 hourly or 31 daily buckets per page.

One of10m1h1d

limitintegermin 1max 168

Buckets per page (default and maximum: 144 ten-minute, 168 hourly or 31 daily).

cursorstringmax 200 chars

page.next_cursor of the previous page.

Response

application/json

200

Request rate against the runaway-protection ceiling

dataobject[]

This page's items.

ShowHide 7 child fields
average_rpsnumber

requests divided by the bucket's length in seconds (for the bucket now under way, by its seconds so far), to three significant figures.

ending_atstring date-time

Bucket end, exclusive.

peak_rpsinteger

The most requests counted in any one second of the bucket (a UTC clock second), refused ones included; 0 without requests. Compare it with max_rps (GET /v1/account).

rate_limitedinteger

Of requests, those refused with rate_limited (free) because the account was above its ceiling.

recordedboolean

false for a bucket that ends before the account's request rate was first recorded (its first request since the rate has been measured): no data, rather than no requests.

requestsinteger

Requests the ceiling counted, refused ones included: endpoint requests (Prefer: respond-async ones too) and the gateway's own routes, from every key and the dashboard. Not counted: a job's items (the job paces them).

starting_atstring date-time

Bucket start, inclusive (RFC 3339 UTC).

metaobject

The shared route meta (see the API reference introduction).

pageobject
ShowHide 4 child fields
end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

400

400 Bad Request.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

invalid_cursorNo retry

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

403

403 Forbidden.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

429

429 Too Many Requests.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

operationId usage.rate.list