API ordering

Read wallet balance

Returns the authenticated caller’s wallet balance and currency. Authenticate with the api-token header. The email is derived server-side from the auth identity, so a token can only ever read its own wallet (IDOR-safe).

By default this is an O(1) wallet primary-key lookup (balance + currency only). Pass include_counts=1 to also return topups_count and purchases_count (email-scoped compound indexes on orders).

Gated on account:api_ordering:read for API keys (admin-grant-only; off by default).

GET

account

orders

balance

Read wallet balance

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/orders/balance \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/orders/balance"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/orders/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "balance": 42.5,
    "currency": "USD"
  }
}

Authorizations

api-token

string

header

required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Query Parameters

include_counts

boolean

default:false

When true, include topups_count and purchases_count in the response. Omit for the lightweight balance-only read used by checkout.

Response

Wallet balance (and optional activity counts).

success

boolean

Example:

true

data

object

Show child attributes

Get datacenter proxy listGet the datacenter proxy list for a subaccount. Filter by country, protocol, format, and status. Permission: `datacenter_shared:read` or `datacenter_dedicated:read`.

Read wallet balance

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/orders/balance \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/orders/balance"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/orders/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "balance": 42.5,
    "currency": "USD"
  }
}