Proxy-seller

https://docs.proxy-seller.com
Admin
Comprehensive API documentation and usage guides for Proxy-seller's services, enabling programmatic...
Tokens:77,796
Snippets:368
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Fetch All Proxy Types (Example URL)

Source: https://docs.proxy-seller.com/proxy-seller/order-actions/complete-information

This example demonstrates the URL structure for retrieving a list of all available proxy types. No specific programming language is required as it's a direct HTTP GET request.

```HTTP
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/reference/list
```

--------------------------------

### Fetch Specific Proxy Type (IPv4 Example URL)

Source: https://docs.proxy-seller.com/proxy-seller/order-actions/complete-information

This example shows how to construct a URL to get details for a specific proxy type, such as IPv4. It's a direct HTTP GET request and doesn't depend on a programming language.

```HTTP
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/reference/list/ipv4
```

--------------------------------

### Get Proxy Package Information (JavaScript Example)

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/get-package-information

This snippet demonstrates how to make a GET request to the Proxy Seller API to retrieve package information. It requires your personal API key to be included in the URL. The response will detail your package's rotation, traffic limits, and usage.

```javascript
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/resident/package
```

--------------------------------

### Get ISP Codes API Request Example

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/api-tool/get-all-isp-codes

This example demonstrates how to make a GET request to the Proxy Seller API to retrieve a list of ISP codes. It requires your personal API key to be included in the URL.

```HTTP
GET https://proxy-seller.com/personal/api/v1/{YourApiKey}/resident/geo/isp
```

--------------------------------

### Example Request URL

Source: https://docs.proxy-seller.com/proxy-seller/order-actions/calculate-the-order

An example of a complete URL for calculating an order price, including a placeholder API key.

```URL
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/order/calc
```

--------------------------------

### Place Order Example URL

Source: https://docs.proxy-seller.com/proxy-seller/order-actions/place-an-order

This is an example of the URL used to place an order with the Proxy Seller API, including a placeholder for your API key.

```http
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/order/make
```

--------------------------------

### Example Request URL for Creating Subuser Package

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/create-subuser-package

This is an example of the URL used to make a POST request to create a subuser package. It includes a placeholder for the user's API key.

```http
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/residentsubuser/create
```

--------------------------------

### Create Special List Request Example

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/create-a-special-list-for-api-tool

This is an example of the URL used to create a special list for the API-TOOL. It requires your personal API key.

```HTTP
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/residentsubuser/list/tools
```

--------------------------------

### Get All Hosts Info (JSON Example)

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/host-actions/all-hosts-info

This snippet demonstrates the expected JSON format for a successful response when retrieving all host information from the Proxy-Seller API. It includes host IDs, names, and numbers.

```json
[
  {
    "id": "21vjv1224n45v7457mvcas",
    "name": "Host Number 1",
    "number": "101"
  }
]
```

--------------------------------

### GET /websites/proxy-seller

Source: https://docs.proxy-seller.com/proxy-seller/balance

Retrieves a list of available payment methods and proxy options. Includes examples for both successful responses and error scenarios like invalid API keys.

```APIDOC
## GET /websites/proxy-seller

### Description
Retrieves a list of available payment methods and proxy options. This endpoint provides details on supported payment gateways and currency types.

### Method
GET

### Endpoint
/websites/proxy-seller

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request, 'success' for a successful retrieval.
- **data** (object) - Contains the list of items.
    - **items** (array) - A list of available payment methods.
        - **id** (string) - The unique identifier for the payment method.
        - **name** (string) - The name of the payment method (e.g., "PayPal", "Visa / MasterCard").
- **errors** (array) - An empty array if the request was successful.

#### Response Example (Success)
```json
{
    "status": "success",
    "data": {
        "items": [
            {
                "id": "29",
                "name": "PayPal"
            },
            {
                "id": "30",
                "name": "Visa / MasterCard"
            }
        ]
    },
    "errors": []
}
```

#### Error Response (e.g., Invalid API Key)
- **status** (string) - Indicates the status of the request, 'error' if an error occurred.
- **data** (null) - Null if an error occurred.
- **errors** (array) - A list of error objects.
    - **message** (string) - A message describing the error (e.g., "Error api key", "IP not allowed").
    - **code** (integer) - An error code.
    - **customData** (null) - Placeholder for custom error data.

#### Response Example (Error)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        }
    ]
}
```

