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
  • 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

Example Requests

Get Order Summaries

Get Orders with Proxy Details

Get Orders with Custom Format

Include Expired Orders

Response

Success Response (Without Proxies)

Success Response (With Proxies)

Response Fields

string
Status of the request.
object
Summary statistics for all orders.
integer
Total number of active orders.
integer
Total number of proxies across all 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: