Skip to main content
GET
List Orders
Retrieve a list of all active and cancelled (not yet expired) orders. Optionally include proxy details, and optionally include expired orders, in the response. Each order includes a status field that is one of:
  • active — currently active and renewing
  • cancelled — set to cancel at period end, but still usable until expiration
  • pending — a renewal payment failed. Update your payment method to keep the order
  • expired — past its expiration date (only returned when include_expired=true)

Request

Headers

Query Parameters

boolean
Set to true to include proxy details in the response. Default is false.
boolean
Set to true to also include expired orders. Expired orders are excluded by default.
string
Proxy format when include_proxies=true. Options:
  • ipup - ip:port:username:password (default)
  • upip - username:password:ip:port
  • upaip - username:password@ip:port
  • object - JSON object format
string
http (default) or socks5. With socks5, each proxy comes back with the SOCKS5 port in place of the HTTP port. The IPs, username and password stay the same. Leave it off and you get the same HTTP list as before. Any other value returns 400. Only applies when include_proxies=true.
string
windows, macos, ios or linux. Adds -os-<value> to each username in proxies to choose that TCP/IP fingerprint. The password, IP and port stay the same. Only applies when include_proxies=true. Leave it off for the default list. Any other value, including android, returns 400.

Example Requests

Get Order Summaries

Get Orders with Proxy Details

Get Orders with Custom Format

Get Orders with SOCKS5 Proxies

Include Expired Orders

Response

Success Response (Without Proxies)

Success Response (With Proxies)

No Orders

Response Fields

string
Status of the request.
object
Summary statistics for all orders.
integer
Total number of orders returned.
integer
Sum of quantity across all returned orders.
object
Breakdown of orders by product category.
object
Breakdown of orders by status (active, cancelled, expired). Only statuses present in the result set are included.
array
Array of order objects.

Order Object Fields

Proxy Formats

When include_proxies=true, you can specify the format: Add protocol=socks5 to get any of these formats with the SOCKS5 port. The IP, username and password don’t change. Add fingerprint=windows|macos|ios|linux to get any of these formats with a TCP/IP fingerprint suffix on the username. See TCP Fingerprint Profiles.

Error Responses

400 Bad Request - Invalid Protocol

400 Bad Request - Invalid Fingerprint