### Headers
- **Authorization** (string) - Required - Your personal API key: `<Your_API_Key>`
```

--------------------------------

### Example IP Replacement Request URL

Source: https://docs.proxy-seller.com/proxy-seller/actions-with-proxies/ip-replacement

This is an example of the POST request URL for initiating an IP replacement. It includes a placeholder for your personal API key. Ensure your API key is correctly inserted to authenticate the request.

```text
https://proxy-seller.com/personal/api/v1/{YourApiKey}/proxy/replace
```

--------------------------------

### Get Client Domains Response (200 OK)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/action-links

Example JSON response for a successful request to list client domains, showing domain details like ID, name, and configuration.

```json
[
  {
        "id": "63888a772bd6cd2bc8071515",
        "domain": "mobile.space",
        "useTls": true,
        "approved": true,
        "prioritized": false,
        "linkEnabled": true,
        "prefix": "/custom/"
  }
]
```

--------------------------------

### Get Specific Domain Response (200 OK)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/action-links

Example JSON response for a successful request to get a specific domain's details.

```json
{
   "id": "63888a772bd6cd2bc8071515",
   "domain": "mobile.space",
   "useTls": false,
   "approved": true,
   "prioritized": false,
   "linkEnabled": true,
   "prefix": "/custom/"
}
```

--------------------------------

### Example of a Direct Link for IP Check

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/modem-action-links/direct-links

This example shows a typical direct link format used to retrieve the IP address of a modem.

```plaintext
https://mobile.proxy-seller.com/c/modem/ip/103790e5f286b193bedd3aee67bff18afb746e
```

--------------------------------

### Export modem info example (modems.txt)

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/host-actions/export-modems-info

This snippet shows an example of the exported modem information in a .txt file. It includes the header row with field names and a data row with modem details.

```text
%number%,%ip%,%use%
101,101.111.44.191,false

```

--------------------------------

### API Response Examples for Special List Creation

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/create-a-special-list-for-api-tool

These JSON examples illustrate successful creation of a special list and various error scenarios, such as invalid API keys, IP restrictions, rate limits, or non-existent tariffs.

```JSON
{
  "status": "success",
  "data": {
    "id": 561,
    "login": "api3c8aa1d4",
    "password": "AZT62Dx3"
  },
  "errors": []
}
```

```JSON
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        },
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        },
        {
            "message": "Request limit reached",
            "code": 503,
            "customData": null
        }
    ]
}
```

```JSON
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        }
    ]
}
```

```JSON
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Tarif not found",
            "code": 0,
            "customData": null
        }
    ]
}
```

--------------------------------

### Retrieve All Proxies

Source: https://docs.proxy-seller.com/proxy-seller/actions-with-proxies/retrieve-active-proxy

This example shows how to make a GET request to retrieve all types of active proxies associated with your account. It requires your API key in the URL. The response will be a JSON object containing lists of proxies for each type.

```http
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/proxy/list
```

--------------------------------

### Get Modem Links Response (Error)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/action-links

Example error responses for failed requests to get modem links, indicating authorization or modem/domain issues.

```text
AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH
```

```text
INVALID_MODEM, DOMAIN_NOT_FOUND
```

--------------------------------

### Modem Authorization Response Examples (JSON)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/modem-authorization

Provides example JSON responses for successful (200) and error (400, 401, 404) scenarios when interacting with the modem authorization API.

```json
{
  "id": "62326bcaf3904578675f9ef7",
  "authType": "LOGIN",
  "login": "jAck",
  "password": "re456pas",
  "ip": ""
}
```

```json
{
  "modemAuth": {
    "id": "1237jj213cb7965413342665",
    "authType": "LOGIN",
    "login": "samuel",
    "password": "re129883pas",
    "ip": ""
  },
  "errors": {}
}
```

--------------------------------

### Get Modem Authorization by ID (JSON Example)

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/modem-authorization-users/authorization-info

This JSON object demonstrates a successful response from the Proxy-Seller API when retrieving modem authorization information by ID. It includes details like the authorization ID, type, login credentials, and IP address.

```json
[
  {
    "id": "62326bcaf3904578675f9ef7",
    "authType": "LOGIN",
    "login": "jAck",
    "password": "re456pas",
    "ip": ""
  }
]
```

--------------------------------

### Get All Hosts

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/host-actions/all-hosts-info

Retrieves a list of all hosts with their respective information. Requires an API key for authentication.

```APIDOC
## GET /api/hosts

