Skip to main content

​
Quickstart

Get started with the Relayer API in just a few steps.

​
Step 1: Get Your API Key

Contact your Relayer administrator to obtain an API key. You’ll need this for all requests.

​
Step 2: Make Your First Request

Let’s start by getting the list of supported metadata types: 
curl -X GET https://api.relayer.fi/v1/metadata/types \
  -H "Authorization: ApiKey your_api_key_here"

​
Step 3: Generate Metadata

Now let’s generate metadata for a swap operation: 
curl -X POST https://api.relayer.fi/v1/metadata/swap \
  -H "Authorization: ApiKey your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "protocol": "lfj",
    "chainName": "avalanche",
    "fromToken": "AVAX",
    "toToken": "JOE",
    "amountIn": 1000000,
    "kolRouterAddress": "0x123abc456def789012345678901234567890abcd",
    "slippageTolerance": 0.5
  }'

​
Next Steps

​
Need Help?