Usage & Status Codes

Check your remaining quota with the Usage API, and understand the HTTP status codes the Hyper Solutions API returns.

Checking your usage

Use the Usage API to monitor your remaining quota and consumption:

Get usage statistics

get

Retrieves detailed usage statistics for all products and plans associated with the API key

Header parameters

x-api-keystringRequired

Your API key for authentication

Responses

200

OK Usage statistics successfully retrieved

application/json

balanceEuronumber · floatOptional

Current balance in Euros

Example: 240.97

401

Unauthorized - API key is missing or invalid

application/json

403

Forbidden - API key is disabled

application/json

{
  "balanceEuro": 240.97,
  "plans": [
    {
      "expiresAt": "2025-06-08T20:22:43Z",
      "requestsUsed": 1000000,
      "requestsQuota": 1000000,
      "requestsRemaining": 0,
      "product": "akamai",
      "numRequests": 1000000
    }
  ]
}

Status codes

These are the responses the Hyper Solutions API itself returns:

Status	Means	Fix
200	Payload generated successfully	Replay the returned payload and headers object on the target
401	Missing or invalid API key	Check the x-api-key header and your key at hypersolutions.co/keys. See Authentication

Compress your request bodies, some sensor payloads are large. The SDKs auto-compress bodies over 1000 bytes. See Compression.