Static Product API
Products: Static ISP (
product=static-isp) and Dedicated Datacenter (product=static-dc). Base URL:https://api.ipxss.comAll endpoints arePOST. The body may beapplication/jsonorapplication/x-www-form-urlencoded. Envelope:{ "code": 0, "data": {...}, "msg": "success", "timestamp": 1747036799 }. Non-zerocodeis an error.
Both products share /v1/static_house/*. Omit product and the API defaults to static-isp.
1. Endpoints
| Capability | Path | Static ISP | Dedicated DC |
|---|---|---|---|
| Access token | POST /v1/oauth2/token | ✅ | ✅ |
| Regions and stock | POST /v1/static_house/region | ✅ | ✅ |
| Allocated IP list | POST /v1/static_house/list | ✅ | ✅ |
| Export CSV | POST /v1/static_house/export | ✅ | ✅ |
| Open / purchase | POST /v1/static_house/open | ✅ | ✅ |
| Renew | POST /v1/static_house/renew | ✅ | ✅ |
| Auto-renew (preferred) | POST /v1/static_house/auto_renew | ✅ | ✅ |
| Auto-renew (legacy) | POST /v1/static_house/renew_setting | ✅ | ✅ |
| Fulfillment webhook | POST /v1/static_house/webhook | ✅ | ✅ |
| Wallet balance | POST /v1/wallet/balance | ✅ | ✅ |
| Wallet ledger | POST /v1/wallet/usage_record | ✅ | ✅ |
Static ISP only allows
ip_type=normal(premiumis rejected). Dedicated DC has no tier. Duration isweek(~7 days) ormonth(~30 days). Public responses contain platform relay credentials only—never vendor names or upstream secrets.
Auth and wallet conventions: Authentication and Wallet, whitelist, and queries.
2. Integration steps
2.1 Credentials
- In the IPxSS console, open Settings → API keys and create an API Key.
- Keep
email + API Keyon your server only. The key is a password.
2.2 Exchange an access token
POST /v1/oauth2/token
Authorization: Basic base64(email:api_key)
Content-Type: application/x-www-form-urlencodedTTL is 7 days. Call business APIs with Authorization: Bearer <access_token>. Cache the token and refresh about one day before expiry.
3. Shared fields
| Field | Values | Notes |
|---|---|---|
product | static-isp / static-dc | Defaults to static-isp; new clients should send it explicitly |
ip_type | normal | Required for static-isp; premium is rejected. Optional for static-dc |
duration / package_type | week / month | About 7 or 30 days |
region | us:2|hk:1 or MIXISP-7973:50 | | between countries; : between code and qty; sum must equal num |
num | integer | Total IPs in this order |
page / limit | pagination | Default 1 / 10; list max 100, export max 10000 |
Region codes are ISO Alpha-2 (US, GB, HK). There is no city inventory. Mix packages use MIXISP-<id> or MIXIPV4-<id> with quantities 20 / 50 / 100 / 200 only—one package per order.
isp_type(isp-resi/isp-resi-hq) is deprecated. Useip_type.
4. Endpoints in detail
4.1 Regions
POST /v1/static_house/region
Authorization: Bearer <token>| Field | Required | Notes |
|---|---|---|
product | no | Default static-isp |
ip_type | when product is static-isp | normal only |
stock is 1 when the country is orderable—not remaining inventory. stock_as_of is 0 when there is no snapshot.
4.2 Open
POST /v1/static_house/open
Authorization: Bearer <token>| Field | Required | Notes |
|---|---|---|
product | no | Default static-isp |
ip_type | for static-isp | normal |
duration | yes | week / month |
num | yes | Must match the region total |
region | yes | e.g. hk:1|us:2 or MIXISP-7973:50 |
notify_url | no | HTTPS; delivered only after a webhook secret is registered |
New orders may fulfill asynchronously: awaiting_fulfillment=true and allocation status=0 (pending). Poll list until status=1 and exit_ip is present, or wait for static.ready. Relay ports: ISP 10000/10001, DC 6666/6667. Usernames are ng_static_*.
4.3 List
POST /v1/static_house/list
Authorization: Bearer <token>Results are scoped to the current API account.
| Field | Notes |
|---|---|
status | 0 pending, 1 in use, 2 expired, 3 released |
http / socks5 | Platform relay host, port, account, password |
exit_ip | Confirmed public IPv4; omitted while pending |
4.4 Export
POST /v1/static_house/export
Authorization: Bearer <token>Returns text/csv named static-isp-export.csv or static-dc-export.csv. Columns align with list.
4.5 Renew
POST /v1/static_house/renew
Authorization: Bearer <token>| Field | Required | Notes |
|---|---|---|
duration | yes | week / month |
renew_ip_list | yes | Comma-separated exit IPs, not allocation ids |
4.6 Auto-renew
Preferred: POST /v1/static_house/auto_renew with ids + enabled (true/false) and optional package_type.
Legacy: POST /v1/static_house/renew_setting with type=static_house, ids, package_type, status (1 on / -1 off).
4.7 Fulfillment webhook
POST /v1/static_house/webhook
Authorization: Bearer <token>| Header | Meaning |
|---|---|
X-IPxSS-Event | static.allocated or static.ready |
X-IPxSS-Signature | sha256=<hex> HMAC-SHA256 of the raw body |
5. Error codes
| code | Meaning | HTTP |
|---|---|---|
0 | Success | 200 |
40001 | Invalid parameters | 400 |
40002 | Business validation (balance, stock, ownership) | 400 |
40101 / 40102 / 40103 | Auth | 401 |
50001 | Internal error | 500 |
50201 | Upstream fulfillment failed | 502 |
Rate limit: HTTP 429, default 60 req/min per API key.
6. Limits
stock=1means orderable, not a remaining count.opensuccess does not mean the proxy is live yet—wait forstatus=1andexit_ip.- No public refund API; the vendor cannot take IPs back.
- Failed
40002/50201opens do not debit the wallet. - Responses never include upstream vendor credentials.