Skip to content

API Reference / Proxy pools

List proxy pools

Returns the proxy pools in your workspace, fully hydrated with their configuration and server-computed proxy_count, session health counts and assignment_count, optionally filtered by a text query over the name, provider type or imported, and the health of their sessions. Results are paginated. Pass an empty cursor for the first page and follow the returned cursor for subsequent pages.

POST/proxies.v1.Proxies/ListPools

Request body

application/jsonRequired

Request for one page of the proxy pools in the caller's workspace, with optional filtering and ordering.

cursor?string

Opaque pagination cursor from a previous ListPoolsResponse. Empty for the first page.

descending?boolean

Order descending instead of ascending.

filter?PoolFilter

Optional filters applied before pagination. The same filter must be used with every continuation cursor.

Show attributes
imported?boolean

True selects imported pools, which have no provider. False selects only pools with a provider. With provider_types, true adds imported pools to the listed types. Unset includes both.

providerTypes?array<string>

Provider types to include, OR within the field. With imported it forms one Type choice: a pool matches when its provider's type is listed or, when imported is true, it is an imported pool. Empty includes every provider type.

Value in"PROVIDER_TYPE_WEBSHARE_RESIDENTIAL""PROVIDER_TYPE_WEBSHARE_STATIC""PROVIDER_TYPE_PROXYLINE""PROVIDER_TYPE_SUBORBITAL""PROVIDER_TYPE_SUBORBITAL_RESIDENTIAL"

query?string

Literal case-insensitive substring of the pool name. Absent or empty matches every pool.

sessionHealths?array<string>

Session health states, OR within the field: a pool matches when at least one of its enabled sessions is in one of the listed states, so UNHEALTHY selects pools with some endpoints offline and UNPROBED pools with some still being checked. Empty does not restrict.

Value in"SESSION_HEALTH_STATE_HEALTHY""SESSION_HEALTH_STATE_UNHEALTHY""SESSION_HEALTH_STATE_UNPROBED"

limit?integer

Maximum number of pools to return. Server caps this at a service-defined upper bound.

Format"int32"

sortField?string

Field to order the page by. Unspecified orders by creation time.

Value in"POOL_SORT_FIELD_CREATED_AT""POOL_SORT_FIELD_PROXY_COUNT"

Response body

application/json

Success

nextCursor?string

Cursor to pass to fetch the next page. Empty when there are no more results.

pools?array<ProxiesPool>

Full pools for this page, ordered by the requested sort, each carrying its server-computed proxy_count. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetPool.

Show attributes
assignmentCount?integer

Number of accounts assigned to the pool, counted when the pool is read. Zero in create and update responses.

Format"int32"

autoRotateUnhealthy?boolean

True moves unpinned accounts off a session that becomes unhealthy onto a healthy one. Has no effect on sessions of a provider with static exit IPs.

carriers?array<string>

Networks a bought address must come from, as ASNs such as AS8881, best first. Empty buys on any network.

createdAt?string

When the pool was created.

Format"date-time"

deletedAt?string

When the pool was deleted. Absent while it is live.

Format"date-time"

description?string

Free-text description of the pool. May be empty.

disabledSessionCount?integer

Number of live sessions that are disabled.

Format"int32"

freeSessionCount?integer

Number of enabled sessions whose latest health check passed and that no account is assigned to: the IPs a new account could have to itself. Zero in create and update responses.

Format"int32"

healthySessionCount?integer

Number of enabled sessions whose latest health check passed.

Format"int32"

id?string

Opaque 16-byte identifier of the pool, assigned on creation. Base64-encoded in JSON.

Format"byte" base64

maxAssignmentsPerSession?integer

Maximum number of accounts sharing one session. Absent means no limit.

Format"int32"

maxSessions?integer

Maximum number of enabled sessions in the pool. Absent means no limit.

Format"int32"

name?string

Pool name, unique within the workspace. A provider's pool is named after the provider type. An imported pool takes the name given at import.

oldestProbedAt?string

When the least recently checked enabled session was last checked. Absent while no enabled session has been checked.

Format"date-time"

probeInterval?string

How often each session in the pool is health checked. Absent uses the service default.

probeLatencyCeiling?string

Health check round trip time above which a check counts as failed. Absent uses the service default.

proxyCount?integer

Number of live sessions in the pool, enabled or not, counted when the pool is read. Zero in create and update responses.

Format"int32"

purchaseLocation?string

Where a bought address is ordered from, in the provider's own naming such as Germany - Frankfurt. Empty uses the provider's default.

sessionCount?integer

No longer used and always 0. proxy_count gives the number of sessions in the pool.

Format"int32"

unhealthyAfterFailures?integer

Number of consecutive failed health checks after which a session is marked unhealthy. Absent uses the service default.

Format"int32"

unhealthySessionCount?integer

Number of enabled sessions whose latest health check failed.

Format"int32"

unprobedSessionCount?integer

Number of enabled sessions that have never been health checked.

Format"int32"

updatedAt?string

When the pool was last changed.

Format"date-time"

version?string

Edit counter, incremented by every change a user makes to the pool.

Format"int64"

workspaceId?string

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

Format"byte" base64

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/ListPools" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 50
  }'
{
  "pools": [
    {
      "id": "AY+MISIifMyN3T09PT09PQ==",
      "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
      "name": "csfloat-scrapers",
      "description": "Residential pool for csfloat scraping",
      "autoRotateUnhealthy": true,
      "version": "3",
      "createdAt": "2026-06-20T12:00:00Z",
      "updatedAt": "2026-06-29T09:00:00Z",
      "maxAssignmentsPerSession": 1,
      "probeInterval": "300s",
      "unhealthyAfterFailures": 3,
      "probeLatencyCeiling": "5s",
      "proxyCount": 2
    },
    {
      "id": "AY+MJTIyMjIyMjIyMjIyMg==",
      "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
      "name": "steam-real-accounts",
      "description": "Static proxies for steam account logins",
      "maxSessions": 200,
      "proxyCount": 45,
      "version": "2",
      "createdAt": "2026-06-22T08:00:00Z",
      "updatedAt": "2026-06-29T07:30:00Z"
    }
  ],
  "nextCursor": "eyJvZmZzZXQiOjUwfQ=="
}