Goldmine
Providers

List proxy providers

POST
/proxies.v1.Proxies/ListProviders

Returns the proxy providers connected to your workspace, fully hydrated (the encrypted credential fields are omitted, exactly as GetProvider omits them). Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/proxies.v1.Proxies/ListProviders" \  -H "Content-Type: application/json" \  -d '{    "limit": 50  }'
{
  "providers": [
    {
      "id": "AY+MIBEReqqLuywsLCwsLA==",
      "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
      "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
      "targetPoolId": "AY+MISIifMyN3T09PT09PQ==",
      "capabilities": {
        "stateApi": true,
        "supportsSocks5": true
      },
      "state": {
        "bandwidthLimitBytes": "1099511627776",
        "bandwidthUsedBytes": "21474836480",
        "plan": "residential-1tb",
        "geoCount": 195
      },
      "stateRefreshedAt": "2026-06-29T09:00:00Z",
      "enabled": true,
      "version": "3",
      "createdAt": "2026-06-20T12:00:00Z",
      "updatedAt": "2026-06-29T09:00:00Z"
    },
    {
      "id": "AY+MIZmZfu6P/05OTk5OTg==",
      "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
      "type": "PROVIDER_TYPE_PROXYLINE",
      "targetPoolId": "AY+MJTMzMzMzMzMzMzMzMw==",
      "capabilities": {
        "staticExitIp": true,
        "enumerable": true,
        "stateApi": true,
        "supportsSocks5": true,
        "renewable": true,
        "acquirable": true
      },
      "state": {
        "bandwidthUsedBytes": "5368709120",
        "plan": "proxyline-flex",
        "geoCount": 80
      },
      "stateRefreshedAt": "2026-06-29T08:45:00Z",
      "enabled": true,
      "version": "1",
      "createdAt": "2026-06-25T09:00:00Z",
      "updatedAt": "2026-06-29T08:45: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."
}

GetProvider

Returns a single connected proxy provider, including its capabilities and the most recent snapshot of its upstream plan and bandwidth state. Stored credentials are never returned.

RefreshProviderState

Pulls the latest plan and bandwidth usage from the provider's upstream account and returns the refreshed provider. Providers without an account state interface are returned unchanged.