System

Requests left and money on the account (free, not billed)

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.

get/sys/balance

Request

Base URL: https://api.hikerapi.com
URL: https://api.hikerapi.com/sys/balance
Auth: API key in header x-access-key

Response

Successful Response

requestsinteger required

How many requests are left on the account — not the number you have already made. Real time: every call is deducted the moment it arrives, and calls we do not bill (429, 5xx, service unavailable) are refunded to the counter right away.

rateinteger required

Rate limit of your account, requests per second.

currencystring required

Currency of amount.

amountnumber required

Money left on the account. Updated once per hour: usage is charged in whole hours, a few minutes after the hour closes, so between two charges this value does not move while you keep spending. Top-ups are applied within seconds. Reported as 0.0 once requests reaches 0.

Example response

{
  "requests": 129627,
  "rate": 11,
  "currency": "USD",
  "amount": 2592.5777
}

Changes

No recorded changes to this operation across all 1 revision of this API.