### Description
Retrieves a list of all hosts with their respective information. Requires an API key for authentication.

### Method
GET

### Endpoint
/api/hosts

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your unique API key for authentication.

### Request Example
No request body is needed for this GET request.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the host.
- **name** (string) - The name of the host.
- **number** (string) - The host number.

#### Response Example
```json
[
  {
    "id": "21vjv1224n45v7457mvcas",
    "name": "Host Number 1",
    "number": "101"
  }
]
```
```

--------------------------------

### Rename List Request Example (URL)

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/rename-created-list

This is an example URL for the POST request to rename a list. It includes a placeholder for your personal API key.

```url
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/residentsubuser/list/rename
```

--------------------------------

### Example API Request for Deleting Subuser Package

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/delete-subusers-package

This example shows how to construct the URL for deleting a subuser's package by replacing '{YourApiKey}' with the actual API key.

```HTTP
DELETE https://proxy-seller.com/personal/api/v1/{YourApiKey}/residentsubuser/delete
```

--------------------------------

### Get Modems by Host ID (JSON Response Example)

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/host-actions/list-of-host-modems

This snippet demonstrates the expected JSON structure when successfully retrieving modem information for a given host ID. It includes details such as modem ID, IP address, usage status, proxy IP and port, and SIM card provider.

```json
[
  {
    "id": "63c234098746e15666325bf9f",
    "ip": "",
    "use": false,
    "status": "DOWN",
    "ipProxy": "101.111.44.191",
    "portHttp": "40303",
    "portSocks": "50303",
    "simProvider": "MTS UKR",
    "simNumber": null,
    "hostId": "21vjv1224n45v7457mvcas"
  }
]
```

--------------------------------

### API Response Examples

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/how-to-work-with-api-reference

Shows example JSON and plain text responses from the API based on different HTTP status codes, including success (200) and various error codes (400, 401, 404).

```json
{
    "id": "21vjv1224n45v7457mvcas",
    "name": "Host new name",
    "number": "101"
}
```

```text
AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH
```

```text
INVALID_HOST_ID,
```

```text
HOST_NOT_FOUND
```

--------------------------------

### Update Subpackage POST Request Example

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/update-package

This example shows the structure of a POST request to update a subpackage, including the base URL and API key.

```http
POST https://proxy-seller.com/personal/api/v1/{YourApiKey}/residentsubuser/update

