Skip to content

API Reference / Proxy usage

Query proxy bandwidth usage

Returns the proxy bandwidth ledger over an inclusive date range, optionally narrowed by provider, pool, session, or account. Each row is a daily total of requests, errors, and bytes transferred. Results are paginated. Follow the returned cursor for subsequent pages.

POST/proxies.v1.Proxies/QueryProxyUsage

Request body

application/jsonRequired

Request for one page of daily proxy usage over a range of UTC days, optionally narrowed by provider, pool, session or account.

accountName?string

An account name to return only its traffic. Absent includes every account.

cursor?string

Opaque cursor from a previous QueryProxyUsageResponse.next_cursor. Empty for the first page. Send the same filters with every page.

endDatestring

Last UTC day of the range, inclusive, as YYYY-MM-DD. Required, and must not be before start_date.

Format"date-time"

limit?integer

Maximum number of records to return, up to 1000. Zero uses the default of 200. A larger value is rejected with invalid_argument.

Format"int32"

poolId?string

Opaque 16-byte identifier of a pool, base64-encoded in JSON, to return only its traffic. Absent includes every pool.

Format"byte" base64

providerId?string

Opaque 16-byte identifier of a provider, base64-encoded in JSON, to return only its traffic. Absent includes every provider.

Format"byte" base64

sessionId?string

Opaque 16-byte identifier of a session, base64-encoded in JSON, to return only its traffic. Absent includes every session.

Format"byte" base64

startDatestring

First UTC day of the range, inclusive, as YYYY-MM-DD. Required.

Format"date-time"

Response body

application/json

Success

nextCursor?string

Cursor to pass as cursor to fetch the next page. Empty when this is the last page.

records?array<ProxyUsageRecord>

The usage records on this page, ordered by day, then provider, pool, session and account.

Show attributes
accountName?string

The account that made the requests.

bytesIn?string

Bytes received through the proxy that day.

Format"int64"

bytesOut?string

Bytes sent through the proxy that day.

Format"int64"

errorCount?string

Number of that day's requests that failed. Part of request_count.

Format"int64"

poolId?string

Opaque 16-byte identifier of the session's pool, base64-encoded in JSON.

Format"byte" base64

providerId?string

Opaque 16-byte identifier of the provider the traffic went through, base64-encoded in JSON.

Format"byte" base64

requestCount?string

Number of requests made that day.

Format"int64"

sessionId?string

Opaque 16-byte identifier of the session the traffic used, base64-encoded in JSON.

Format"byte" base64

usageDate?string

The UTC day, as YYYY-MM-DD.

Format"date-time"

workspaceId?string

Opaque 16-byte identifier of the workspace, base64-encoded in JSON.

Format"byte" base64

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/QueryProxyUsage" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "startDate": "2026-06-01",
    "endDate": "2026-06-29",
    "poolId": "AY+MISIifMyN3T09PT09PQ==",
    "limit": 100
  }'
{
  "records": [
    {
      "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
      "providerId": "AY+MIBEReqqLuywsLCwsLA==",
      "poolId": "AY+MISIifMyN3T09PT09PQ==",
      "sessionId": "AY+MIjMzfu6P/05OTk5OTg==",
      "accountName": "steam_bot_01",
      "usageDate": "2026-06-15",
      "requestCount": "1500",
      "errorCount": "12",
      "bytesOut": "5242880",
      "bytesIn": "104857600"
    }
  ],
  "nextCursor": "eyJvZmZzZXQiOjUwfQ=="
}