Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "usage"
plan
enum<string>
required
Available options:
free,
basic,
growth,
professional
period
object
required

The UTC calendar month the API credits belong to; they reset at end.

credits
object
required
daily
object | null
required

The daily ceiling: 25% of the month on paid plans. null when the plan has none (Free can spend the month in one day).

rate_limit
object
required
fetch_caps
object
required

Today's (UTC) fetches of items Alura had not seen yet, per type, and the shop-name lookups (spec §6).

by_operation
object
required

API credits spent this month, by operation id (the keys of costs).

by_client
object
required

API credits spent this month, by client: claude, chatgpt, cursor, script, other; unknown for charges whose client was not recorded.

costs
object
required

The price of every operation, by operation id: credits per call, per non-empty page or per item returned.

upgrade_url
string
required