API documentation
A list of all publicly available methods for interacting with the API.
- Main
- ### Calculate order Calculate given order and return the result, this is used in plan selector to show the price of the order. (1 methods)
- ### Pre-Purchase order Convert your order to buy request, then send __order_id__,__total_price__ to [v2/cart/purchaser](/apidocs/cart/purchase). (1 methods)
- Get proxies in given package. (1 methods)
- Get all user info, for example: name, email, currency, balance, phone, social links, features. (1 methods)
- Checker (4 methods)
- IP information Get IP information, such as country, city, timezone, etc. Checker(2 methods)
- Get ip current Get my IP address Checker(2 methods)
- Proxy
- Blacklist ### Check website before order Check website in blacklist before order, some types of blacklist can be enabled or disabled. For example we allow pay sites on mobile proxies. Checker
- Conversation (6 methods)
- Get available city in residential country or regions (1 methods)
- Get available regions in residential country (1 methods)
- Get proxy bfrom list by index. (1 methods)
- Retrieve user actual balance. (1 methods)
- Get active packages list (1 methods)
- Retrieve user balance history. (1 methods)
- ### OAuth start request This request is giving url for oauth authorization, then it will redirect to redirect url with oauth-uid and oauth-signature #### Target Auth URL This is url where user complete oauth authorization (our endpoint). #### Where get API Application? You need contact us in [support](/support) and we will give you API Application (1 methods)
- Return information oauth provider and API application (1 methods)
- Return list of allowed targets (which can be used in oauth). (1 methods)
- Get active user sessions. (1 methods)
- Obtain a list of the user's API tokens. (1 methods)
- Create a new API token for the user. (1 methods)
- Get info about specified user's API token. (1 methods)
- Delete specified user's API token. (1 methods)
- Get user balance subscriptions (1 methods)
- List referral tokens (1 methods)
- Referral (3 methods)
- Delete referral token (1 methods)
- User (3 methods)
- View referral token (1 methods)
- List registered users (1 methods)
- List visits by token (1 methods)
- Get user who referred current user. (1 methods)
- Get session by id. (1 methods)
- Get order / prices information by package. (1 methods)
- Get balance history entry. (1 methods)
- Unsubscribe from balance subscription. (1 methods)
- Toggle subscription renew (Only for saved)) (1 methods)
- Cancel non active package (without proxies), also money receives back) (1 methods)
- Delete (1 methods)
- Retrieve download hash for package, for download package proxies. (1 methods)
- Reset download hash for package, old hash will not be valid anymore. (1 methods)
- Download proxies in specific format, with specific connection type (1 methods)
- Get package features (1 methods)
- Package (1 methods)
- Hide selected proxy from list (but it will work, only visual)) (1 methods)
- You can read note for proxy. (1 methods)
- Add personal note for proxy in package. (1 methods)
- ### How to change? You can manage your order here, like change count, traffic, period, countries, etc. You need __money__ to change order, (1 methods)
- ### How to? Replace ips in package, if you want to add new ips, you need to add them to the `add_countries` array, if you want to remove ips, you need to add them to the `remove_ids` array. You need __money__ to replace ips, if you have __free replacements__ you can use them. (1 methods)
- This is renew package for next period. You need __money__ to renew package. (1 methods)
- Change or add traffic to order. You need __money__ to change traffic. (1 methods)
- Rotate proxy, residential, mobile - change ip. (1 methods)
- Add custom user proxy, like for residential constructor. (1 methods)
- Remove user proxy (only created by user). (1 methods)
- Replace proxies by given sequence. (1 methods)
- Return package settings, like name, description, etc. (1 methods)
- Change selected settings for given package. (1 methods)
- Get available connection servers (Some servers can give better speed). (1 methods)
- Change the connection bridge to other. (1 methods)
- Same as list but fetch only one. (1 methods)
- Logout from session, if id is not provided, logout from current session. (1 methods)
- Get and read all user notifications. (1 methods)
- Phone status (1 methods)
- Retrieve all user settings, for example: name, email, currency. (1 methods)
- Update user settings, for example: name, email, currency. Some settings need confirmation, for example: email. (1 methods)
- Available countries (1 methods)
- Cart (1 methods)
- Get all config for calculator, like: rules for counts, traffic, paid period, etc. This is used in plan selector to show the rules for the order. (1 methods)
- ### Purchase order This method is used to purchase the order, you need to send the _order_id_, _overall_ *(Is total_price, based on user currency)* from [v2/cart/order](/apidocs/cart/order) to this endpoint to purchase the order. (1 methods)
- ### Sale percentage #### What is the sale percentage? Sale percentage is a discount that is applied to the price of the order. The sale percentage is calculated based on the user's activity on the site, or referrals. The more active the user is, the higher the discount. #### Referral program It uses __sp-referral__ header as a referral code, more you can find on [wiki welcome page](/apidocs). #### How to apply the sale percentage? This is already calculated in the price of the orders, you don't need to do anything, just purchase the order. (1 methods)
- Get current activated abilities for api token. (1 methods)
- Check if token has ability to do something. (1 methods)
- Make payment request, then redirect to payment page. (1 methods)
- Get allowed and enabled payment methods (some countries may have restrictions). (1 methods)
- Calculates your amount after applying active promocodes / bonuses. (1 methods)
- Statistics (1 methods)
- Phone (1 methods)
- Avatar (1 methods)
- Other linked accounts (2 methods)
- Get available for activation promocodes. (1 methods)
- Get active promocodes for user. (1 methods)
- Get user features (1 methods)
- Toggle features (1 methods)
- Bonuses (1 methods)
What methods are supported?
90% of the site's functionality is available for the public API; the other part is not available because it may be tied to the frontend or blocked for security reasons.
HTTP Headers
X-CSRF-Token
CSRF token, required only if used as a frontend.
Locale
Answer language, currently supported: en, ru, uk, pl
Authorization
Authorization, the token must be preceded by: API-Token
SP-Referral
Referral code required for discount (if no user has been created).
sp-site
The site from which the token is used (used for internal analytics; you can specify the name of your project).
sp-comefrom
Label where the user came from (eg Google Search)
Respond
1{
2 "data": { // The data returned by the method
3 "user": ....
4 },
5 "good": true, // Request success (sometimes 200 may return false)
6 "timestamp": 1731493828, // Request start time (when the server started processing data)
7 "cause": { // Who executed this method + token signature (you can check the user
8 "type": "api",
9 "user_id": 1,
10 "token_id": 75,
11 "token_sign": "63992323944b77852d3b2b901498fc57"
12 }
13}
14 
