Skip to content

API Reference / Proxy assignments

Count proxy assignments

Returns the number of proxy assignments in your workspace matching the same filter ListAssignments takes, so a list page can render a count without loading and counting every row.

POST/proxies.v1.Proxies/CountAssignments

Request body

application/jsonRequired

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

filter?AssignmentFilter

The same filter as ListAssignments.

Show attributes
accountName?string

Deprecated: use account_names. One Steam account name to limit results to, matched exactly after trimming. Setting both account_name and account_names is rejected with invalid_argument.

accountNames?array<string>

Steam account names to limit results to, at most 100, each matched exactly after trimming. Empty includes assignments across all accounts.

accountSessionStatusesarray<string>

Steam session statuses of the assigned account to include, OR within the field. An account whose status is not known yet matches none of them. Empty includes every account. Required.

Value in"SESSION_STATUS_DISCONNECTED""SESSION_STATUS_CONNECTING""SESSION_STATUS_CONNECTED""SESSION_STATUS_LOGGED_ON""SESSION_STATUS_ERROR"

countries?array<string>

Exit countries of the bound session to include, as upper-case ISO 3166-1 alpha-2 codes, OR within the field. The empty string selects assignments whose country is not known: a pending assignment and a session whose provider reports none. Empty includes every country.

healths?array<string>

Health states of the bound session to include. A pending assignment has no session and matches none of them. Empty includes assignments regardless of health.

Value in"SESSION_HEALTH_STATE_HEALTHY""SESSION_HEALTH_STATE_UNHEALTHY""SESSION_HEALTH_STATE_UNPROBED"

pinned?boolean

True selects only pinned assignments, false only unpinned ones. Unset includes both.

poolId?string

Optional pool id to limit results to a single pool. Unset includes assignments across all pools.

Format"byte" base64

providerIds?array<string>

Opaque 16-byte provider identifiers, base64-encoded in JSON, to limit results to assignments whose bound session comes from one of them. Empty includes every provider.

sessionId?string

Optional session id to limit results to assignments bound to a single session. Unset includes assignments across all sessions.

Format"byte" base64

Response body

application/json

Success

count?integer

Number of live assignments matching the filter.

Format"int32"

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/CountAssignments" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "poolId": "AY+MISIifMyN3T09PT09PQ=="
    }
  }'
{
  "count": 2
}