v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-013469188.5 KB
Clients

Read client settings

Returns the stored client configuration — webhook URL/secret, sponsorship rules, source-token whitelist, and price-deviation guard — for the authenticated project.

get/setup

Headers

x-api-keystring

API key for authentication (omit when sending Authorization)

Example:your-api-key

API key for authentication (omit when sending Authorization)

authorizationstring

Bearer platform token (e.g. forwarded by user-service). Takes precedence over x-api-key when both are present.

Example:Bearer eyJhbGciOi...

Bearer platform token (e.g. forwarded by user-service). Takes precedence over x-api-key when both are present.

Response

Client configuration

webhookUrlstring
hasWebhookSecretboolean required
sponsorshipobject
depositWhitelistobject

Per-source-chain deposit allowlist keyed by CAIP-2 chain identifiers, each mapping allowed tokens to optional raw-unit min/max limits.

maxPriceDeviationBpsnumber required
minDepositUsdnumber