Relay

https://docs.relay.link/references/
Admin
Relay is an API platform that enables instant bridging, cross-chain execution, and gasless...
Tokens:271,196
Snippets:1,593
Trust Score:8.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### JavaScript example: connect, subscribe, and handle messages

Source: https://docs.relay.link/references/api/api_guides/websockets

Complete JavaScript example: install the ws package, connect to the Relay websocket, wait for the ready message, then subscribe to request.status.updated. Includes commented-out unsubscribe code.

```bash
npm install ws

```

```javascript
const ws = require("ws");

const YOUR_API_KEY = "";

const wss = new ws(`wss://ws.relay.link?apiKey=${YOUR_API_KEY}`);

wss.on("open", function open() {
  console.log("Connected to Relay");

  wss.on("message", function incoming(data) {
    console.log("Message received: ", JSON.stringify(JSON.parse(data)));

    // When the connection is ready, subscribe to the top-bids event
    if (JSON.parse(data).status === "ready") {
      console.log("Subscribing");
      wss.send(
        JSON.stringify({
          type: "subscribe",
          event: "request.status.updated",
          filters: {
            id: "0xae0827617d4ae75b406969971c2d4df9a8e8d819ff0f09581fb45ca123fcc7a0",
          },
        })
      );

      // To unsubscribe, send the following message
      // wss.send(
      //     JSON.stringify({
      //         type: 'unsubscribe',
      //         event: 'request.status.updated',
      //     }),
      // );
    }
  });
});

```

--------------------------------

### Python requests GET /swap-sources

Source: https://docs.relay.link/references/api/get-swap-sources

Python example using the requests library to GET the swap-sources endpoint and print the response text.

```python
import requests

url = "https://api.relay.link/swap-sources"

response = requests.get(url)

print(response.text)
```

--------------------------------

### JavaScript Example

Source: https://docs.relay.link/references/api/api_guides/websockets

Complete JavaScript example for connecting, subscribing, and handling messages.

```APIDOC
## JavaScript Example

### Description
A complete example of connecting to the Relay websocket, subscribing to status updates, and handling messages.

### Prerequisites
- Install the `ws` package: `npm install ws`

### Code Example
```javascript
const ws = require("ws");

const YOUR_API_KEY = "";

const wss = new ws(`wss://ws.relay.link?apiKey=${YOUR_API_KEY}`);

wss.on("open", function open() {
  console.log("Connected to Relay");

  wss.on("message", function incoming(data) {
    console.log("Message received: ", JSON.stringify(JSON.parse(data)));

    // When the connection is ready, subscribe to the top-bids event
    if (JSON.parse(data).status === "ready") {
      console.log("Subscribing");
      wss.send(
        JSON.stringify({
          type: "subscribe",
          event: "request.status.updated",
          filters: {
            id: "0xae0827617d4ae75b406969971c2d4df9a8e8d819ff0f09581fb45ca123fcc7a0",
          },
        })
      );

      // To unsubscribe, send the following message
      // wss.send(
      //     JSON.stringify({
      //         type: 'unsubscribe',
      //         event: 'request.status.updated',
      //     }),
      // );
    }
  });
});
```
```

--------------------------------

### JavaScript fetch GET /swap-sources

Source: https://docs.relay.link/references/api/get-swap-sources

JavaScript example using fetch to call the swap-sources endpoint and log the response. Handles errors with catch.

```javascript
const options = {method: 'GET'};

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

--------------------------------

### Install Relay SDK and viem with bun

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and its peer dependency viem using bun.

```bash
bun add @relayprotocol/relay-sdk viem 

