API Reference / Proxy assignments
List proxy assignments
Returns the proxy assignments in your workspace, each with the session it uses, optionally filtered by pool, session, a set of account names, the session's health, its provider or pinning. Results are paginated. Pass an empty cursor for the first page and follow the returned cursor for subsequent pages.
/ proxies. v1. Proxies/ ListAssignmentsRequest body
application/jsonRequired
Request for one page of the proxy assignments in the caller's workspace, with optional filtering and ordering.
cursor?stringOpaque pagination cursor from a previous ListAssignmentsResponse. Empty for the first page.
descending?booleanOrder descending instead of ascending.
filter?AssignmentFilterOptional filters applied before pagination.
Show attributes
accountName?stringDeprecated: 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_"SESSION_"SESSION_"SESSION_"SESSION_
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_"SESSION_"SESSION_
pinned?booleanTrue selects only pinned assignments, false only unpinned ones. Unset includes both.
poolId?stringOptional 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?stringOptional session id to limit results to assignments bound to a single session. Unset includes assignments across all sessions.
Format"byte" base64
limit?integerMaximum number of assignments to return. Server caps this at a service-defined upper bound.
Format"int32"
sortField?stringField to order the page by. Unspecified orders by creation time.
Value in"ASSIGNMENT_"ASSIGNMENT_"ASSIGNMENT_
Response body
application/json
Success
assignments?array<ProxiesAssignment>Full assignments for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetAssignment.
Show attributes
accountName?stringSteam account name the assignment is for, unique within the workspace. Cannot be changed after creation.
createdAt?stringWhen the assignment was created.
Format"date-time"
deletedAt?stringWhen the assignment was deleted. Absent while it is live.
Format"date-time"
id?stringOpaque 16-byte identifier of the assignment, assigned on creation. Base64-encoded in JSON.
Format"byte" base64
pinned?booleanTrue keeps the account on its current session: it is never rotated automatically. Only an assignment with a session can be pinned.
poolId?stringOpaque 16-byte identifier of the pool the account belongs to, base64-encoded in JSON. Cannot be changed after creation.
Format"byte" base64
session?ProxiesSessionThe session the account currently uses, with its latest health check result. Absent while the assignment is pending, and in create and update responses.
Show attributes
addressRange?stringAddress range the endpoint's address belongs to, in CIDR notation, as the provider reports it or as the address's /24 when it does not. Absent when not known.
assignedAccountNames?array<string>Steam account names currently assigned to the session, in name order. Empty when no account uses it, and in create and update responses.
carrier?stringNetwork the endpoint's address comes from, as an ASN such as AS8881, when the provider reports it or it was bought on a named network. Absent when not known.
country?stringExit country of the endpoint as an upper-case ISO 3166-1 alpha-2 code, as reported by the provider. Absent when the country is not known, such as for an imported endpoint or a rotating provider's slot.
createdAt?stringWhen the session was created.
Format"date-time"
deletedAt?stringWhen the session was deleted. Absent while it is live.
Format"date-time"
enabled?booleanTrue when the session can be handed to accounts. Disabling it moves its unpinned accounts to other sessions.
health?ProxiesSessionHealthThe session's latest health check result. Absent when it has never been checked, and in create and update responses.
Show attributes
condition?stringWhy the session counts as failing although its checks pass, such as long-lived connections through it being cut again and again. Unspecified when nothing beyond the checks is wrong. While set, every check counts as failed, so the session leaves placement and, where replacement is switched on, is replaced.
Value in"SESSION_
conditionObservedAt?stringWhen the condition was last seen. The session keeps the condition for 24 hours after this, so moving its accounts away does not bring it straight back. Absent when there is no condition.
Format"date-time"
consecutiveFailures?integerNumber of checks in a row that have failed. Reset to zero by a successful check.
Format"int32"
exitAddress?stringThe address the proxy's traffic leaves from, as last observed: a fixed endpoint's own address, or for a rotating proxy the address our echo saw. Absent until it has been observed.
exitCity?stringCity the exit address is in, in English, from a location database lookup. Approximate, and absent when the exit address is not known or the database has no city for it.
exitCountry?stringCountry the exit address is in, as an upper-case ISO 3166-1 alpha-2 code, from a location database lookup. Absent when the exit address is not known or the database has no country for it.
exitSeenAt?stringWhen the exit address was last observed. Absent until it has been.
Format"date-time"
healthy?booleanTrue once a health check has confirmed the session works and it has not since failed too many checks in a row.
lastFailureAt?stringWhen a check last failed. Absent when none has.
Format"date-time"
lastFailureClass?stringThe kind of error of the last failed check, such as authentication failed or connection timeout. Unspecified until a check fails.
Value in"REQUEST_"REQUEST_"REQUEST_"REQUEST_"REQUEST_"REQUEST_"REQUEST_"REQUEST_"REQUEST_
lastFailureStatusCode?integerHTTP status of the last failed check, such as 407 for rejected credentials. Zero until a check fails, and kept after later successes.
Format"int32"
lastSuccessAt?stringWhen a check last succeeded. Absent when none has.
Format"date-time"
latency?stringRound trip time of the last successful check, in milliseconds. Absent until a check succeeds.
probedAt?stringWhen the session was last checked, whether the check passed or failed.
Format"date-time"
reconnectCount?integerFor the connections cut condition: the most times one account opened its connection through the session in the 30 minutes before the condition was last seen. Zero when there is no condition.
Format"int32"
sessionId?stringOpaque 16-byte identifier of the session checked, base64-encoded in JSON.
Format"byte" base64
workspaceId?stringOpaque 16-byte identifier of the workspace that owns the session, base64-encoded in JSON.
Format"byte" base64
host?stringEndpoint host name or IP address of a fixed endpoint. Empty for a rotating provider's slot.
id?stringOpaque 16-byte identifier of the session, assigned on creation. Base64-encoded in JSON.
Format"byte" base64
poolId?stringOpaque 16-byte identifier of the pool the session belongs to, base64-encoded in JSON.
Format"byte" base64
port?integerEndpoint TCP port of a fixed endpoint, from 1 to 65535. Zero for a rotating provider's slot.
Format"int32"
providerId?stringOpaque 16-byte identifier of the provider the session comes from, base64-encoded in JSON. Empty for a session in an imported pool.
Format"byte" base64
scheme?stringProtocol used to connect: "http", "https" or "socks5".
slot?integerSlot number of a Webshare residential session, the token as an integer. Absent for other sessions.
Format"int32"
token?stringThe session's key within its pool: the sticky session identifier for a rotating provider, or the endpoint key for a fixed endpoint. Unique within the pool and never changes.
updatedAt?stringWhen the session was last changed.
Format"date-time"
username?stringUsername for proxy authentication of a fixed endpoint. Empty for a rotating provider's slot or an endpoint that authenticates by IP address.
version?stringEdit counter, incremented by every change a user makes to the session.
Format"int64"
workspaceId?stringOpaque 16-byte identifier of the workspace that owns the session, base64-encoded in JSON.
Format"byte" base64
sessionId?stringOpaque 16-byte identifier of the session the account currently uses, base64-encoded in JSON. Empty while the assignment is pending, before the account's first proxy lookup draws a session.
Format"byte" base64
updatedAt?stringWhen the assignment was last changed.
Format"date-time"
version?stringEdit counter, incremented by every change a user makes to the assignment.
Format"int64"
workspaceId?stringOpaque 16-byte identifier of the workspace that owns the assignment, base64-encoded in JSON.
Format"byte" base64
nextCursor?stringCursor to pass to fetch the next page. Empty when there are no more results.
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 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/ListAssignments" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"limit": 50,
"filter": {
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/ListAssignments", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 50,
"filter": {
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}
}),
});
const data = await res.json();body := strings.NewReader(`{
"limit": 50,
"filter": {
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/ListAssignments", 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/ListAssignments",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"limit": 50,
"filter": {
"poolId": "AY+MISIifMyN3T09PT09PQ=="
}
},
)
data = res.json(){
"assignments": [
{
"id": "AY+MI0REf/+Kql9fX19fXw==",
"workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
"poolId": "AY+MISIifMyN3T09PT09PQ==",
"sessionId": "AY+MIjMzfu6P/05OTk5OTg==",
"accountName": "steam_bot_01",
"pinned": true,
"version": "1",
"createdAt": "2026-06-20T12:00:00Z",
"updatedAt": "2026-06-20T12:00:00Z"
},
{
"id": "AY+MJTU1NTU1NTU1NTU1NQ==",
"workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
"poolId": "AY+MISIifMyN3T09PT09PQ==",
"sessionId": "AY+MJTQ0NDQ0NDQ0NDQ0NA==",
"accountName": "steam_bot_02",
"version": "1",
"createdAt": "2026-06-30T14:00:00Z",
"updatedAt": "2026-06-30T14:00:00Z"
}
],
"nextCursor": "eyJvZmZzZXQiOjUwfQ=="
}{
"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": "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."
}