Settings

SDK Reference · Resource

Settings

Read gateway addresses, usage totals, and account-wide configuration.

get()

method

get()

Get account settings

Returns proxy gateway addresses, account usage totals, referral thresholds, and supported crypto currencies for the authenticated account.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.settings.get(options: SettingsGetOptions = {}): Promise<SettingsGetResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.settings.get();

Returns

SettingsResponse

The operation completed successfully.

typeSettingsResponse10fields

FieldTypeRequirementDescription

gateways

SettingsGateway[]

Required

—

typeSettingsGateway9fields

FieldTypeRequirementDescription

id

string

Required

—

name

string

Required

—

region

string

Required

—

hostname

string

Required

Cluster gateway domain, or a server IP when no domain is configured.

hostnames

string[]

Required

The cluster domain, or unique server IPs when no domain is configured.

port_http

number

Required

—

port_socks5

number

Required

—

port_auto

number

Required

—

port_haproxy

number

Required

—

spent_total

number

Required

—

orders_total

number

Required

—

orders_active

number

Required

—

data_available

number

Required

—

data_spent

number

Required

—

referrals

SettingsReferral

Required

—

typeSettingsReferral4fields

FieldTypeRequirementDescription

reward_balance_percentage

number

Required

—

reward_data_percentage

number

Required

—

reward_min_balance

number

Required

—

reward_min_data

number

Required

—

crypto

SettingsCrypto

Required

—

typeSettingsCrypto1field

FieldTypeRequirementDescription

currencies

string[]

Required

—

payment_methods

string[]

Required

—

payment_gateways

PaymentGateway[]

Required

—

typePaymentGateway6fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

kind

string

Required

—

supported_currencies

string[]

Required

—

supported_crypto_currencies

string[]

Required

—

requires_crypto_currency

boolean

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "server"ProxyRequest could not complete the operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.settings.getWithResponse(options): Promise<ApiResponse<SettingsGetResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.settings.get(*, accept_language: str | Unset=UNSET) -> SettingsResponse

Asyncawait async_client.settings.get(*, accept_language: str | Unset=UNSET) -> SettingsResponse

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.settings.get()

Async example

result = await async_client.settings.get()

Returns

SettingsResponse

The operation completed successfully.

classSettingsResponse10fields

FieldTypeRequirementDescription

gateways

list[SettingsGateway]

Required

—

classSettingsGateway9fields

FieldTypeRequirementDescription

id

UUID

Required

—

name

str

Required

—

region

str

Required

—

hostname

str

Required

Cluster gateway domain, or a server IP when no domain is configured.

hostnames

list[str]

Required

The cluster domain, or unique server IPs when no domain is configured.

port_http

int

Required

—

port_socks5

int

Required

—

port_auto

int

Required

—

port_haproxy

int

Required

—

spent_total

float

Required

—

orders_total

int

Required

—

orders_active

int

Required

—

data_available

int

Required

—

data_spent

int

Required

—

referrals

SettingsReferral

Required

—

classSettingsReferral4fields

FieldTypeRequirementDescription

reward_balance_percentage

float

Required

—

reward_data_percentage

float

Required

—

reward_min_balance

float

Required

—

reward_min_data

float

Required

—

crypto

SettingsCrypto

Required

—

classSettingsCrypto1field

FieldTypeRequirementDescription

currencies

list[str]

Required

—

payment_methods

list[str]

Required

—

payment_gateways

list[PaymentGateway]

Required

—

classPaymentGateway6fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

kind

str

Required

—

supported_currencies

list[str]

Required

—

supported_crypto_currencies

list[str]

Required

—

requires_crypto_currency

bool

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.SERVERProxyRequest could not complete the operation.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.settings.get_with_response(*, accept_language: str | Unset=UNSET) -> ApiResponse[SettingsResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->settings()->get($acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->settings()->get();

Returns

SettingsResponse

The operation completed successfully.

classSettingsResponse10fields

FieldTypeRequirementDescription

gateways

[SettingsGateway[]](SettingsGateway.md)

Required

|

classSettingsGateway9fields

FieldTypeRequirementDescription

id

string

Required

|

name

string

Required

|

region

string

Required

|

hostname

string

Required

Cluster gateway domain, or a server IP when no domain is configured. |

hostnames

array<string>

Required

The cluster domain, or unique server IPs when no domain is configured. |

portHttp

int

Required

|

portSocks5

int

Required

|

portAuto

int

Required

|

portHaproxy

int

Required

|

spentTotal

float

Required

|

ordersTotal

int

Required

|

ordersActive

int

Required

|

dataAvailable

int

Required

|

dataSpent

int

Required

|

referrals

SettingsReferral

Required

|

classSettingsReferral4fields

FieldTypeRequirementDescription

rewardBalancePercentage

float

Required

|

rewardDataPercentage

float

Required

|

rewardMinBalance

float

Required

|

rewardMinData

float

Required

|

crypto

SettingsCrypto

Required

|

classSettingsCrypto1field

FieldTypeRequirementDescription

currencies

array<string>

Required

|

paymentMethods

array<string>

Required

|

paymentGateways

[PaymentGateway[]](PaymentGateway.md)

Required

|

classPaymentGateway6fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

kind

string

Required

|

supportedCurrencies

array<string>

Required

|

supportedCryptoCurrencies

array<string>

Required

|

requiresCryptoCurrency

bool

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ServerProxyRequest could not complete the operation.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->settings()->getWithResponse($acceptLanguage = null, string $contentType = self::contentTypes['get'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->settings()->getWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns the OpenAPI Generator response tuple.

• $client->settings()->getAsync($acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns a Guzzle promise for the decoded result.

• $client->settings()->getAsyncWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns a Guzzle promise for the response tuple.

• $client->settings()->getRequest($acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Builds the PSR-7 request without sending it.