Get Chains - Relay

GET

chains

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

{
  "chains": [
    {
      "id": 123,
      "name": "<string>",
      "displayName": "<string>",
      "httpRpcUrl": "<string>",
      "wsRpcUrl": "<string>",
      "explorerUrl": "<string>",
      "explorerName": "<string>",
      "explorerPaths": {
        "transaction": "<string>"
      },
      "depositEnabled": true,
      "tokenSupport": "All",
      "disabled": true,
      "partialDisableLimit": 123,
      "blockProductionLagging": true,
      "currency": {
        "id": "<string>",
        "symbol": "<string>",
        "name": "<string>",
        "address": "<string>",
        "decimals": 123,
        "supportsBridging": true
      },
      "withdrawalFee": 123,
      "depositFee": 123,
      "surgeEnabled": true,
      "featuredTokens": [
        {
          "id": "<string>",
          "symbol": "<string>",
          "name": "<string>",
          "address": "<string>",
          "decimals": 123,
          "supportsBridging": true,
          "supportsPermit": true,
          "withdrawalFee": 123,
          "depositFee": 123,
          "surgeEnabled": true
        }
      ],
      "erc20Currencies": [
        {
          "id": "<string>",
          "symbol": "<string>",
          "name": "<string>",
          "address": "<string>",
          "decimals": 123,
          "supportsBridging": true,
          "supportsPermit": true,
          "withdrawalFee": 123,
          "depositFee": 123,
          "surgeEnabled": true
        }
      ],
      "iconUrl": "<string>",
      "logoUrl": "<string>",
      "brandColor": "<string>",
      "contracts": {
        "multicall3": "<string>",
        "multicaller": "<string>",
        "onlyOwnerMulticaller": "<string>",
        "relayReceiver": "<string>",
        "erc20Router": "<string>",
        "approvalProxy": "<string>"
      },
      "vmType": "bvm",
      "explorerQueryParams": {},
      "baseChainId": 123,
      "statusMessage": "<string>",
      "tags": [
        "<string>"
      ]
    }
  ]
}

Query Parameters

includeChains

string | null

Response

200 - application/json

Default Response

chains

object[]

An array of supported chains

chains.id

number

chains.name

string

chains.displayName

string

chains.httpRpcUrl

string

chains.wsRpcUrl

string

chains.explorerUrl

string

chains.explorerName

string

chains.explorerPaths

object | null

chains.depositEnabled

boolean

If the network supports depositing to this chain, e.g. allows this chain to be set as the destination chain

chains.tokenSupport

enum<string>

Available options:

All,

Limited

chains.disabled

boolean

If relaying to and from this chain is disabled

chains.partialDisableLimit

number

The value limit at which the chain is partially disabled, if 0, the chain is not partially disabled. i.e, 1000000000000000000 to designate 1 ETH max withdrawal/deposit

chains.blockProductionLagging

boolean

If the chain is experiencing issues where blocks are lagging behind or not being produced

chains.currency

object

chains.withdrawalFee

number

The fee in bps for withdrawing from this chain

chains.depositFee

number

The fee in bps for depositing to this chain

chains.surgeEnabled

boolean

If the chain has surge pricing enabled

chains.featuredTokens

object[]

An array of featured erc20 currencies

chains.erc20Currencies

object[]

An array of erc20 currencies that the chain supports

chains.iconUrl

string | null

The URL to the chain icon

chains.logoUrl

string | null

The URL to the chain logo

chains.brandColor

string | null

Brand color code

chains.contracts

object

Relay contract addresses

chains.vmType

enum<string>

The type of VM the chain runs on

Available options:

bvm,

evm,

svm

chains.explorerQueryParams

object | null

chains.baseChainId

number | null

The chain id which the chain rolls up to. This is always set as Ethereum for L1 chains

chains.statusMessage

string | null

If applicable, a status message for the chain

chains.tags

string[]

Handling Errors Get Execution Status

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

{
  "chains": [
    {
      "id": 123,
      "name": "<string>",
      "displayName": "<string>",
      "httpRpcUrl": "<string>",
      "wsRpcUrl": "<string>",
      "explorerUrl": "<string>",
      "explorerName": "<string>",
      "explorerPaths": {
        "transaction": "<string>"
      },
      "depositEnabled": true,
      "tokenSupport": "All",
      "disabled": true,
      "partialDisableLimit": 123,
      "blockProductionLagging": true,
      "currency": {
        "id": "<string>",
        "symbol": "<string>",
        "name": "<string>",
        "address": "<string>",
        "decimals": 123,
        "supportsBridging": true
      },
      "withdrawalFee": 123,
      "depositFee": 123,
      "surgeEnabled": true,
      "featuredTokens": [
        {
          "id": "<string>",
          "symbol": "<string>",
          "name": "<string>",
          "address": "<string>",
          "decimals": 123,
          "supportsBridging": true,
          "supportsPermit": true,
          "withdrawalFee": 123,
          "depositFee": 123,
          "surgeEnabled": true
        }
      ],
      "erc20Currencies": [
        {
          "id": "<string>",
          "symbol": "<string>",
          "name": "<string>",
          "address": "<string>",
          "decimals": 123,
          "supportsBridging": true,
          "supportsPermit": true,
          "withdrawalFee": 123,
          "depositFee": 123,
          "surgeEnabled": true
        }
      ],
      "iconUrl": "<string>",
      "logoUrl": "<string>",
      "brandColor": "<string>",
      "contracts": {
        "multicall3": "<string>",
        "multicaller": "<string>",
        "onlyOwnerMulticaller": "<string>",
        "relayReceiver": "<string>",
        "erc20Router": "<string>",
        "approvalProxy": "<string>"
      },
      "vmType": "bvm",
      "explorerQueryParams": {},
      "baseChainId": 123,
      "statusMessage": "<string>",
      "tags": [
        "<string>"
      ]
    }
  ]
}

API Reference

Query Parameters

Response