Place an order

This request helps you place an order.

The proxy identifiers change after manual or automatic renewals.

Order processing, selection, and activation of IPs take anywhere from a few seconds to a minute, depending on the system’s overall load, including simultaneous orders and the connection queue.

Endpoint:

POSThttps://proxy-seller.com/personal/api/v2/{YourApiKey}/order/make

Path parameters

Name	Value	Description
Authorization	`<Your_API_Key>`	Your personal API key (how to get)

Request body

Name	Type	Description
countryId	String	ID of the country you selected in the /reference/list/{type} request, for example “USA“
periodId	String	ID of the period you selected in the /reference/list/{type} request, for example “1m“
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system “balance“ - balance, “card“ - card that you added in your cabinet
quantity	Number	The number of proxies you want to order
authorization	String	The method of authorization. Leave blank if you want to use username and password for authorization
customTargetName	String	Required to add a custom goal
generateAuth	String	Create custom authorization - Y/N (N - default)
sectionCode	String	Proxy type key, for example `ipv4`, `ipv6`, `mobile, mix, isp_mix`
uptime	boolean	Enables Uptime / High Availability mode for IPv4/ISP orders. Default: false. Available for IPv4 and ISP when the selected country and period support uptime pricing

Name	Type	Description
countryId	String	ID of the country you selected in the /reference/list/{type} request, for example ‘’
periodId	String	ID of the period you selected in the /reference/list/{type} request, for example ‘1m’
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system "balance" - balance, "card" - card that you added in your cabinet
quantity	Number	The number of proxies you want to order
authorization	String	The method of authorization. Leave blank if you want to use username and password for authorization
customTargetName	String	Required to add a custom goal
protocol	String	HTTPS or SOCKS5
sectionCode	String	Proxy type key, for example `ipv4`, `ipv6`, `mobile, mix, isp_mix`

Name	Type	Description
countryId/countryCode	String	ID of the country you selected in the /reference/list/{type} or Alpha-3 country code, for example “USA“
periodId/periodCode	String	ID of the period you selected in the /reference/list/{type} request, for example “1m“
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system “balance“ - balance, “card“ - card that you added in your cabinet
quantity	Number	The number of proxies you want to order
authorization	String	The method of authorization. Leave blank if you want to use username and password for authorization
mobileServiceType	String	shared or dedicated
operatorId	String	Mobile operator ID from /reference/list/mobile
rotationId	String	Mobile rotation ID from /reference/list/mobile. Must be an integer value in minutes
sectionCode	String	Proxy type key, for example `ipv4`, `ipv6`, `mobile, mix, isp_mix`

Name	Type	Description
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system “balance“ - balance, “card“ - card that you added in your cabinet
tarifId	Number	ID of the tariff you selected in the /reference/list/resident request

Example

https://proxy-seller.com/personal/api/v2/fj4948ffhg58gh843gh/order/make
{
    "countryId": "USA",
    "periodId": "1m",
    "coupon": "",
    "paymentId": "balance",
    "quantity": 1,
    "generateAuth": "N",
    "customTargetName": "Facebook",
    "sectionCode": "ipv4",
    "uptime": true
}

Response

{
    "status": "success",
    "data": {
        "orderId": "10",
        "total": 1.80,
        "listBaseOrderNumbers": [
            "NS_12345678910-qq"
        ],
        "balance": 38.00
    },
    "errors": []
}

{
  "status": "error",
  "data": null,
  "errors": [
    {
      "message": "Insufficient funds. Total $2. Not enough $33.10",
      "code": 0,
      "customData": null
    }
  ]
}

wrong countryId

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Country not exists",
            "code": 0,
            "customData": null
        }
    ]
}

wrong periodId

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Set existed [periodId] from reference",
            "code": 0,
            "customData": null
        }
    ]
}

Endpoint:

Path parameters

Request body

Example

Response

On this page