This page is the endpoint index. Authentication, the Origin requirement, response envelope and pagination conventions are in Authentication and conventions .
What the labels mean
Public — no access token requiredClient — requires Authorization: Bearer at_...Every request other than GET / HEAD / OPTIONS also requires a trusted Origin header Method Path Purpose Auth GET/healthzLiveness check Public GET/readyzMySQL / Redis readiness Public GET/api/v1/settings/publicPublic site configuration Public GET/api/v1/proxy/extractExtract proxies API key + whitelist GET/api/v1/client-ipThe caller's egress IP Client
Method Path Purpose Auth GET/api/v1/auth/registration-policyRegistration policy Public GET/api/v1/auth/challenge/configCAPTCHA configuration Public POST/api/v1/auth/challenge/ticketObtain a challenge ticket Public POST/api/v1/auth/register/codeSend a registration code Public POST/api/v1/auth/registerRegister and sign in Public POST/api/v1/auth/loginPassword sign-in Public POST/api/v1/auth/login/two-factorSecond factor Public POST/api/v1/auth/refreshExchange for a new access token Refresh cookie POST/api/v1/auth/logoutSign out the current session Client POST/api/v1/auth/logout-allSign out every session Client GET/api/v1/auth/meCurrent user Client POST/api/v1/auth/password/reset/codeSend a password reset code Public POST/api/v1/auth/password/resetReset the password Public POST/api/v1/auth/change-password/codeSend a change-password code Client POST/api/v1/auth/change-passwordChange password (revokes old sessions) Client GET/api/v1/auth/oauth/:provider/startBegin OAuth Public GET/api/v1/auth/oauth/:provider/callbackOAuth callback Public
Method Path Purpose GET/api/v1/auth/two-factorTOTP status POST/api/v1/auth/two-factor/setupCreate a TOTP secret POST/api/v1/auth/two-factor/confirmConfirm enrolment DELETE/api/v1/auth/two-factorDisable (requires a TOTP code)
Method Path Purpose GET/api/v1/proxy/accountsList (pageSize defaults to 10 ) POST/api/v1/proxy/accountsCreate PATCH/api/v1/proxy/accounts/:idUpdate (status, traffic cap, notes) DELETE/api/v1/proxy/accounts/:idSoft delete (status becomes deleted)
Details in Proxy sub-accounts .
Method Path Purpose GET/api/v1/proxy/ip-whitelistList POST/api/v1/proxy/ip-whitelistAdd (10 per account) DELETE/api/v1/proxy/ip-whitelist/:idDelete
Details in IP whitelist and passwordless ports .
Method Path Purpose GET/api/v1/proxy/usage/summaryBalance, lifetime purchases, this and last month's billed volume GET/api/v1/proxy/usage/dailyPer-day breakdown (1–90 days) GET/api/v1/proxy/usage/seriesUsage series, filterable by target domain GET/api/v1/proxy/usage/domainsDomains visited (up to 500)
Details in Usage statistics .
Use these to get the exact spelling of targeting values instead of guessing.
Method Path Purpose GET/api/v1/proxy/geography/catalogFull catalogue GET/api/v1/proxy/geography/countriesCountries GET/api/v1/proxy/geography/countries/:countryCode/statesStates in a country GET/api/v1/proxy/geography/states/:stateId/citiesCities in a state
Public versions (no sign-in required):
Method Path GET/api/v1/catalog/geography/countriesGET/api/v1/catalog/geography/countries/:countryCode/states
Method Path Purpose GET/api/v1/residential/catalogCatalogue POST/api/v1/residential/quoteQuote (valid 5 minutes ) POST/api/v1/residential/purchasesPlace an order GET/api/v1/residential/purchasesOrder list
Method Path Purpose GET/api/v1/static-residentialResources you hold GET/api/v1/static-residential/countriesCountries and inventory POST/api/v1/static-residential/ordersPlace an order
Method Path Purpose GET/api/v1/static-datacenterResources you hold GET/api/v1/static-datacenter/countriesCountries and inventory
Method Path Purpose GET/api/v1/unlimited-residential/catalogPlan catalogue GET/api/v1/unlimited-residential/ordersOrder list
Method Path Purpose GET/api/v1/walletBalance and recent ledger GET/api/v1/payments/methodsAvailable payment methods GET/api/v1/payments/channelsPayment channels POST/api/v1/payments/topupsCreate a top-up GET/api/v1/payments/topups/:idQuery a top-up POST/api/v1/payments/checkoutsCreate a checkout (30 minute expiry) GET/api/v1/payments/checkouts/:idQuery a checkout POST/api/v1/payments/checkouts/:id/retryRetry a checkout GET/api/v1/promotions/availableAvailable promotions GET/api/v1/transactionsTransaction history (paginated) GET/api/v1/transactions/metricsTop-up / spend / refund metrics
Method Path Purpose POST/api/v1/proxy/traffic-cdksGenerate GET/api/v1/proxy/traffic-cdksList GET/api/v1/proxy/traffic-cdks/metricsMetrics POST/api/v1/proxy/traffic-cdks/redeemRedeem (20/minute ) GET/api/v1/proxy/traffic-cdks/:id/secretReveal plaintext POST/api/v1/proxy/traffic-cdks/:id/cancelVoid
Details in Traffic CDKs .
Method Path Purpose GET/api/v1/notificationsIn-app notification list POST/api/v1/notifications/:id/readMark as read POST/api/v1/notifications/read-allMark all as read GET/api/v1/notification-channelsChannel list POST/api/v1/notification-channelsCreate a channel PATCH/api/v1/notification-channels/:idUpdate a channel DELETE/api/v1/notification-channels/:idDelete a channel GET/api/v1/traffic-alert-settingsTraffic alert settings PUT/api/v1/traffic-alert-settingsUpdate traffic alerts
Details in Notifications and webhooks .
Method Path Purpose GET/api/v1/affiliateAffiliate overview PUT/api/v1/affiliate/codeSet the referral code POST/api/v1/affiliate/convertMove commission into the wallet POST/api/v1/affiliate/withdrawalsRequest a withdrawal (USDT) GET/api/v1/affiliate/withdrawalsWithdrawal history GET/api/v1/affiliate/referrals/:codeValidate a referral code (public)
Method Path Purpose GET/api/v1/support/ticketsTicket list POST/api/v1/support/ticketsCreate (max 20 open) GET/api/v1/support/tickets/:idDetail POST/api/v1/support/tickets/:id/repliesReply POST/api/v1/support/tickets/:id/closeClose GET/api/v1/support/chat-identitySigned identity for live chat
Method Path Purpose GET/api/v1/telegram/bindingBinding status POST/api/v1/telegram/bind-codeObtain a binding code DELETE/api/v1/telegram/bindingUnbind
These are aggregate views for console pages, returning everything one page needs in a single call. Your own integrations are usually better served by the fine-grained endpoints above.
Method Path GET/api/v1/dashboard/headerGET/api/v1/dashboard/homeGET/api/v1/dashboard/generatorGET/api/v1/dashboard/rotatingGET/api/v1/dashboard/walletGET/api/v1/dashboard/checkout-contextGET/api/v1/dashboard/account-settings
The following are not client API and are listed here to avoid misuse:
/internal/gateway/v1/* — internal interface between the gateway data plane and control plane; requires a gateway token/api/v1/admin/* — administrative endpoints; requires an admin role/api/v1/payments/*/notify, /webhook — payment channel callbacks, verified by signature/api/v1/telegram/webhook/:secret — Telegram bot callback/metrics — Prometheus metrics; requires a gateway tokenopenapi.yaml is incomplete
The openapi.yaml in the repository is missing the Extract API, notifications, tickets and many other endpoints. Treat this page as authoritative.
The 401 / 403 responses here concern REST authentication or access checks. Proxy HTTP / CONNECT uses 407 for credentials, 400 for options, 402 for quota, 403 for account/policy, 429 for concurrency, 500 for internal errors, 502 for connection failure, 503 for unavailable service and 504 for connection timeout. Read X-NextProxy-Error for the cause. SOCKS5 uses its negotiation codes. See the error reference .