{
    "is_link_date": true,
    "rotation": 60,
    "traffic_limit": "7516192768",
    "expired_at": "d.m.Y",
    "is_active": true,
    "package_key": "1234567890abcdefedcb"
}
```

--------------------------------

### Get Domain Information (JSON Example)

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/modem-action-links/domain-info

This snippet shows the expected JSON response format when successfully retrieving information about a custom domain via the Proxy Seller API. It includes details like domain ID, name, TLS usage, approval status, prioritization, link enablement, and prefix.

```json
{
    "id": "63888a772bd6cd2bc8071515",
    "domain": "mobile.space",
    "useTls": false,
    "approved": true,
    "prioritized": false,
    "linkEnabled": true,
    "prefix": "/custom/"
}
```

--------------------------------

### Proxy Seller API - Rename List Endpoint Example

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/rename-list

Example URL for the POST request to rename a list in the Proxy Seller API.

```HTTP
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/resident/list/rename
```

--------------------------------

### Download Proxies (HTTP GET Request)

Source: https://docs.proxy-seller.com/proxy-seller/actions-with-proxies/export-ips-in-txt-csv-custom

This snippet demonstrates how to make an HTTP GET request to the Proxy Seller API to download a list of proxies. It shows how to specify the API key, proxy type, and optional parameters like file extension and protocol.

```HTTP
GET https://proxy-seller.com/personal/api/v1/{YourApiKey}/proxy/download/{type}?ext=txt&proto=https
```

--------------------------------

### Modem Rotation Invalid Modem Response Example (404 Not Found)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/modems

Example of a 'not found' response when configuring modem rotation. This indicates that the specified modem ID does not exist.

```TEXT
INVALID_MODEM
```

--------------------------------

### Get Modem Links (API)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/action-links

Retrieves direct links for modem actions like rebooting, getting IP, and checking status. Requires modem ID and API token. Supports an optional domain ID.

```http
GET https://mobile.proxy-seller.com/api/v1/modems/{modemId}/links
```

--------------------------------

### Balance Inquiry Success Response (JSON)

Source: https://docs.proxy-seller.com/proxy-seller/balance

Example of a successful response when querying account balance, indicating the current balance sum.

```json
{
    "status": "success",
    "data": {
        "summ": 10
    },
    "errors": []
}
```

--------------------------------

### GET /api/v1/{YourApiKey}/balance/payments/list

Source: https://docs.proxy-seller.com/proxy-seller/balance

Retrieves a list of available payment systems for replenishing your balance.

```APIDOC
## GET /api/v1/{YourApiKey}/balance/payments/list

### Description
This request shows you available payment systems for replenishing your balance.

### Method
GET

### Endpoint
https://proxy-seller.com/api/v1/{YourApiKey}/balance/payments/list

### Parameters
#### Path Parameters
- **{YourApiKey}** (string) - Required - Your personal API key

### Request Example
```
https://proxy-seller.com/api/v1/{YourApiKey}/balance/payments/list
```

### Response
#### Success Response (200)
* The response will contain a list of available payment systems. The exact structure of the response data is not provided in the input text.

#### Response Example
* No specific success response example is provided in the input text.
```

--------------------------------

### Replenish Balance Success Response (JSON)

Source: https://docs.proxy-seller.com/proxy-seller/balance

Example of a successful response after attempting to replenish the balance, providing a payment URL.

```json
{
    "status": "success",
    "data": {
        "url": "https://proxy-seller.com/personal/pay/?ORDER_ID=595PAYMENT"
    },
    "errors": []
}
```

--------------------------------

### GET /personal/api/v1/{YourApiKey}/residentsubuser/packages

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/get-package-information

Retrieves package information for the authenticated user. It can return package details if available or an empty list if no packages are found. Error responses indicate issues with the API key or IP authorization.

```APIDOC
## GET /personal/api/v1/{YourApiKey}/residentsubuser/packages

### Description
Retrieves package information for the authenticated user. This endpoint returns details about the user's packages, including traffic usage, limits, and expiration dates. If the user has no packages, an empty data array is returned. Error responses will detail issues such as an invalid API key or unauthorized IP addresses.

### Method
GET

### Endpoint
`https://proxy-seller.com/personal/api/v1/{YourApiKey}/residentsubuser/packages`

### Parameters
#### Path Parameters
- **YourApiKey** (string) - Required - Your personal API key for authentication.

### Request Example
```
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/residentsubuser/package
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('success' or 'error').
- **data** (array) - An array of package objects, or an empty array if no packages are found. Each package object may contain:
  - **rotation** (string) - Rotation setting for the package.
  - **traffic_limit** (string) - Total traffic limit for the package.
  - **expired_at** (string) - Expiration date of the package (format: d.m.Y).
  - **is_link_date** (boolean) - Flag indicating if the expiration is linked to a date.
  - **is_active** (boolean) - Flag indicating if the package is active.
  - **package_key** (string) - Unique identifier for the package.
  - **traffic_usage** (string) - Current traffic usage.
  - **traffic_left** (string) - Remaining traffic.
  - **traffic_usage_sub** (string) - Traffic usage for subusers.
  - **traffic_limit_sub** (string) - Traffic limit for subusers.
  - **traffic_left_sub** (string) - Remaining traffic for subusers.
- **errors** (array) - An array of error objects, empty if the request was successful.
  - **message** (string) - Description of the error.
  - **code** (integer) - Error code.
  - **customData** (any) - Additional custom data related to the error.

#### Response Example (Success with packages)
```json
{
  "status": "success",
  "data": [
      {
        "rotation": "60",
        "traffic_limit": "7516192768",
        "expired_at": "d.m.Y",
        "is_link_date": true,
        "is_active": true,
        "package_key": "1234567890abcdefedcb",
        "traffic_usage": "10",
        "traffic_left": "10",
        "traffic_usage_sub": "10",
        "traffic_limit_sub": "10",
        "traffic_left_sub": "10"
      }
  ],
  "errors": []
}
```

#### Response Example (Success without packages)
```json
{
    "status": "success",
    "data": [],
    "errors": []
}
```

#### Response Example (Error - Wrong API key)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        },
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        },
        {
            "message": "Request limit reached",
            "code": 503,
            "customData": null
        }
    ]
}
```

#### Response Example (Error - Wrong authorization IP)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        }
    ]
}
```
```

--------------------------------

### Get all locations API endpoint example

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/get-all-locations

This snippet shows the structure of the GET request to retrieve all geographical locations from the Proxy Seller API. It includes the base URL and a placeholder for the API key.

```HTTP
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/resident/geo
```

--------------------------------

### Get Specific Domain Response (Error)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/action-links

Example error responses for failed requests to get specific domain details, indicating authorization or domain not found errors.

```text
AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED
```

```text
DOMAIN_NOT_FOUND
```

--------------------------------

### Example Successful Modem Authorization Creation (JSON)

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/modem-authorization-users/create-authorization

Illustrates a successful API response for creating a modem authorization, showing the generated authorization ID, type, login credentials, and an empty errors object.

```json
{
  "modemAuth": {
    "id": "1237jj213cb7965413342665",
    "authType": "LOGIN",
    "login": "samuel",
    "password": "re129883pas",
    "ip": ""
  },
  "errors": {}
}
```

--------------------------------

### Get IP List - Success Response Example

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/get-existing-ip-list

This JSON object represents a successful response from the Proxy Seller API when retrieving a list of IP addresses. It includes the status, data with IP item details, and an empty errors array.

```json
{
  "status": "success",
  "data": {
    "items": [
      {
        "id": 561,
        "title": "US Washington Garfield FIRST-STEP",
        "login": "3c8aa1d4",
        "password": "AZT62Dx3",
        "whitelist": "127.0.0.1,192.168.0.1",
        "rotation": "-1 = rotation, 0 = rotation per request, 1-3600 time in seconds",
        "geo": {
          "country": "US",
          "region": "Washington",
          "city": "Garfield",
          "isp": "FIRST-STEP"
        },
        "export": {
          "ports": 10000,
          "ext": "txt"
        }
      }
    ]
  },
  "errors": []
}
```

--------------------------------

### Example API Response for Creating a Domain

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/modem-action-links/create-domain

This JSON object represents a successful response when creating a custom domain. It includes details such as the domain ID, the domain name, TLS usage, approval status, link enablement, and any associated prefix. This is the expected output after making a successful API call to create a domain.

```json
{
    "id": "6683a91b19erd56a69f71697",
    "domain": "some.com",
    "useTls": false,
    "approved": false,
    "prioritized": false,
    "linkEnabled": true,
    "prefix": "/some/prefix/"
}
```

--------------------------------

### Get Client Domains Response (401 Error)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/action-links

Example error response for a failed request to list client domains due to authorization issues.

```text
AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED
```

--------------------------------

### Successful Subuser Package Creation Response

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/create-subuser-package

A sample JSON response indicating successful creation of a subuser package. It includes details like traffic limits, expiration, and package key.

