Skip to content

API Reference / Proxy providers

Connect a proxy provider

Connects a credential-bearing proxy provider such as a Webshare or Proxyline account to your workspace. Credentials are sent in plaintext and encrypted before storage, and only one connection of each provider type is allowed per workspace.

POST/proxies.v1.Proxies/ConnectProvider

Request body

application/jsonRequired

Request to connect a proxy provider account to the caller's workspace. The credentials are checked with the provider, stored encrypted, and a pool for the provider's sessions is created. Connecting a type that is already connected returns already_exists.

credentials?string

The provider account's API credential as UTF-8 bytes, base64-encoded in JSON: the Webshare API token or the Proxyline API key. Returned only by RevealProviderCredentials.

Format"byte" base64

typestring

The provider to connect: Webshare residential, Webshare static, Proxyline, Suborbital static or Suborbital residential. Required.

Value in"PROVIDER_TYPE_WEBSHARE_RESIDENTIAL""PROVIDER_TYPE_WEBSHARE_STATIC""PROVIDER_TYPE_PROXYLINE""PROVIDER_TYPE_SUBORBITAL""PROVIDER_TYPE_SUBORBITAL_RESIDENTIAL"

Response body

application/json

Success

provider?ProxiesProvider

The new provider connection.

Show attributes
capabilities?ProxiesProviderCapabilities

What this provider type can do, recorded when it was connected.

Show attributes
acquirable?boolean

True when a new endpoint can be bought, which costs money, as with Proxyline.

enumerable?boolean

True when the provider lists real endpoints, as Webshare static and Proxyline do. False when sessions are rotation slots, as with Webshare residential.

releasable?boolean

True when an endpoint can be given back to the provider.

renewable?boolean

True when an endpoint can be extended before it expires, as with Proxyline.

replaceable?boolean

True when a dead endpoint can be swapped for another within the plan at no charge, as with Webshare static.

stateApi?boolean

True when the provider reports bandwidth and plan details that RefreshProviderState can read.

staticExitIp?boolean

True when each session always exits from the same IP address, so its sessions are never rotated.

supportsSocks5?boolean

True when the provider serves SOCKS5 as well as HTTP. Its sessions then use the socks5 scheme.

condition?string

Why the service switched the provider off, when it did. Unset while the provider is serving or a member switched it off themselves.

Value in"PROVIDER_CONDITION_OUT_OF_BANDWIDTH""PROVIDER_CONDITION_OUT_OF_BALANCE""PROVIDER_CONDITION_NO_ACTIVE_PLAN""PROVIDER_CONDITION_KEY_REJECTED""PROVIDER_CONDITION_ACCOUNT_SUSPENDED"

conditionDetail?string

The provider's own response to the rejected request, for support staff. Empty for a capacity condition.

conditionObservedAt?string

When the service last checked the account and still found the condition. Absent without a condition.

Format"date-time"

conditionSince?string

When the condition was first observed. Absent without a condition.

Format"date-time"

createdAt?string

When the provider was connected.

Format"date-time"

deletedAt?string

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

Format"date-time"

enabled?boolean

True when the provider's sessions can be handed to accounts. False takes its whole pool out of use.

id?string

Opaque 16-byte identifier of the provider connection, assigned when it is connected. Base64-encoded in JSON.

Format"byte" base64

purchaseBudgetCents?string

The most the service may spend buying new proxies from this provider in any rolling 30 days, in US cents. Absent means buying is switched off. Renewals are not counted against it.

Format"int64"

renewalEnabled?boolean

True when the service renews this provider's proxies that have an account on them before they expire, limited by the provider balance. False for every newly connected provider, and then nothing is renewed.

state?ProxiesProviderState

The provider account's latest plan and usage details. Empty until the first successful refresh.

Show attributes
balanceCents?string

Proxyline and Suborbital account balance, in US cents. Zero for other providers.

Format"int64"

bandwidthLimitBytes?string

