List active orders

GET

/orders

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/orders?package__type=residential");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.proxyrequest.com/api/v1/orders?package__type=residential"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.proxyrequest.com/api/v1/orders?package__type=residential"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.proxyrequest.com/api/v1/orders?package__type=residential"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/orders?package__type=residential")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.proxyrequest.com/api/v1/orders',
  params: {package__type: 'residential'},
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.proxyrequest.com/api/v1/orders?package__type=residential';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/orders?package__type=residential")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build()

val response = client.newCall(request).execute()

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/orders";

    let querystring = [
        ("package__type", "residential"),
    ];

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url 'https://api.proxyrequest.com/api/v1/orders?package__type=residential' \
  --header 'Authorization: Bearer <token>'

Returns active package orders owned by the authenticated account. Filters can narrow the result by package or user.

Authorizations

BearerAuth
StaticAuth

Parameters

Query Parameters

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

ordering

string

Which field to use when ordering the results.

package__alias

string

package__id

string

package__type

string

Allowed values: residential static

static - Static * residential - Residential

search

string

Case-insensitive partial search across Order fields: id, alias, internal_id, and proxy_password. Separate multiple terms with spaces or commas; every term must match at least one listed field.

user__email

string

user__id

string format: uuid

Responses

200

The operation completed successfully.

application/json

object

count

required

integer

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

object

string

<= 36 characters

is_auto_renewal

required

boolean

auto_renewal_percentage

Auto Renewal Threshold (%)

When this percentage of the data allowance has been consumed, the order is automatically renewed if the user has sufficient balance. Set to 0 to disable auto-renewal. 80 → renew when 80% of data is used

integer

<= 70

auto_renewal_data

Auto Renewal Data (GB)

Amount of data in GB to add when auto-renewal is triggered. Set to 0 to use the package default.

integer

<= 10000

package

required

object

key

additional properties

proxy_password

Password used by the customer to authenticate proxy connections. Auto-generated by default — change only if a custom value is needed. Must be between 4 and 64 characters.

string

<= 64 characters

proxy_password_reset

Password Last Changed

Timestamp of the last proxy password change. Read-only — updated automatically whenever the password is rotated.

string format: date-time

nullable

pools

Private proxy pools assigned to this order. Pools restrict which proxy IPs are available to this customer. Leave blank to use the full provider pool.

Array<string>

data

Data Allowance (bytes)

Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB

integer format: int64

<= 1000000000000000

data_remaining

required

integer

data_spent

Data Spent (bytes)

Total bytes consumed from this order’s data allowance so far. Updated in real time as the customer uses the proxy.

integer format: int64

>= -9223372036854776000 <= 9223372036854776000

ledgers

required

Array<object>

object

key

additional properties

latest_data_top_up

Latest Top-up (bytes)

Amount of data added to this order in bytes during the most recent top-up.

integer format: int64

>= -9223372036854776000 <= 9223372036854776000

latest_data_top_up_date

Latest Top-up Date

Timestamp of the most recent data top-up, set when an invoice is fulfilled.

string format: date-time

nullable

data_updated

required

Last Used

string format: date-time

updated

required

string format: date-time

created

required

string format: date-time

Examples

example

Example response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "is_auto_renewal": true,
      "auto_renewal_percentage": 1,
      "auto_renewal_data": 1,
      "package": {},
      "proxy_password": "p9W4rT2xK7mQ",
      "proxy_password_reset": "2026-07-01T12:30:00Z",
      "pools": [
        "residential"
      ],
      "data": 1073741824,
      "data_remaining": 1,
      "data_spent": 1073741824,
      "ledgers": [
        {}
      ],
      "latest_data_top_up": 1,
      "latest_data_top_up_date": "2026-07-01T12:30:00Z",
      "data_updated": "2026-07-01T12:30:00Z",
      "updated": "2026-07-01T12:30:00Z",
      "created": "2026-07-01T12:30:00Z"
    }
  ]
}

400

The request is malformed or violates a business rule.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ],
  "translation": "errors.request.invalid"
}

401

Authentication credentials are missing, expired, or invalid.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

{
  "detail": "Authentication credentials were not provided."
}

403

The authenticated account cannot perform this operation.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

{
  "detail": "You do not have permission to perform this action."
}