Proxy-seller
ProxyFree toolsContact sales
  • Documentation
  • PROXY-SELLER
    • Authorization
    • Actions with proxies
      • Retrieve active proxy
      • Export IPs in txt/csv/custom
      • IP replacement
      • Comment on IP
      • Extend proxies
      • Authorizations
        • List of authorizations
        • Create authorization
        • Change authorization
        • Delete authorization
    • Order actions
      • Complete information
      • Calculate the order
      • Place an order
    • Balance
    • Residential proxy
      • Get package information
      • Get all locations
      • Get existing IP list
      • Create list
      • Rename list
      • Change rotation settings
      • Delete list
      • Subaccounts (subusers)
        • Create subuser package
        • Update package
        • Get package information
        • Delete subuser's package
        • Retrieve existing IP lists
        • Create IP list
        • Rename created list
        • Change rotation
        • Delete list
        • Create a special list for API-TOOL
      • Session ID + TTL
        • Create a special list
        • Get all ISP codes
      • Cases (FAQ)
    • API - Changelog
    • SDK PHP
    • SDK NodeJS
    • SDK Phyton
    • SDK Java
    • SDK Golang
  • Mobile CRM
    • Get authorization key
    • Usage guides
      • How to Work with API Reference
      • Host Actions
        • All hosts info
        • List of host modems
        • Change host name
        • Reboot all modems
        • Export modems info
      • Modem Actions
        • Get all modems
        • Change modem IP
        • Set pause on modem
        • Set unpause on modem
        • Reboot modem
        • Change modem rotation
        • Limits on modem
        • Delete limits on modems
        • Delete modem
        • Send a report
      • Modem authorization (users)
        • Create authorization
        • Edit authorization
        • Modem authorizations
        • Authorization info
        • Limit authorization
        • Get limit authorization
        • Delete authorization
      • Modem action links
        • Direct links
        • Create domain
        • Approve domain
        • Edit domain
        • All client domain
        • Domain info
        • Delete domain
    • API Reference
      • Hosts
      • Modems
      • Modem authorization
      • Action links
      • Proxy limit
  • More guides
    • Youtube channel
    • Our blog
  • News, discounts
    • Reddit
    • Discord
    • Telegram
Powered by GitBook
On this page
  • Endpoint:
  • Example
  • Response
  • Path parameters
  • Request params
  1. PROXY-SELLER
  2. Actions with proxies

Retrieve active proxy

This API endpoint is designed to deliver detailed information about your active proxies. It allows you to retrieve data based on the specific type of proxy you are interested in, ensuring you can efficiently manage and assess your network's proxy configuration.

To make the most out of this API endpoint, ensure you have a clear understanding of the types of proxies implemented within your network. Utilize the filtering options to retrieve precise and meaningful proxy data.

For further details on implementing this API, refer to the API documentation, which provides sample requests, response formats, and additional parameters you can use to tailor the data retrieval to.

Endpoint:

GET https://proxy-seller.com/personal/api/v1/{YourApiKey}/proxy/list/{type}

Example

To retrieve proxies of all types:

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

To retrieve proxies of a specific type (e.g., IPv4):

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

Response

All types of proxies

{
    "status": "success",
    "data": {
        "ipv4": [],
        "ipv6": [],
        "mobile": [],
        "isp": [],
        "mix": [],
        "mix_isp": [],
        "resident": [] //proxy lists
    },
    "errors": []
}

One type of proxy

{
    "status": "success",
    "data": {
        "items": [
            {
                "id": "0678564",
                "order_id": "123456",
                "order_number": "2000096_20240080",
                "basket_id": "12345566",
                "ip": "31.6.33.97",
                "ip_only": "31.6.33.97",
                "protocol": "HTTP",
                "port_socks": 12345,
                "port_http": 12345,
                "login": "ruht5734hg",
                "password": "gou5h437g",
                "auth_ip": "",
                "rotation": null,
                "link_reboot": "#",
                "country": "Belgium",
                "country_alpha3": "BEL",
                "status": "Active",
                "status_type": "ACTIVE",
                "can_prolong": true,
                "date_start": "23.06.2024",
                "date_end": "23.07.2024",
                "comment": "",
                "auto_renew": "N",
                "auto_renew_period": ""
            }
        ]
    },
    "errors": []
}

Wrong type of proxy

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Could not find description of list{type} in CrmUserApiProxy",
            "code": 22002,
            "customData": null
        }
    ]
}

Path parameters

Name
Value
Description

Authorization

<Your_API_Key>

Proxy type (optional)

ipv4

ipv6

mobile

isp

mix

mix_isp

The type of proxy you want to retrieve

Please note that if no proxy type is specified, all available types will be returned for your profile.

Request params

Name
Type
Description

latest

String

Y/N - Return proxy from last order

orderId

String

Return a proxy from a specific orderId or baseOrderNumber

country

String

Alpha3 country name (FRA or USA or ...)

ends

String

Y - List of ending proxies

PreviousActions with proxiesNextExport IPs in txt/csv/custom

Last updated 1 month ago

Your personal API key ()

how to get