---
title: "Get client settings"
method: GET
path: "/setup"
tags: ["Clients"]
---

# Get client settings

`GET /setup`

## Request

- Base URL: `https://v1.orchestrator.rhinestone.dev/deposit-processor`
- URL: `https://v1.orchestrator.rhinestone.dev/deposit-processor/setup`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/rhinestonewtf/apis/deposit-service-api/docs/setup/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the stored client configuration for the authenticated project.

## Headers

- `x-api-key` string: API key for authentication

## Response `200`

Client configuration

- GetSetupResponse
  - `webhookUrl` string
  - `hasWebhookSecret` boolean, required
  - `sponsorship` object
  - `depositWhitelist` object: Per-source-chain deposit allowlist keyed by CAIP-2 chain identifiers, each mapping allowed tokens to optional raw-unit min/max limits.
  - `swapQuoters` object: Swap venues we may request quotes from, keyed by the EVM chain a swap is funded from, as stored. Absent means unconstrained everywhere.
  - `maxPriceDeviationBps` number, required
  - `maxPriceDeviationBpsIsDefault` boolean, required: True when the project stores no maxPriceDeviationBps, so the value above is the platform default and follows it if it changes. Send maxPriceDeviationBps: null to return to it.
  - `priceDeviationTokens` object: Per-source-token price-deviation limits as stored, keyed by CAIP-2 chain and lowercased token address.
  - `minDepositUsd` number
  - `appFees` object
    - `feeBps` integer
    - `tokens` object

## Other responses

- `401`: Authentication required
- `403`: API key lacks required deposits scope
- `503`: Tenant billing verification is temporarily unavailable; retry after 5 seconds.

## Changes

- **2026-11-06** `aa1767d704fa`: 4 info
  - the endpoint scheme security `internalProjectBearer` was added to the API
  - the endpoint scheme security `tenantApiKey` was added to the API
  - the `header` request parameter `x-api-key` became optional
  - added the non-success response with the status `503`
- **2026-09-22** `3de34c8c7e9f`: 1 info
  - added the required property `maxPriceDeviationBpsIsDefault` to the response with the `200` status
- **2026-09-22** `5bfd3ae2eab9`: 1 info
  - added the optional property `priceDeviationTokens` to the response with the `200` status
- **2026-09-17** `676300ac19ff`: 3 info
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `403` status
  - added the optional property `sponsorship/additionalProperties/maxAmountUsd` to the response with the `200` status
- **2026-09-11** `b49146029e5a`: 1 breaking, 1 warning, 1 info
  - the `header` request parameter `x-api-key` became required
  - deleted the `header` request parameter `authorization`
  - added the optional property `swapQuoters` to the response with the `200` status

[Operation history](https://skmtc.dev/rhinestonewtf/apis/deposit-service-api/changes/setup/get.md)

---

[API](https://skmtc.dev/rhinestonewtf/apis/deposit-service-api.md) - [All operations](https://skmtc.dev/rhinestonewtf/apis/deposit-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rhinestonewtf/apis/deposit-service-api/revisions/aa1767d704fa?raw)