Skip to content

System Endpoints

Account balance and rate limit info.

Authentication & errors

All endpoints require x-access-key header. See Authentication. Error responses: Response Codes.

Endpoints: /sys/balance

GET /sys/balance

Balance of your account: how many requests are left and how much money is on it.

The two values refresh at different rates:

  • requests is real time — it goes down with every call you make.
  • amount is settled once per hour — spending is charged in whole hours, a few minutes after the hour ends. Between charges amount looks frozen even though you are spending. Top-ups are the exception: they appear within seconds.

So use requests for quota checks and low-balance alerts, and amount for accounting. Calling this endpoint is free — it does not consume a request.

curl -H "x-access-key: YOUR_TOKEN" \
  "https://api.hikerapi.com/sys/balance"

import requests

response = requests.get(
    "https://api.hikerapi.com/sys/balance",
    headers={"x-access-key": "YOUR_TOKEN"},
)
print(response.json())

const response = await fetch(
  "https://api.hikerapi.com/sys/balance",
  { headers: { "x-access-key": "YOUR_TOKEN" } }
);
const data = await response.json();
Example response 
{
  "requests": 1992006,
  "rate": 15,
  "currency": "USD",
  "amount": 916.3235
}

Ready to integrate? First 100 requests free — Get your API key →