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.
/ proxies. v1. Proxies/ GetPoolRequest body
application/jsonRequired
Request for one proxy pool in the caller's workspace by identifier.
poolId?stringOpaque 16-byte identifier of the pool, base64-encoded in JSON.
Format"byte" base64
Response body
application/json
Success
pool?ProxiesPoolThe pool with its settings and proxy_count.
Show attributes
assignmentCount?integerNumber of accounts assigned to the pool, counted when the pool is read. Zero in create and update responses.
Format"int32"
autoRotateUnhealthy?booleanTrue 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?stringWhen the pool was created.
Format"date-time"
deletedAt?stringWhen the pool was deleted. Absent while it is live.
Format"date-time"
description?stringFree-text description of the pool. May be empty.
disabledSessionCount?integerNumber of live sessions that are disabled.
Format"int32"
freeSessionCount?integerNumber 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?integerNumber of enabled sessions whose latest health check passed.
Format"int32"
id?stringOpaque 16-byte identifier of the pool, assigned on creation. Base64-encoded in JSON.
Format"byte" base64
maxAssignmentsPerSession?integerMaximum number of accounts sharing one session. Absent means no limit.
Format"int32"
maxSessions?integerMaximum number of enabled sessions in the pool. Absent means no limit.
Format"int32"
name?stringPool 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?stringWhen the least recently checked enabled session was last checked. Absent while no enabled session has been checked.
Format"date-time"
probeInterval?stringHow often each session in the pool is health checked. Absent uses the service default.
probeLatencyCeiling?stringHealth check round trip time above which a check counts as failed. Absent uses the service default.
proxyCount?integerNumber of live sessions in the pool, enabled or not, counted when the pool is read. Zero in create and update responses.
Format"int32"
purchaseLocation?stringWhere a bought address is ordered from, in the provider's own naming such as Germany - Frankfurt. Empty uses the provider's default.
sessionCount?integerNo longer used and always 0. proxy_count gives the number of sessions in the pool.
Format"int32"
unhealthyAfterFailures?integerNumber of consecutive failed health checks after which a session is marked unhealthy. Absent uses the service default.
Format"int32"
unhealthySessionCount?integerNumber of enabled sessions whose latest health check failed.
Format"int32"
unprobedSessionCount?integerNumber of enabled sessions that have never been health checked.
Format"int32"
updatedAt?stringWhen the pool was last changed.
Format"date-time"
version?stringEdit counter, incremented by every change a user makes to the pool.
Format"int64"
workspaceId?stringOpaque 16-byte identifier of the workspace that owns the pool, base64-encoded in JSON.
Format"byte" base64
application/json
The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The requested resource does not exist in this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The service is temporarily unavailable. Retry with backoff.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
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=="
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/GetPool", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}),
});
const data = await res.json();body := strings.NewReader(`{
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/GetPool", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/proxies.v1.Proxies/GetPool",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"poolId": "AY+MISIifMyN3T09PT09PQ=="
},
)
data = res.json(){
"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
}
}{
"code": "failed_precondition",
"message": "The request cannot be carried out in the current system state."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "not_found",
"message": "The requested resource does not exist in this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}{
"code": "unavailable",
"message": "The service is temporarily unavailable. Retry with backoff."
}