List provider data balances

GET

/providers/data-balances

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/providers/data-balances");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept-Language: de");
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/providers/data-balances"),
    Headers =
    {
        { "Accept-Language", "de" },
        { "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/providers/data-balances"

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

  req.Header.Add("Accept-Language", "de")
  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/providers/data-balances"))
    .header("Accept-Language", "de")
    .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/providers/data-balances")
  .get()
  .addHeader("Accept-Language", "de")
  .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/providers/data-balances',
  headers: {'Accept-Language': 'de', 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/providers/data-balances';
const options = {
  method: 'GET',
  headers: {'Accept-Language': 'de', 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/providers/data-balances")
  .get()
  .addHeader("Accept-Language", "de")
  .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/providers/data-balances";

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

    let client = reqwest::Client::new();
    let response = client.get(url)
        .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/providers/data-balances \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>'

Requires a JWT belonging to an active superuser or an API key owned by an active superuser, including requests using X-Impersonate-User. Returns one result per provider with recorded balances. The latest observation by observed_at is the baseline; available_bytes is that observation’s balance, not a sum of purchased data. All byte amounts are decimal strings. Calculations are saved asynchronously; inspect freshness, error and calculated_at before using them. History is ordered by creation time descending and limited by PROVIDER_DATA_BALANCE_HISTORY_LIMIT (default 10). Pagination counts providers, not history entries.

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.

Header Parameters

Accept-Language

string

default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples

de

fr-CA, fr;q=0.9, en;q=0.5

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

checkpoint_id

required

string format: uuid

provider_id

required

string

provider_name

required

string

observed_at

required

Time the available balance was observed.

string format: date-time

available_bytes

required

Observed balance in bytes, as a decimal string.

string

used_bytes

required

Calculated usage since the observation, in bytes.

string

nullable

remaining_bytes

required

Remaining bytes at calculated_at, as a decimal string.

string

nullable

remaining_percent

required

number format: double

nullable

severity

required

One of:

string
unknown

warning - warning * danger - danger

string

Allowed values: warning danger

freshness

required

fresh - fresh * stale - stale * unavailable - unavailable

string

Allowed values: fresh stale unavailable

error

required

string

calculated_at

required

Time of the last successful calculation.

string format: date-time

nullable

history

required

Latest entries by creation time, limited by PROVIDER_DATA_BALANCE_HISTORY_LIMIT (default 10).

Array<object>

object

required

string format: uuid

available_bytes

required

Observed balance in bytes, as a decimal string.

string

observed_at

required

string format: date-time

created

required

string format: date-time

created_by

required

string

nullable

Examples

ProviderDataBalance

Provider data balance

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "provider_id": "550e8400-e29b-41d4-a716-446655440001",
      "provider_name": "Example provider",
      "checkpoint_id": "550e8400-e29b-41d4-a716-446655440002",
      "available_bytes": "5000000000000",
      "used_bytes": "1000000000000",
      "remaining_bytes": "4000000000000",
      "remaining_percent": 80,
      "observed_at": "2026-09-25T12:00:00Z",
      "calculated_at": "2026-09-25T12:30:00Z",
      "severity": null,
      "freshness": "fresh",
      "error": "",
      "history": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440002",
          "available_bytes": "5000000000000",
          "observed_at": "2026-09-25T12:00:00Z",
          "created": "2026-09-25T12:01:00Z",
          "created_by": "admin"
        }
      ]
    }
  ]
}

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>

key

additional properties

One of:

string
Array<string>

string

Examples

example

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ]
}

Headers

Content-Language

string

Language used for human-readable errors.

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>

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

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

Headers

Content-Language

string

Language used for human-readable errors.

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>

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

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

Headers

Content-Language

string

Language used for human-readable errors.