Skip to content

API Reference / Proxies

List proxies

Returns the proxies in your workspace that fall within a proportional range of the full sorted list, expressed as two fractions between 0 and 1 (0.0 is the first proxy, 1.0 is past the last). This is the legacy proxy inventory that coexists with the newer Provider and Pool model until the csfloat cutover removes it. Each proxy's password is never returned.

POST/proxies.v1.Proxies/ListProxies

Request body

application/jsonRequired

Request for the caller's legacy proxies within a proportional slice of the whole set, given as a start and end fraction of a fixed ordering.

rangeEnd?number

End of the proportional range to return, from 0 to 1 (the last proxy). Must be greater than range_start.

Format"double"

rangeStart?number

Start of the proportional range to return, from 0 (the first proxy) to 1 (past the last). Must be less than range_end.

Format"double"

Response body

application/json

Success

proxies?array<Proxy>

The proxies falling within the requested range, in the server's stable sort order. Passwords are never included.

Show attributes
createdAt?string

When the proxy was created.

Format"date-time"

deletedAt?string

When the proxy was deleted. Absent while it is live.

Format"date-time"

enabled?boolean

True when the proxy can be used. Set false by UpdateProxy or automatically when its failure rate is too high.

failureCount?string

Number of failed requests reported through the proxy over its lifetime. Drives automatic disabling.

Format"int64"

id?string

Opaque 16-byte identifier of the proxy, assigned on creation. Base64-encoded in JSON.

Format"byte" base64

ip?string

Proxy host address, an IPv4 or IPv6 address. Unique with port within the workspace.

password?string

Password for proxy authentication. Write only: accepted when the proxy is created, stored encrypted and never returned.

port?integer

Proxy TCP port, from 1 to 65535.

Format"int32"

scheme?string

Protocol used to connect to the proxy: "http", "https" or "socks5".

successCount?string

Number of successful requests reported through the proxy over its lifetime.

Format"int64"

updatedAt?string

When the proxy was last changed.

Format"date-time"

user?string

Username for proxy authentication. Absent for a proxy without authentication.

version?string

Edit counter, incremented by every change a user makes to the proxy.

Format"int64"

workspaceId?string

Opaque 16-byte identifier of the workspace that owns the proxy, base64-encoded in JSON.

Format"byte" base64

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/ListProxies" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rangeStart": 0,
    "rangeEnd": 1
  }'
{
  "proxies": [
    {
      "scheme": "http",
      "ip": "203.0.113.10",
      "port": 8080,
      "user": "legacyproxyuser",
      "id": "bGVnYWN5cHJveHkwMDEAAA==",
      "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
      "enabled": true,
      "version": "1",
      "createdAt": "2026-06-20T12:00:00Z",
      "updatedAt": "2026-06-29T09:00:00Z",
      "successCount": "1500",
      "failureCount": "3"
    }
  ]
}