Public API

Getting Started

Base URL

https://api.gooproxy.com

All API requests are sent to this base address.

Authentication

apiKey + sign

Authenticate every request with your apiKey and sign.

Response

JSON

All endpoints return a JSON object with code, msg and data.

The examples below use placeholders. Replace YOUR_API_KEY and YOUR_SIGN with the credentials obtained from the Gooproxy dashboard.

Authentication

GET endpoints accept the credentials as query parameters:

GET — Query

https://api.gooproxy.com/api/account/info?apiKey=YOUR_API_KEY&sign=YOUR_SIGN

POST endpoints accept the credentials as request headers:

POST — Header

curl -X POST "https://api.gooproxy.com/api/proxy/buy-residential" \
  -H "apiKey: YOUR_API_KEY" \
  -H "sign: YOUR_SIGN"

You can get your apiKey and sign in the Gooproxy dashboard. Keep them confidential and never expose them in public code.

Response Format

Successful requests return code 200. On errors, code is a business error code and msg contains the reason.

{
  "code": 200,
  "msg": "ok",
  "data": {}
}

API Endpoints

GET/api/account/infoGet account info

GET/api/account/wallet-balanceGet wallet balance

GET/api/account/traffic-balanceGet traffic balance

GET/api/account/usage-statisticsTraffic usage statistics

POST/api/account/create-accountCreate account

GET/api/locations/countriesList countries

GET/api/locations/statesList states

GET/api/locations/citiesList cities

GET/api/locations/asnList ASN

GET/api/proxy/locationsISP locations

POST/api/proxy/buy-residentialBuy residential traffic

GET/api/proxy-users/user-listList proxy users

POST/api/proxy-users/create-userCreate proxy user

POST/api/proxy-users/update-userUpdate proxy user

POST/api/proxy-users/delete-userDelete proxy user

GET/api/proxy-users/usage-statisticsProxy user usage statistics

GET/api/proxy-users/usage-statistics-hourProxy user usage statistics (hourly)

GET/api/whitelisted-ips/ip-listList whitelisted IPs

POST/api/whitelisted-ips/add-ipAdd whitelisted IP

POST/api/whitelisted-ips/delete-ipDelete whitelisted IP

GET/api/proxy/proxy-listList ISP proxies

GET/api/proxy/expiration-timeGet ISP expiration time

POST/api/order/order-listList orders

POST/api/cdk/createCreate CDK

GET/api/cdk/listList CDK

POST/api/cdk/revokeRevoke CDK

Error Codes

Common business error codes returned by the API. A complete list is returned by each endpoint when an error occurs.

codemessage

200ok

10005Insufficient purchase quantity

10008Insufficient wallet balance

10010IP does not exist

10011Frequent operations, please try again later

10013sign error

10014apiKey error

10020username does not exist

10026The number of whitelists exceeds the limit

10027The IP format is abnormal

Getting Started

Authentication

Response Format

API Endpoints

Error Codes

Ready to start with Gooproxy?