```json
{
  "status": "success",
  "data": {
    "rotation": 60,
    "traffic_limit": "7516192768",
    "expired_at": "d.m.Y",
    "is_link_date": true,
    "is_active": true,
    "package_key": "1234567890abcdefedcb",
    "traffic_usage": "10",
    "traffic_left": "10",
    "traffic_usage_sub": "10",
    "traffic_limit_sub": "10",
    "traffic_left_sub": "10"
  },
  "errors": []
}
```

--------------------------------

### Actions with Proxies API

Source: https://docs.proxy-seller.com/proxy-seller

Learn what actions you can perform with the proxy servers that are active in your account.

```APIDOC
## Actions with Proxies

### Description
This section describes actions that can be performed with active proxy servers in your account.

### Method
GET

### Endpoint
/proxy-seller/actions-with-proxies.md

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
Information on available proxy actions.

#### Response Example
N/A
```

```APIDOC
## Retrieve Active Proxy

### Description
This request shows you all your proxies, either all of them or a specific type.

### Method
GET

### Endpoint
/proxy-seller/actions-with-proxies/retrieve-active-proxy.md

### Parameters
#### Query Parameters
- **type** (string) - Optional - The type of proxy to retrieve (e.g., 'residential', 'datacenter').

### Request Example
N/A

### Response
#### Success Response (200)
- **proxies** (array) - A list of active proxy objects.
  - **ip** (string) - The IP address of the proxy.
  - **port** (integer) - The port of the proxy.
  - **type** (string) - The type of the proxy.

#### Response Example
{
  "proxies": [
    {
      "ip": "192.168.1.1",
      "port": 8080,
      "type": "http"
    }
  ]
}
```

```APIDOC
## Export IPs in txt/csv/custom

### Description
This request helps to download your proxy list in various formats.

### Method
GET

### Endpoint
/proxy-seller/actions-with-proxies/export-ips-in-txt-csv-custom.md

### Parameters
#### Query Parameters
- **format** (string) - Required - The desired format for the export (e.g., 'txt', 'csv', 'custom').

### Request Example
N/A

### Response
#### Success Response (200)
- **file_url** (string) - A URL to download the exported proxy list.

#### Response Example
{
  "file_url": "http://example.com/proxies.txt"
}
```

```APIDOC
## IP Replacement

### Description
This query will help you create a proxy replacement request.

### Method
POST

### Endpoint
/proxy-seller/actions-with-proxies/ip-replacement.md

### Parameters
#### Request Body
- **proxy_id** (string) - Required - The ID of the proxy to be replaced.
- **reason** (string) - Optional - The reason for replacement.

### Request Example
{
  "proxy_id": "proxy-123",
  "reason": "IP is not working"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the replacement request.

#### Response Example
{
  "message": "Proxy replacement request submitted successfully."
}
```

```APIDOC
## Comment on IP

### Description
This request helps you to set a comment on a proxy.

### Method
POST

### Endpoint
/proxy-seller/actions-with-proxies/comment-on-ip.md

### Parameters
#### Request Body
- **proxy_id** (string) - Required - The ID of the proxy to add a comment to.
- **comment** (string) - Required - The comment to be added.

### Request Example
{
  "proxy_id": "proxy-123",
  "comment": "Testing proxy for performance"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the comment being added.

#### Response Example
{
  "message": "Comment added to proxy successfully."
}
```

```APIDOC
## Extend Proxies

### Description
Learn how to renew your proxies.

### Method
POST

### Endpoint
/proxy-seller/actions-with-proxies/extend-proxies.md

### Parameters
#### Request Body
- **proxy_ids** (array) - Required - A list of proxy IDs to extend.
- **duration_days** (integer) - Required - The number of days to extend the proxies for.

### Request Example
{
  "proxy_ids": ["proxy-123", "proxy-456"],
  "duration_days": 30
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the proxy extension.

#### Response Example
{
  "message": "Proxies extended successfully."
}
```

--------------------------------

### Example Request Body for Creating Modem Authorization (JSON)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/modem-authorization

Demonstrates the structure of a JSON request body for creating a modem authorization, specifying modem IDs, authentication type, and credentials.

