API Reference / Legacy proxy pools
List legacy proxy pools
Returns the ids of legacy proxy pools in your workspace. Unlike ListPools, results are bare ids rather than fully hydrated pools. Fetch each one with GetProxyPool. Results are paginated. Pass an empty cursor for the first page and follow the returned cursor for subsequent pages.
/ proxies. v1. Proxies/ ListProxyPoolsRequest body
application/jsonRequired
Request for one page of legacy proxy pool identifiers in the caller's workspace.
cursor?stringOpaque pagination cursor from a previous ListProxyPoolsResponse. Empty for the first page.
limit?integerMaximum number of pool ids to return. Server caps this at a service-defined upper bound.
Format"int32"
Response body
application/json
Success
nextCursor?stringCursor to pass to fetch the next page. Empty when there are no more results.
poolIds?array<string>Ids of pools for this page, in the server's stable sort order. Bare ids only. Fetch each pool with GetProxyPool.
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/ListProxyPools" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"limit": 50
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/ListProxyPools", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 50
}),
});
const data = await res.json();body := strings.NewReader(`{
"limit": 50
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/ListProxyPools", 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/ListProxyPools",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"limit": 50
},
)
data = res.json(){
"poolIds": [
"bGVnYWN5cG9vbDAwMDEAAA==",
"bGVnYWN5cG9vbDAwMDIAAA=="
],
"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."
}