Usage & credit balance

Last updated June 24, 2026

Read your month-to-date API usage and your current credit balance.

TEXT

GET /v1/usage

Requires a valid API key and an active membership. Unlike the search endpoints this one is not credit-gated — you can always read your balance, even when it is empty — and it does not consume credit.

Query parameters

None.

Response

JSON

{
  "period_start": "2026-06-01T00:00:00Z",
  "requests": 1284,
  "billable_units": 1310,
  "credits": {
    "balance_cents": 4250,
    "balance": 42.50,
    "currency": "USD",
    "included_cents": 0,
    "purchased_cents": 4250,
    "estimated_requests_remaining": 2125,
    "auto_reload_enabled": true
  }
}

Field	Type	Description
`period_start`	string (ISO 8601, UTC)	Start of the current calendar-month usage period.
`requests`	integer	API requests recorded so far this period.
`billable_units`	integer	Billable units consumed this period (a request can bill more than one unit when it fans out into multiple upstream fetches).
`credits.balance_cents`	integer	Total remaining balance, in minor currency units.
`credits.balance`	number	Total remaining balance, in major units.
`credits.currency`	string	ISO currency code (e.g. `USD`, `GBP`).
`credits.included_cents`	integer	Remaining balance from your membership's monthly allotment.
`credits.purchased_cents`	integer	Remaining balance from credits you purchased.
`credits.estimated_requests_remaining`	integer	Approximate number of further requests your balance covers.
`credits.auto_reload_enabled`	boolean	Whether auto-reload is on for your account.

Examples

cURL

curl "https://api.neuji.com/v1/usage" \
  -H "Authorization: Bearer $NEUJI_API_KEY"

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("NEUJI_API_KEY"));
var json = await http.GetStringAsync("https://api.neuji.com/v1/usage");
Console.WriteLine(json);

JavaScript

const res = await fetch("https://api.neuji.com/v1/usage", {
  headers: { Authorization: `Bearer ${process.env.NEUJI_API_KEY}` },
});
const usage = await res.json();
console.log(`Balance: ${usage.credits.balance} ${usage.credits.currency}`);

The same balance is returned on every billable response via the X-Credits-Balance and X-Credits-Requests-Remaining headers — see Errors.