Skip to content

API Reference / Proxy pools

Get a proxy pool

Returns a single proxy pool with its configuration, capacity caps, health-probe settings, and its server-computed proxy_count, session health counts and assignment_count.

POST/proxies.v1.Proxies/GetPool

Request body

application/jsonRequired

Request for one proxy pool in the caller's workspace by identifier.

poolId?string

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

Format"byte" base64

Response body

application/json

Success

pool?ProxiesPool

The pool with its settings and proxy_count.

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/GetPool" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "poolId": "AY+MISIifMyN3T09PT09PQ=="
  }'
{
  "pool": {
    "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
  }
}