Get Requests

GET

requests

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

{
  "requests": {
    "id": "0xddd6c1a0340e940b7be4f5a4be076df8b7ec7de7b18f9ec6efe4bfffd2f21cf6",
    "status": "success",
    "user": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
    "recipient": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
    "data": {
      "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>"
}

Query Parameters

limit

string

default:20

continuation

string

user

string

hash

string

originChainId

string

destinationChainId

string

privateChainsToInclude

string

startTimestamp

number

endTimestamp

number

startBlock

number

endBlock

number

chainId

string

Get all requests for a single chain in either direction. Setting originChainId and/or destinationChainId will override this parameter.

referrer

string

sortBy

enum<string>

default:createdAt

Available options:

createdAt,

updatedAt

sortDirection

enum<string>

Available options:

asc,

desc

Response

200 - application/json

Default Response

requests

object[]

requests.id

string

requests.status

enum<string>

Note that fallback is returned in the case of a refund

Available options:

refund,

delayed,

waiting,

failure,

pending,

success

requests.user

string

requests.recipient

string

requests.data

object

requests.data.slippageTolerance

string

Slippage tolerance for the swap. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage

requests.data.failReason

enum<string>

Available options:

UNKNOWN,

AMOUNT_TOO_LOW_TO_REFUND,

DEPOSIT_ADDRESS_MISMATCH,

DEPOSIT_CHAIN_MISMATCH,

SLIPPAGE,

INCORRECT_DEPOSIT_CURRENCY,

DOUBLE_SPEND,

SOLVER_CAPACITY_EXCEEDED,

DEPOSITED_AMOUNT_TOO_LOW_TO_FILL,

NEGATIVE_NEW_AMOUNT_AFTER_FEES,

NO_QUOTES,

MISSING_REVERT_DATA,

REVERSE_SWAP_FAILED,

GENERATE_SWAP_FAILED,

TOO_LITTLE_RECEIVED,

EXECUTION_REVERTED,

NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE,

TRANSACTION_REVERTED,

N/A

requests.data.fees

object

requests.data.feesUsd

object

requests.data.inTxs

object[]

requests.data.currency

string

requests.data.currencyObject

object

requests.data.feeCurrency

string

requests.data.feeCurrencyObject

object

requests.data.refundCurrencyData

object

Example:

{
  "currency": {
    "chainId": 8453,
    "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "metadata": {
      "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
      "verified": false,
      "isNative": false
    }
  },
  "amount": "30754920",
  "amountFormatted": "30.75492",
  "amountUsd": "30.901612",
  "minimumAmount": "30454920"
}

requests.data.appFees

object[]

requests.data.metadata

object

requests.data.metadata.sender

string

requests.data.metadata.recipient

string

requests.data.metadata.currencyIn

object

Example:

{
  "currency": {
    "chainId": 8453,
    "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "metadata": {
      "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
      "verified": false,
      "isNative": false
    }
  },
  "amount": "30754920",
  "amountFormatted": "30.75492",
  "amountUsd": "30.901612",
  "amountUsdCurrent": "30.901612",
  "minimumAmount": "30454920"
}

requests.data.metadata.currencyOut

object

Example:

{
  "currency": {
    "chainId": 8453,
    "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "metadata": {
      "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
      "verified": false,
      "isNative": false
    }
  },
  "amount": "30754920",
  "amountFormatted": "30.75492",
  "amountUsd": "30.901612",
  "amountUsdCurrent": "30.901612",
  "minimumAmount": "30454920"
}

requests.data.metadata.currencyGasTopup

object

Example:

{
  "currency": {
    "chainId": 8453,
    "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "metadata": {
      "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
      "verified": false,
      "isNative": false
    }
  },
  "amount": "30754920",
  "amountFormatted": "30.75492",
  "amountUsd": "30.901612",
  "minimumAmount": "30454920"
}

requests.data.metadata.rate

string

requests.data.price

string

requests.data.usesExternalLiquidity

boolean

requests.data.timeEstimate

number

requests.data.outTxs

object[]

requests.referrer

string

requests.moonpayId

string

requests.createdAt

string

requests.updatedAt

string

Example:

{
  "id": "0xddd6c1a0340e940b7be4f5a4be076df8b7ec7de7b18f9ec6efe4bfffd2f21cf6",
  "status": "success",
  "user": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
  "recipient": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
  "data": {
    "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

Get Execution Status Get Token Price

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

{
  "requests": {
    "id": "0xddd6c1a0340e940b7be4f5a4be076df8b7ec7de7b18f9ec6efe4bfffd2f21cf6",
    "status": "success",
    "user": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
    "recipient": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
    "data": {
      "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>"
}

API Reference

Query Parameters

Response