```json
{
    "modemIds": ["63c234098746e15666325bf9f"],
    "authType": "LOGIN",
    "ip": "",
    "login" "samuel",
    "password": "re129883pas"
}
```

--------------------------------

### Get Proxy Limits Response (JSON)

Source: https://docs.proxy-seller.com/mobile-crm/api-reference/proxy-limit

Example JSON response for a successful retrieval of proxy limits, showing ID, owner ID, speed limit, and traffic limit.

```JSON
{
  "id": "652319f04cb7965413432168",
  "ownerId": "62326bcaf3904578675f9ef7",
  "speedLimit": 10000,
  "trafficLimit": 10000
}
```

--------------------------------

### Create Domain

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/modem-action-links/create-domain

Creates a custom domain with specified settings and prefixes. Requires an API key and domain confirmation after creation.

```APIDOC
## POST /api/domains

### Description
Creates a custom domain with specified settings and prefixes. Requires an API key and domain confirmation after creation.

### Method
POST

### Endpoint
/api/domains

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your API key for authentication.

#### Request Body
- **domain** (string) - Required - The custom domain name to create.
- **useTls** (boolean) - Optional - Whether to use TLS for the domain (defaults to false).
- **prioritized** (boolean) - Optional - Whether to prioritize the domain (defaults to false).
- **linkEnabled** (boolean) - Optional - Whether the domain link is enabled (defaults to true).
- **prefix** (string) - Optional - A prefix for the domain, e.g., "/some/prefix/".

### Request Example
```json
{
    "domain": "example.com",
    "useTls": true,
    "prioritized": true,
    "linkEnabled": false,
    "prefix": "/my/custom/prefix/"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created domain.
- **domain** (string) - The created custom domain name.
- **useTls** (boolean) - Indicates if TLS is used for the domain.
- **approved** (boolean) - Indicates if the domain has been approved.
- **prioritized** (boolean) - Indicates if the domain is prioritized.
- **linkEnabled** (boolean) - Indicates if the domain link is enabled.
- **prefix** (string) - The prefix associated with the domain.

#### Response Example
```json
{
    "id": "6683a91b19erd56a69f71697",
    "domain": "some.com",
    "useTls": false,
    "approved": false,
    "prioritized": false,
    "linkEnabled": true,
    "prefix": "/some/prefix/"
}
```
```

--------------------------------

### GET /api/modems

Source: https://docs.proxy-seller.com/mobile-crm/usage-guides/modem-actions/get-all-modems

Retrieve a list of all modems associated with your account. This endpoint requires an API key for authentication.

```APIDOC
## GET /api/modems

### Description
Retrieves a list of all modems, including their status, IP addresses, and associated host information.

### Method
GET

### Endpoint
/api/modems

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your API key for authentication.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the modem.
- **ip** (string) - The IP address of the modem (may be empty).
- **use** (boolean) - Indicates if the modem is currently in use.
- **status** (string) - The current status of the modem (e.g., "DOWN", "UP").
- **ipProxy** (string) - The proxy IP address associated with the modem.
- **portHttp** (string) - The HTTP port for the modem.
- **portSocks** (string) - The SOCKS port for the modem.
- **simProvider** (string) - The SIM card provider.
- **simNumber** (string|null) - The SIM card number, if available.
- **hostId** (string) - The identifier of the host the modem belongs to.

#### Response Example
```json
[
  {
    "id": "63c234098746e15666325bf9f",
    "ip": "",
    "use": false,
    "status": "DOWN",
    "ipProxy": "101.111.44.191",
    "portHttp": "40303",
    "portSocks": "50303",
    "simProvider": "MTS UKR",
    "simNumber": null,
    "hostId": "21vjv1224n45v7457mvcas"
  }
]
```
```

--------------------------------

### PUT /personal/api/v1/{YourApiKey}/residentsubuser/list/tools

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/create-a-special-list-for-api-tool

Creates a special list for the API-TOOL. This endpoint requires your personal API key and a package key for the subuser's package.

```APIDOC
## PUT /personal/api/v1/{YourApiKey}/residentsubuser/list/tools

### Description
Creates a special list for the API-TOOL. This endpoint requires your personal API key and a package key for the subuser's package.

### Method
PUT

### Endpoint
https://proxy-seller.com/personal/api/v1/{YourApiKey}/residentsubuser/list/tools

### Parameters
#### Path Parameters
- **{YourApiKey}** (string) - Required - Your personal API key.

#### Query Parameters
None

#### Request Body
- **package_key** (string) - Required - The key of the subuser's package where you want to create the special list.

### Request Example
```json
{
  "package_key": "YOUR_PACKAGE_KEY"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success' or 'error').
- **data** (object) - Contains data related to the operation. Can be null if an error occurred.
  - **id** (integer) - The ID of the created list (on success).
  - **login** (string) - The login for the created list (on success).
  - **password** (string) - The password for the created list (on success).
- **errors** (array) - An array of error objects if the operation failed.
  - **message** (string) - Description of the error.
  - **code** (integer) - Error code.
  - **customData** (any) - Additional custom data related to the error.

#### Response Example (Success)
```json
{
  "status": "success",
  "data": {
    "id": 561,
    "login": "api3c8aa1d4",
    "password": "AZT62Dx3"
  },
  "errors": []
}
```

#### Response Example (Error - Wrong API Key)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        },
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        },
        {
            "message": "Request limit reached",
            "code": 503,
            "customData": null
        }
    ]
}
```

#### Response Example (Error - IP Not Allowed)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        }
    ]
}
```

#### Response Example (Error - Tarif Not Found)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Tarif not found",
            "code": 0,
            "customData": null
        }
    ]
}
```
```

--------------------------------

### Get Package Information API Endpoint

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/subaccounts-subusers/get-package-information

This snippet shows the structure of the GET request to retrieve package information from the Proxy Seller API. It requires your personal API key as a path parameter. The response format varies based on success or error conditions.

```HTTP
GET https://proxy-seller.com/personal/api/v1/{YourApiKey}/residentsubuser/packages
```

--------------------------------

### GET /personal/api/v1/{YourApiKey}/resident/geo/isp

Source: https://docs.proxy-seller.com/proxy-seller/residential-proxy/api-tool/get-all-isp-codes

Fetches a list of all ISP codes and their corresponding names from the Proxy-Seller service.

```APIDOC
## GET /personal/api/v1/{YourApiKey}/resident/geo/isp

