Get client settings

curl --request GET \
  --url https://v1.orchestrator.rhinestone.dev/deposit-processor/setup \
  --header 'x-api-key: <x-api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://v1.orchestrator.rhinestone.dev/deposit-processor/setup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://v1.orchestrator.rhinestone.dev/deposit-processor/setup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://v1.orchestrator.rhinestone.dev/deposit-processor/setup"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://v1.orchestrator.rhinestone.dev/deposit-processor/setup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "hasWebhookSecret": true,
  "maxPriceDeviationBps": 123,
  "maxPriceDeviationBpsIsDefault": true,
  "webhookUrl": "<string>",
  "sponsorship": {},
  "depositWhitelist": {},
  "swapQuoters": {
    "eip155:9745": [
      "0x",
      "fynd"
    ]
  },
  "priceDeviationTokens": {},
  "minDepositUsd": 123,
  "appFees": {
    "feeBps": 5000,
    "tokens": {}
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ],
      "code": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ],
      "code": "<string>"
    }
  ]
}

GET

setup

Get client settings

curl --request GET \
  --url https://v1.orchestrator.rhinestone.dev/deposit-processor/setup \
  --header 'x-api-key: <x-api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://v1.orchestrator.rhinestone.dev/deposit-processor/setup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://v1.orchestrator.rhinestone.dev/deposit-processor/setup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://v1.orchestrator.rhinestone.dev/deposit-processor/setup"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://v1.orchestrator.rhinestone.dev/deposit-processor/setup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "hasWebhookSecret": true,
  "maxPriceDeviationBps": 123,
  "maxPriceDeviationBpsIsDefault": true,
  "webhookUrl": "<string>",
  "sponsorship": {},
  "depositWhitelist": {},
  "swapQuoters": {
    "eip155:9745": [
      "0x",
      "fynd"
    ]
  },
  "priceDeviationTokens": {},
  "minDepositUsd": 123,
  "appFees": {
    "feeBps": 5000,
    "tokens": {}
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ],
      "code": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ],
      "code": "<string>"
    }
  ]
}

Headers

x-api-key

string

required

API key for authentication

Example:

"your-api-key"

Response

Client configuration

hasWebhookSecret

boolean

required

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.

webhookUrl

string

sponsorship

object

Show child attributes

depositWhitelist

object

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

Show child attributes

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.

Show child attributes

Example:

{ "eip155:9745": ["0x", "fynd"] }

priceDeviationTokens

object

Per-source-token price-deviation limits as stored, keyed by CAIP-2 chain and lowercased token address.

Show child attributes

minDepositUsd

number

appFees

object

Show child attributes

Get started

Intents

Deposits

Get client settings

Headers

Response