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:

POST https://proxy-seller.com/personal/api/v1/{YourApiKey}/order/make

Example

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

Response

200: OK Success response

{
    "status": "success",
    "data": {
        "orderId": 2426273,
        "total": 16.2,
        "listBaseOrderNumbers": [
            "3388485_57471911"
        ],
        "balance": 1776.88
    },
    "errors": []
}

200: OK Error response

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

200: OK Error response

wrong countryId

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

200: Wrong periodId

wrong periodId

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

Path parameters

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

Request body

IPv4/ISP/MIX/MIX ISP

Name	Type	Description
countryId	Number	ID of the country you selected in the /reference/list/{type} request
periodId	String	ID of the period you selected in the /reference/list/{type} request
coupon	String	The coupon code, if available
paymentId	Number	IDs of the payment system. '1' for balance, '43' for the card added to your account
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	If you want to add a custom goal
generateAuth	String	Create custom authorization - Y/N (N - default)

IPv6

Name	Type	Description
countryId	Number	ID of the country you selected in the /reference/list/{type} request
periodId	String	ID of the period you selected in the /reference/list/{type} request
coupon	String	The coupon code, if available
paymentId	Number	IDs of the payment system. '1' for balance, '43' for the card added to your account
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	If you want to add a custom goal
protocol	String	HTTPS or SOCKS5

Mobile

Name	Type	Description
countryId	Number	ID of the country you selected in the /reference/list/{type} request
periodId	String	ID of the period you selected in the /reference/list/{type} request
coupon	String	The coupon code, if available
paymentId	Number	IDs of the payment system. '1' for balance, '43' for the card added to your account
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	ID of the operator you selected in the /reference/list/{type} request
rotationId	Number	ID of the rotation you selected in the /reference/list/{type} request

Resident

Name	Type	Description
coupon	String	The coupon code, if available
paymentId	Number	IDs of the payment system. '1' for balance, '43' for the card added to your account
tarifId	Number	ID of the tarid you selected in the /reference/list/{type} request