Create an order

IPv4 type

POST /client/api/v1/{apiKey}/order

Path parameters

Name	Type	Description
apiKey*	String	Your personal API key.

Request body

Name	Type	Description
proxyType*	String	Proxy type IPv4.
authIp	String	Authorization IP. This field is required only if authType is IP.
authType*	String	Authorization type. Available values: LOGIN, IP.
goal*	String	Custom goal.
country*	String	Alfa3 country code (can be obtained by another request).
promoCode	String	Code of the promo code (can be obtained by another request).
quantity*	Number	Quantity of IP addresses.
rentPeriodDays*	Number	Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response

{
    "success": true,
    "proxyType": "IPv4",
    "orderNumber": "NUMBER-112233",
    "balance": 4.57,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}

200: OK Success response with valid promo code

{
    "success": true,
    "proxyType": "IPv4",
    "orderNumber": "NUMBER-112233",
    "balance": 4.57,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}

200: OK Success response with invalid promo code

{
    "success": true,
    "proxyType": "IPv4",
    "orderNumber": "NUMBER-112233",
    "balance": 4.57,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "orderNumber": null,
    "balance": 7.18,
    "currency": "USD",
    "error": {
        "code": 14,
        "message": "Incorrect goal"
    },
    "promoCodeStatus": null
}

IPv6 type

POST /client/api/v1/{apiKey}/order

Path parameters

Name	Type	Description
apiKey*	String	Your personal API key.

Request body

Name	Type	Description
proxyType*	String	Proxy type IPv6.
protocol*	String	Protocol. Available values: HTTP, SOCKS.
quantity*	Number	Quantity of IP addresses.
rentPeriodDays*	Number	Number of days in the rental period (can be obtained by another request).
authIp	String	Authorization IP. This field is required only if authType is IP.
authType*	String	Authorization type. Available values: LOGIN, IP.
goal*	String	Custom goal.
country*	String	Alfa3 country code (can be obtained by another request).
promoCode	String	Code of the promo code (can be obtained by another request).

Response

200: OK Success response

{
    "success": true,
    "proxyType": "IPv6",
    "orderNumber": "NUMBER-22334455",
    "balance": 3.76,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}

200: OK Success response with valid promo code

{
    "success": true,
    "proxyType": "IPv6",
    "orderNumber": "NUMBER-22334455",
    "balance": 3.76,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}

200: OK Success response with invalid promo code

{
    "success": true,
    "proxyType": "IPv6",
    "orderNumber": "NUMBER-22334455",
    "balance": 3.76,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "orderNumber": null,
    "balance": 4.57,
    "currency": "USD",
    "error": {
        "code": 13,
        "message": "Incorrect protocol"
    },
    "promoCodeStatus": null
}

Mobile type

POST /client/api/v1/{apiKey}/order

Path parameters

Name	Type	Description
apiKey*	String	Your personal API key.

Request body

Name	Type	Description
proxyType*	String	Proxy type MOBILE.
rotationTime*	Number	Rotation time (can be obtained by another request with mobile operators).
mobileOperator*	String	Mobile operator tag (can be obtained by another request).
quantity*	Number	Quantity of IP addresses.
rentPeriodDays*	Number	Number of days in the rental period (can be obtained by another request).
authIp	String	Authorization IP. This field is required only if authType is IP.
authType*	String	Authorization type. Available values: LOGIN, IP.
goal*	String	Custom goal.
country*	String	Alfa3 country code (can be obtained by another request).
promoCode	String	Code of the promo code (can be obtained by another request).

Response

200: OK Success response

{
    "success": true,
    "proxyType": "MOBILE",
    "orderNumber": "NUMBER-4455566677",
    "balance": 1.95,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}

200: OK Success response with valid promo code

{
    "success": true,
    "proxyType": "MOBILE",
    "orderNumber": "NUMBER-4455566677",
    "balance": 1.95,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}

200: OK Success response with invalid promo code

{
    "success": true,
    "proxyType": "MOBILE",
    "orderNumber": "NUMBER-4455566677",
    "balance": 1.95,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "orderNumber": null,
    "balance": 3.76,
    "currency": "USD",
    "error": {
        "code": 8,
        "message": "Incorrect mobile operator"
    },
    "promoCodeStatus": null
}

ISP type

POST /client/api/v1/{apiKey}/order

Path parameters

Name	Type	Description
apiKey*	String	Your personal API key.

Request body

Name	Type	Description
proxyType*	String	Proxy type ISP.
authIp	String	Authorization IP. This field is required only if authType is IP.
authType*	String	Authorization type. Available values: LOGIN, IP.
goal*	String	Custom goal.
country*	String	Alfa3 country code (can be obtained by another request).
promoCode	String	Code of the promo code (can be obtained by another request).
quantity*	Number	Quantity of IP addresses.
rentPeriodDays*	Number	Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response

{
    "success": true,
    "proxyType": "ISP",
    "orderNumber": "NUMBER-112233",
    "balance": 4.57,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}

200: OK Success response with valid promo code

{
    "success": true,
    "proxyType": "ISP",
    "orderNumber": "NUMBER-112233",
    "balance": 4.57,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}

200: OK Success response with invalid promo code

{
    "success": true,
    "proxyType": "ISP",
    "orderNumber": "NUMBER-112233",
    "balance": 4.57,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "orderNumber": null,
    "balance": 7.18,
    "currency": "USD",
    "error": {
        "code": 14,
        "message": "Incorrect goal"
    },
    "promoCodeStatus": null
}