Skip to content

API Reference / Proxy pools

Count proxy pools

Returns the number of proxy pools in your workspace, so a list page can render a count without loading and counting every row.

POST/proxies.v1.Proxies/CountPools

Request body

application/jsonRequired

Request for the number of proxy pools in the caller's workspace matching a filter.

filter?PoolFilter

The same filter as ListPools.

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"

Response body

application/json

Success

count?integer

Number of live pools matching the filter.

Format"int32"

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/CountPools" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "count": 2
}