```

--------------------------------

### Example 200 response for GET /requests/v2

Source: https://docs.relay.link/references/api/get-requests-v2

Example JSON response returned by the GET /requests/v2 endpoint. It includes request details, fees, transactions, and deprecation information.

```json
{
  "requests": {
    "id": "0xddd6c1a0340e940b7be4f5a4be076df8b7ec7de7b18f9ec6efe4bfffd2f21cf6",
    "status": "success",
    "user": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
    "recipient": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
    "depositAddress": {
      "address": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
      "depositAddressType": "open",
      "depositor": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
      "depositTxHash": "0x34d78ccb41099f0546be1c35541b28ab4c92b498aeb4cae6e849c51c05fe1f1b"
    },
    "data": {
      "subsidizedRequest": false,
      "fees": {
        "gas": "2622672522398",
        "fixed": "10000000000000",
        "price": "39000000000000"
      },
      "feesUsd": {
        "gas": "9057",
        "fixed": "34534",
        "price": "134684"
      },
      "inTxs": [
        {
          "fee": "423218878900",
          "data": {
            "to": "0xf70da97812cb96acdf810712aa562db8dfa3dbef",
            "data": "0x5869d8",
            "from": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
            "value": "2651622672522398"
          },
          "hash": "0xe53021eaa63d100b08338197d26953e2219bcbad828267dd936c549ff643aad7",
          "type": "onchain",
          "chainId": 7777777,
          "timestamp": 1713290377
        }
      ],
      "currency": "eth",
      "price": "2600000000000000",
      "usesExternalLiquidity": false,
      "outTxs": [
        {
          "fee": "1837343366480",
          "data": {
            "to": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
            "data": "0x5869d8",
            "from": "0xf70da97812cb96acdf810712aa562db8dfa3dbef",
            "value": "2600000000000000"
          },
          "hash": "0x9da7bc54dfe6229d6980fd62250d472f23dfe0f41a1cdc870c81a08b3445f254",
          "type": "onchain",
          "chainId": 8453,
          "timestamp": 1713290383
        }
      ]
    },
    "moonpayId": "9dc342c3-538b-4731-aba7-13ed89acc7ae",
    "createdAt": "2024-04-16T17:59:39.702Z",
    "updatedAt": "2024-04-16T17:59:46.145Z"
  },
  "continuation": "<string>",
  "deprecation": {
    "message": "<string>",
    "deprecatedAt": "<string>",
    "throttledFrom": "<string>",
    "sunsetAt": "<string>",
    "successor": "<string>",
    "migrationGuide": "<string>"
  }
}
```

--------------------------------

### cURL request to get token price

Source: https://docs.relay.link/references/api/get-token-price

Example cURL command to call the GET /currencies/token/price endpoint. Returns the token price in USD.

```bash
curl --request GET \
  --url https://api.relay.link/currencies/token/price
```

--------------------------------

### Example: All Tokens Supported

Source: https://docs.relay.link/references/api/api_resources/supported-routes

Example response showing a chain with tokenSupport set to "All". Routes involving this chain are supported for tokens where Solver or DEX liquidity is available.

```json
{
  "chains": [
        {
            "id": 10,
            "name": "optimism",
            "displayName": "Optimism",
            "tokenSupport": "All",
            "currency": {
                "id": "eth",
                "symbol": "ETH",
                "name": "Ether",
                "address": "0x0000000000000000000000000000000000000000",
                "decimals": 18,
                "supportsBridging": true
            },
            "erc20Currencies": [
                {
                    "id": "wbtc",
                    "symbol": "WBTC",
                    "name": "Wrapped BTC",
                    "address": "0x68f180fcce6836688e9084f035309e29bf0a2095",
                    "decimals": 8,
                    "supportsBridging": false,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                },
                {
                    "id": "usdt",
                    "symbol": "USDT",
                    "name": "Tether USD",
                    "address": "0x94b008aa00579c1307b0ef2c499ad98a8ce58e58",
                    "decimals": 6,
                    "supportsBridging": true,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                },
                {
                    "id": "dai",
                    "symbol": "DAI",
                    "name": "Dai Stablecoin",
                    "address": "0xda10009cbd5d07dd0cecc66161fc93d7c9000da1",
                    "decimals": 18,
                    "supportsBridging": false,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                },
                {
                    "id": "usdc",
                    "symbol": "USDC",
                    "name": "USD Coin",
                    "address": "0x0b2c639c533813f4aa9d7837caf62653d097ff85",
                    "decimals": 6,
                    "supportsBridging": true,
                    "supportsPermit": true,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                }
            ]
        }
  ]
}
```

--------------------------------

### Install Relay SDK and viem with npm

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and its peer dependency viem using npm.

```bash
npm install --save @relayprotocol/relay-sdk viem 

```

--------------------------------

### 400 error response example for token price

Source: https://docs.relay.link/references/api/get-token-price

Example of an error response (HTTP 400) from the GET /currencies/token/price endpoint, containing an error message.

```json
{
  "error": "<string>"
}
```

--------------------------------

### Install Relay SDK and viem with yarn

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and its peer dependency viem using yarn.

```bash
yarn add @relayprotocol/relay-sdk viem 

```

--------------------------------

### 200 response example for token price

Source: https://docs.relay.link/references/api/get-token-price

Example of a successful response (HTTP 200) from the GET /currencies/token/price endpoint, containing the token price in USD.

```json
{
  "price": 123
}
```

--------------------------------

### Install Relay Kit UI with bun

Source: https://docs.relay.link/references/relay-kit/ui/installation

Install the required packages using bun: viem, wagmi, @tanstack/react-query, and @relayprotocol/relay-kit-ui.

```bash
bun add viem wagmi @tanstack/react-query @relayprotocol/relay-kit-ui 

```

--------------------------------

### cURL request to get usage metrics

Source: https://docs.relay.link/references/api/get-usage

Sends a GET request to the usage metrics endpoint with hourly granularity. Requires an x-api-key header (not shown in the example).

```bash
curl --request GET \
  --url 'https://api.relay.link/metrics/usage?granularity=hourly'
```

--------------------------------

### Install Relay SDK and viem with pnpm

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and its peer dependency viem using pnpm.

```bash
pnpm add @relayprotocol/relay-sdk viem 