Bandwidth allowed in the current billing period, in bytes. Zero when the plan is not metered.

Format"int64"

bandwidthUsedBytes?string

Bandwidth used so far in the current billing period, in bytes.

Format"int64"

failedPaymentTimes?integer

Webshare: number of failed automatic renewal payments on the subscription.

Format"int32"

geoCount?integer

Number of distinct locations available on the plan.

Format"int32"

lowBalance?boolean

True when the account balance is below low_balance_threshold_cents. The account should be topped up before renewals, purchases or traffic stop. False for providers not billed from a balance.

lowBalanceThresholdCents?string

The balance below which low_balance is true, in US cents: the larger of a fixed floor and what the endpoints expiring in the next 30 days cost to renew. Zero for providers not billed from a balance.

Format"int64"

nextRenewalAt?string

Proxyline and Suborbital static: when the earliest of the account's active endpoints expires. The renewal duty renews endpoints shortly before this time. Unset for other providers and when the account has no active endpoints.

Format"date-time"

nextRenewalCostCents?string

Proxyline: the cost of renewing next_renewal_endpoint_count endpoints at the quoted unit cost, in US cents. Unset when no quote has been read yet or no renewal is due.

Format"int64"

nextRenewalEndpointCount?integer

Proxyline and Suborbital static: how many endpoints expire within the renewal window starting at next_renewal_at, so renew together. Zero for other providers.

Format"int32"

paused?boolean

Webshare: true when the subscription is paused. False for other providers.

plan?string

The provider's identifier for the account's plan.

renewalHeldEndpointCount?integer

Proxyline: how many endpoints with an account on them expire within the renewal window but are not being renewed because renewal is switched off for this provider. They lapse unless renewal is switched on. Zero while renewal is on and for other providers.

Format"int32"

replacementQuota?integer

Webshare static: free endpoint replacements left in the current window. Zero when none are left or the provider has none.

Format"int32"

throttled?boolean

Webshare: true when the subscription is throttled. False for other providers.

unitCostCents?string

Proxyline and Suborbital static: the cost of renewing one endpoint for 30 days, in US cents (Proxyline quoted live, Suborbital the published price of the dearest kind held). Zero for other providers and before the first read.

Format"int64"

stateRefreshedAt?string

When state was last read from the provider. Absent until the first successful refresh.

Format"date-time"

targetPoolId?string

Opaque 16-byte identifier of the pool the provider's sessions belong to, base64-encoded in JSON. Created when the provider is connected and never changes.

Format"byte" base64

type?string

Which provider this is. A workspace can connect each type once.

Value in"PROVIDER_TYPE_WEBSHARE_RESIDENTIAL""PROVIDER_TYPE_WEBSHARE_STATIC""PROVIDER_TYPE_PROXYLINE""PROVIDER_TYPE_SUBORBITAL""PROVIDER_TYPE_SUBORBITAL_RESIDENTIAL"

updatedAt?string

When the connection was last changed.

Format"date-time"

userFixable?boolean

True when the member can clear the condition themselves, for example by updating the API key or topping the account up. False without a condition, and for a suspended account, which only the provider's support can lift.

version?string

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

Format"int64"

workspaceId?string

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

Format"byte" base64

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/ConnectProvider" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
    "credentials": "d2Vic2hhcmUtdG9rZW4tQWJDZEVmMTIzNDU2"
  }'
{
  "provider": {
    "id": "AY+MIBEReqqLuywsLCwsLA==",
    "workspaceId": "AY+MHnorfD2eTxorPE1ebw==",
    "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL",
    "targetPoolId": "AY+MISIifMyN3T09PT09PQ==",
    "capabilities": {
      "stateApi": true,
      "supportsSocks5": true
    },
    "enabled": true,
    "version": "1",
    "createdAt": "2026-06-29T10:15:00Z",
    "updatedAt": "2026-06-29T10:15:00Z"
  }
}