### Description
Retrieves a list of all ISP codes and their corresponding names.

### Method
GET

### Endpoint
https://proxy-seller.com/personal/api/v1/{YourApiKey}/resident/geo/isp

### Parameters
#### Path Parameters
- **YourApiKey** (string) - Required - Your personal API key for authentication.

### Request Example
```
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/resident/geo/isp
```

### Response
#### Success Response (200)
- **isp** (string) - The name of the Internet Service Provider.
- **code** (integer) - The unique code for the ISP.

#### Response Example
```json
[
    {
        "isp": "001 IT Complex",
        "code": 23
    },
    {
        "isp": "01 System Srl",
        "code": 24
    },
    {
        "isp": "01 Telecom Ltd",
        "code": 25
    }
]
```

#### Error Response (e.g., 503)
- **status** (string) - Indicates the status of the response, usually "error".
- **data** (null) - Placeholder for data, null in case of errors.
- **errors** (array) - An array of error objects.
  - **message** (string) - Description of the error.
  - **code** (integer) - Error code.
  - **customData** (any) - Additional custom data related to the error.

#### Error Response Example (Invalid API Key)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        },
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        },
        {
            "message": "Request limit reached",
            "code": 503,
            "customData": null
        }
    ]
}
```

#### Error Response Example (IP Not Allowed)
```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        }
    ]
}
```
```

--------------------------------

### Balance API

Source: https://docs.proxy-seller.com/proxy-seller

Endpoints for managing your account balance.

```APIDOC
## Balance

### Description
Learn which actions you can perform with your balance.

### Method
GET

### Endpoint
/proxy-seller/balance.md

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **current_balance** (number) - Your current account balance.

#### Response Example
{
  "current_balance": 500.75
}
```
Tokens:
Raw