```

--------------------------------

### Python requests request to get token price

Source: https://docs.relay.link/references/api/get-token-price

Example using the requests library in Python to call the GET /currencies/token/price endpoint. Prints the response text.

```python
import requests

url = "https://api.relay.link/currencies/token/price"

response = requests.get(url)

print(response.text)
```

--------------------------------

### Install Relay SDK and Lighter wallet adapter

Source: https://docs.relay.link/references/api/api_guides/lighter-support

Install the required packages to use the SDK with Lighter. This command adds the Relay SDK, the Lighter wallet adapter, and viem.

```bash
yarn add @relayprotocol/relay-lighter-wallet-adapter @relayprotocol/relay-sdk viem

```

--------------------------------

### cURL request to GET /config/v2

Source: https://docs.relay.link/references/api/get-config

Example cURL command to fetch the configuration from the Relay Link API. Uses the GET method with the URL https://api.relay.link/config/v2.

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

--------------------------------

### Install Lighter SDK for adapter bootstrap

Source: https://docs.relay.link/references/api/api_guides/lighter-support

Install the Lighter SDK if you want the adapter to run its own bootstrap (fresh keygen, accountApiKey, or storage paths).

```bash
yarn add @relay-protocol/lighter-ts-sdk

```

--------------------------------

### JavaScript fetch request to get token price

Source: https://docs.relay.link/references/api/get-token-price

Example using the fetch API in JavaScript to call the GET /currencies/token/price endpoint. Logs the JSON response to the console.

```javascript
const options = {method: 'GET'};

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

--------------------------------

### Install with npm

Source: https://docs.relay.link/references/relay-kit/hooks/installation

Install the required packages using npm. The command adds react, react-dom, viem, @tanstack/react-query, and @relayprotocol/relay-kit-hooks.

```bash
npm install --save react react-dom viem @tanstack/react-query @relayprotocol/relay-kit-hooks

```

--------------------------------

### JavaScript fetch request to get withdrawal status

Source: https://docs.relay.link/references/api/get-withdrawal-status

Use this JavaScript fetch example to call the withdrawal status endpoint. It sends a GET request and logs the JSON response.

```javascript
const options = {method: 'GET'};

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

--------------------------------

### Install with bun

Source: https://docs.relay.link/references/relay-kit/hooks/installation

Install the required packages using bun. The command adds react, react-dom, viem, @tanstack/react-query, and @relayprotocol/relay-kit-hooks.

```bash
bun add react react-dom viem @tanstack/react-query @relayprotocol/relay-kit-hooks

```

--------------------------------

### Python requests request to get withdrawal status

Source: https://docs.relay.link/references/api/get-withdrawal-status

Use this Python example to call the withdrawal status endpoint using the requests library. It sends a GET request and prints the response text.

```python
import requests

url = "https://api.relay.link/withdrawals/status"

response = requests.get(url)

print(response.text)
```

--------------------------------

### Install Relay Kit UI with yarn

Source: https://docs.relay.link/references/relay-kit/ui/installation

Install the required packages using yarn: viem, wagmi, @tanstack/react-query, and @relayprotocol/relay-kit-ui.

```bash
yarn add viem wagmi @tanstack/react-query @relayprotocol/relay-kit-ui 

```

--------------------------------

### Python requests request to GET /config/v2

Source: https://docs.relay.link/references/api/get-config

Example Python code using the requests library to make a GET request to the Relay Link API config endpoint and print the response text.

```python
import requests

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

response = requests.get(url)

print(response.text)
```

--------------------------------

### Example response for Get Quote V2 API

Source: https://docs.relay.link/references/api/get-quote-v2

Example JSON response showing the structure of the steps array for a bridge or swap quote. The example includes a transaction step with details such as from, to, data, value, gas fees, and chainId, along with a status check endpoint.

```json
[
  {
    "id": "deposit",
    "action": "Confirm transaction in your wallet",
    "description": "Depositing funds to the relayer to execute the swap for USDC",
    "kind": "transaction",
    "requestId": "0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
    "items": [
      {
        "status": "incomplete",
        "data": {
          "from": "0x0CccD55A5Ac261Ea29136831eeaA93bfE07f5Db6",
          "to": "0xf70da97812cb96acdf810712aa562db8dfa3dbef",
          "data": "0x00fad611",
          "value": "1000000000000000000",
          "maxFeePerGas": "12205661344",
          "maxPriorityFeePerGas": "2037863396",
          "chainId": 1
        },
        "check": {
          "endpoint": "/intents/status?requestId=0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
          "method": "GET"
        }
      }
    ]
  }
]
```

--------------------------------

### Install Relay Kit UI with npm

Source: https://docs.relay.link/references/relay-kit/ui/installation

Install the required packages using npm: viem, wagmi, @tanstack/react-query, and @relayprotocol/relay-kit-ui.

```bash
npm install viem wagmi @tanstack/react-query @relayprotocol/relay-kit-ui 

```
Tokens:
Raw