Chapter 2 · API and integration
API keys and authentication
Creating an API key, restricting it by IP, sending the key and the main error codes.
The API lets your shop or bot place orders automatically. The full documentation is under API docs in the panel and at https://partner.goxost.net/docs.
Create a key
- Open API keys in the panel.
- Give the key a name (for example, a server or project name).
- Optionally list your server addresses under Allowed IPs — one IP or CIDR per line (for example
203.0.113.10or203.0.113.0/24). Leave it empty to allow any IP. - Press Create key.
- The full key (
gxp_…) is shown only once. Copy it and store it safely in your server settings.
We store only a hash of the key — a lost key cannot be recovered; create a new one.
Key rules
- You can have at most 10 active keys at a time.
- You can create a key right away, but the API works only after your account is approved.
- Keep the key on your server only — never in a browser page, a mobile app or a public repository.
- If a key leaks, press Revoke — requests made with it stop working immediately. Then create a new one.
- We recommend an IP list for every production key.
Sending the key
Base URL: https://partner.goxost.net/api/v1. All requests must use HTTPS. Send the key in one of these headers:
Authorization: Bearer gxp_XXXXXXXX
X-Api-Key: gxp_XXXXXXXX
Check the connection:
curl https://partner.goxost.net/api/v1/balance \
-H "Authorization: Bearer $PARTNER_API_KEY"
Main endpoints
| Request | Purpose |
|---|---|
GET /balance |
Balance and current plan |
GET /offers |
Offer catalogue |
GET /offers/{id} |
A single offer |
POST /offers/{id}/check |
Pre-check a player |
POST /orders |
Place an order |
GET /orders/{transaction_id} |
Order status |
GET /orders |
List orders |
transaction_id is your own unique order number. If you resend the same request with the same transaction_id after a network error, you are never charged twice.
Authentication errors
| Code | HTTP | Reason |
|---|---|---|
UNAUTHENTICATED |
401 | Missing or invalid key |
IP_NOT_ALLOWED |
403 | The request came from an address not in the key's IP list |
ACCOUNT_NOT_ACTIVE |
403 | The account is not approved yet or is suspended |
RATE_LIMITED |
429 | Too many requests — wait Retry-After seconds |
Every response carries X-RateLimit-Limit and X-RateLimit-Remaining headers. The limit is shared by all keys of the account. The full list of error codes is in the "Errors and limits" chapter of the API docs.