Current-period usage for the calling key

GET

/v1/usage

const url = 'https://api.aptrouter.com/v1/usage';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aptrouter.com/v1/usage \
  --header 'Authorization: Bearer <token>'

Returns this key’s current-period request/credit counts plus the remaining prepaid balance. Not metered (free to call).

Authorizations

bearerAuth

Responses

200

Usage for the current billing period.

application/json

object

period

required

Current period (YYYY-MM) the request/credit counters cover.

string

requests

required

Requests served this period.

integer

credits

required

Credits consumed this period.

integer

balance

required

Remaining prepaid credit balance (1 credit = 1 search).

integer

Examples

{
  "period": "2026-06",
  "requests": 4213,
  "credits": 4213,
  "balance": 5787
}

401

Missing, invalid, or revoked API key.

text/plain

string

Example

invalid or revoked api key