Gateproxies developer platform

API v1

Build purchasing, account, package, and proxy workflows against one stable Gateproxies contract. Every catalog and charge uses the current Gateproxies selling price, and every response contains only Gateproxies product identifiers.

Stable · v1

Base URL

https://gateproxies.com/api/v1

Authentication

Create an API key in Account Center → API Keys. Send it from your backend using X-API-Key. Never embed keys in public JavaScript or mobile bundles.

curl https://gateproxies.com/api/v1/account \
  -H "X-API-Key: $GATEPROXIES_API_KEY"

Unified response structure

Success and error bodies use predictable JSON envelopes. HTTP status codes remain authoritative.

{
  "success": true,
  "data": { }
}

{
  "success": false,
  "error": "A safe, actionable message"
}

Product catalog

GET/catalogLive Gateproxies plans

Returns available product families, customer prices, and Gateproxies plan identifiers.

curl https://gateproxies.com/api/v1/catalog -H "X-API-Key: $GATEPROXIES_API_KEY"

Purchase options

GET/products/{product}/optionsLive fields and locations

Returns the fields required to buy that product, including current country and period options where applicable.

curl https://gateproxies.com/api/v1/products/ipv4/options -H "X-API-Key: $GATEPROXIES_API_KEY"

Calculate price

POST/orders/calculateConfirm current selling price

Call immediately before purchase. For configurable IP products, send product, count, and period. For fixed plans, send product and plan_id.

Field	Type	Required	Description
product	string	Yes	Catalog product identifier
plan_id	string	Fixed plans	Gateproxies catalog plan ID
count	integer	Configurable IP	Number of proxy endpoints
period	integer	Configurable IP	Billing term in days

curl -X POST https://gateproxies.com/api/v1/orders/calculate \
  -H "X-API-Key: $GATEPROXIES_API_KEY" -H "Content-Type: application/json" \
  -d '{"product":"ipv4","count":10,"period":30}'

Buy package

POST/ordersCharge wallet and provision

Uses the same server-side validation and live Gateproxies price as Account Center. A failed provisioning request is refunded automatically; a successful order is private to the API-key owner. Every API purchase requires a unique Idempotency-Key; repeating the key returns the existing order and never buys twice.

Field	Required	Description
product	Yes	Product identifier
plan_id	Fixed plans	Plan ID returned by catalog. `tariff_id` is accepted as a compatibility alias.
country	IPv4 / IPv6	Country returned by checkout options
count / period	IPv4 / IPv6	Same values used for calculation
Additional option fields	When returned	Send required fields returned by `/products/{product}/options`, such as `location_id` for Unlimited Residential.

curl -X POST https://gateproxies.com/api/v1/orders \
  -H "X-API-Key: $GATEPROXIES_API_KEY" -H "Idempotency-Key: order-20260909-001" -H "Content-Type: application/json" \
  -d '{"product":"ipv6","country":"US","count":5,"period":30}'

Order history

GET/ordersPrivate order ledger

Returns Gateproxies order IDs, charged customer amounts, status, and timestamps for the authenticated account only.

Packages

GET/packagesOwned packages

Returns only packages owned by the key owner. Internal package references are removed.

curl https://gateproxies.com/api/v1/packages -H "X-API-Key: $GATEPROXIES_API_KEY"

GET/packages/{id}One owned package

Another customer’s ID returns 404 and never reveals whether that resource exists.

Proxy list

GET/proxiesSaved connection routes

Returns active endpoints saved to this account. Use this endpoint only from trusted backend systems because credentials are sensitive.

curl https://gateproxies.com/api/v1/proxies -H "X-API-Key: $GATEPROXIES_API_KEY"

Account

GET/accountIdentity and wallet

Returns the key owner’s email, display name, verification state, and Gateproxies wallet balance.

Callback notifications

Not enabled in API v1 yet

Gateproxies does not currently ask you to expose a callback URL and does not claim delivery guarantees that are not implemented. Poll /orders after purchase and then read /packages or /proxies. Signed webhooks with retries will be introduced as a separately versioned capability.

Order status	Meaning	Recommended action
pending	Payment reserved; provisioning in progress	Poll with backoff
completed	Provisioning confirmed	Read packages/proxies
failed	Provisioning failed	Wallet reservation is refunded

Rate limits and safety

API keys are limited to 240 requests per minute. Use exponential backoff for 429 and 5xx responses. Keep purchase requests serialized and store returned Gateproxies order IDs.

Error codes

Status	Meaning	Action
200 / 201	Completed	Read data
400	Invalid request fields	Correct the payload
401	Invalid or revoked API key	Replace the key
402	Insufficient wallet balance	Add funds
403	Resource is not owned by this account	Use an owned ID
404	Resource or plan not found	Refresh catalog
409	Plan changed or is unavailable	Recalculate and retry
429	Rate limit exceeded	Retry with backoff
502 / 503	Provisioning temporarily unavailable	Retry later; inspect order state first