> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rhinestone.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get client settings

> Returns the stored client configuration for the authenticated project.



## OpenAPI

````yaml https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /setup
openapi: 3.1.0
info:
  title: Deposit Service API
  version: 1.0.0
  description: >-
    Rhinestone Deposits API: accept deposits from any chain, asset or payment
    method, and settle them as one token on one chain.
servers:
  - url: https://v1.orchestrator.rhinestone.dev/deposit-processor
security: []
paths:
  /setup:
    get:
      tags:
        - Clients
      summary: Get client settings
      description: Returns the stored client configuration for the authenticated project.
      parameters:
        - schema:
            type: string
            description: API key for authentication
            example: your-api-key
          required: true
          description: API key for authentication
          name: x-api-key
          in: header
      responses:
        '200':
          description: Client configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSetupResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: API key lacks required deposits scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    GetSetupResponse:
      type: object
      properties:
        webhookUrl:
          type: string
        hasWebhookSecret:
          type: boolean
        sponsorship:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ChainSponsorship'
        depositWhitelist:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
              properties:
                minAmount:
                  type: string
                maxAmount:
                  type: string
          description: >-
            Per-source-chain deposit allowlist keyed by CAIP-2 chain
            identifiers, each mapping allowed tokens to optional raw-unit
            min/max limits.
        swapQuoters:
          allOf:
            - $ref: '#/components/schemas/ProjectSwapQuoters'
            - description: >-
                Swap venues we may request quotes from, keyed by the EVM chain a
                swap is funded from, as stored. Absent means unconstrained
                everywhere.
        maxPriceDeviationBps:
          type: number
        maxPriceDeviationBpsIsDefault:
          type: boolean
          description: >-
            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:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: integer
              minimum: 0
              maximum: 10000
          description: >-
            Per-source-token price-deviation limits as stored, keyed by CAIP-2
            chain and lowercased token address.
        minDepositUsd:
          type: number
        appFees:
          type: object
          properties:
            feeBps:
              type: integer
              minimum: 0
              maximum: 10000
            tokens:
              type: object
              additionalProperties:
                type: object
                additionalProperties:
                  type: integer
                  minimum: 0
                  maximum: 10000
      required:
        - hasWebhookSecret
        - maxPriceDeviationBps
        - maxPriceDeviationBpsIsDefault
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: >-
            Deposit error code (e.g. `TOKEN-3`) when the refusal is one a
            deposit would also receive.
        details:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              code:
                type: string
            required:
              - message
      required:
        - error
    ChainSponsorship:
      type: object
      properties:
        gas:
          type: string
          enum:
            - all
            - none
            - deployed
          description: Gas sponsorship mode
          example: all
        swap:
          type: string
          enum:
            - all
            - none
          description: Fee sponsorship mode
          example: all
        bridging:
          type: string
          enum:
            - all
            - none
          description: Fee sponsorship mode
          example: all
        protocolFee:
          type: string
          enum:
            - all
            - none
          description: Fee sponsorship mode
          example: all
        maxAmountUsd:
          type: number
          exclusiveMinimum: 0
          description: >-
            Largest deposit value in USD this entry sponsors. A deposit valued
            above it, or one that cannot be priced, settles unsponsored: the
            user pays every fee this entry would otherwise cover. Omit to
            sponsor deposits of any value.
          example: 30000
    ProjectSwapQuoters:
      type: object
      additionalProperties:
        type: array
        items:
          type: string
          enum:
            - 1inch
            - 0x
            - velora
            - kyberswap
            - fynd
            - fynd-hosted
            - bebop
            - relay
      description: >-
        List of swap venues we may request quotes from, keyed by the EVM chain
        the swap is FUNDED FROM (CAIP-2, eip155 only). For every EVM deposit
        that is the chain it arrived on; a HyperCore-origin deposit swaps on
        HyperEVM, so key it "eip155:999". A routing preference applied when
        quoting, not a restriction on the account: it does not survive
        compromise of the executor key, and excluding a venue that would have
        priced better costs price. Omit a chain to leave it unconstrained.
        `quoters` applies per intent, so on a cross-chain route the funding
        chain's list bounds the whole route, and an entry for the destination
        chain does not constrain a route funded elsewhere.
      example:
        eip155:9745:
          - 0x
          - fynd

````