Get Config - Relay

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request GET \
  --url https://api.relay.link/config/v2

const options = {method: 'GET'};

fetch('https://api.relay.link/config/v2', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.relay.link/config/v2"

response = requests.get(url)

print(response.text)

Response Codes

• 200
• 500

{
  "enabled": true,
  "user": {
    "balance": "<string>",
    "maxBridgeAmount": "<string>"
  },
  "fee": "<string>",
  "solver": {
    "address": "<string>",
    "balance": "<string>",
    "capacityPerRequest": "<string>"
  },
  "supportsExternalLiquidity": true
}

{
  "message": "<string>",
  "code": "<string>"
}

API Note

This API has been replaced by the Get Quote API, which supports bridging, swapping and calling through a single unified API.

Query Parameters

• originChainId
  string
  required

• destinationChainId
  string
  required

• user
  string
  User address, when supplied returns user balance and max bridge amount

• currency
  enum
  Restricts the user balance and capacity to a particular currency when supplied with a currency id. Defaults to the native currency of the destination chain.

Available options: anime, btc, cgt, dai, degen, eth, omi, pop, tg7, tia, usdc, usdc.e, usdt, sol, weth, apeeth, ape, g7, pengu, plume, plumeusd, gun, somi, synd, xpl, usde, mon, usdh, musd, usdm, pyusd, cash, eusd, pusd, bnb, usdg, usdc.e-cronos

Response

• 200
  application/json

Default Response

• enabled
  boolean

• user
  object
  Showchild attributes

• fee
  string
  Total fee in the native or supplied currency for the bridge operation

• solver
  object
  Showchild attributes

• supportsExternalLiquidity
  boolean
  This denotes if the chain combination supports canonical plus bridging