cURL
curl -X POST https://api.relayer.fi/v1/action/builders/swap \
-H "Authorization: ApiKey $RELAYER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tokenIn": "0xA0b86a33...",
"tokenOut": "0xC02aaA39...",
"chain": "base",
"title": "Swap USDC → WETH"
}'const response = await fetch("https://api.relayer.fi/v1/action/builders/swap", {
method: "POST",
headers: {
Authorization: `ApiKey ${process.env.RELAYER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
tokenIn: "0xA0b86a33...",
tokenOut: "0xC02aaA39...",
chain: "base",
title: "Swap USDC → WETH",
}),
});
const { data } = await response.json();
// data — canonical swap widget metadata. Use the widget metadata URL
// in your frontend's <Widget url=... /> component.import requests
url = "https://testnet.relayer.fi/v1/action/builders/swap"
payload = {
"protocol": "lfj",
"chainName": "avalanche",
"fromToken": "AVAX",
"toToken": "JOE",
"routerAddress": "0xb00D916688FEE4aB6646994104E1441446947fc9",
"slippageTolerance": 0.5
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'lfj',
chainName: 'avalanche',
fromToken: 'AVAX',
toToken: 'JOE',
routerAddress: '0xb00D916688FEE4aB6646994104E1441446947fc9',
slippageTolerance: 0.5
})
};
fetch('https://testnet.relayer.fi/v1/action/builders/swap', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://testnet.relayer.fi/v1/action/builders/swap",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'protocol' => 'lfj',
'chainName' => 'avalanche',
'fromToken' => 'AVAX',
'toToken' => 'JOE',
'routerAddress' => '0xb00D916688FEE4aB6646994104E1441446947fc9',
'slippageTolerance' => 0.5
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://testnet.relayer.fi/v1/action/builders/swap"
payload := strings.NewReader("{\n \"protocol\": \"lfj\",\n \"chainName\": \"avalanche\",\n \"fromToken\": \"AVAX\",\n \"toToken\": \"JOE\",\n \"routerAddress\": \"0xb00D916688FEE4aB6646994104E1441446947fc9\",\n \"slippageTolerance\": 0.5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://testnet.relayer.fi/v1/action/builders/swap")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"lfj\",\n \"chainName\": \"avalanche\",\n \"fromToken\": \"AVAX\",\n \"toToken\": \"JOE\",\n \"routerAddress\": \"0xb00D916688FEE4aB6646994104E1441446947fc9\",\n \"slippageTolerance\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://testnet.relayer.fi/v1/action/builders/swap")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"protocol\": \"lfj\",\n \"chainName\": \"avalanche\",\n \"fromToken\": \"AVAX\",\n \"toToken\": \"JOE\",\n \"routerAddress\": \"0xb00D916688FEE4aB6646994104E1441446947fc9\",\n \"slippageTolerance\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"metadata": {}
}{
"statusCode": 400,
"message": [
"<string>"
],
"error": "Bad Request"
}{
"success": true,
"message": "<string>",
"statusCode": 123,
"timestamp": "<string>",
"data": {},
"path": "<string>",
"traceId": "<string>"
}{
"success": true,
"message": "<string>",
"statusCode": 123,
"timestamp": "<string>",
"data": {},
"path": "<string>",
"traceId": "<string>"
}{
"success": true,
"message": "<string>",
"statusCode": 123,
"timestamp": "<string>",
"data": {},
"path": "<string>",
"traceId": "<string>"
}Widget Actions
Generate metadata for Swap application
Creates metadata configuration for a token swap application. Currently supports LFJ and Pangolin protocols. The generated metadata can be used to create widgets for token swaps on supported blockchain networks.
POST
/
action
/
builders
/
swap
cURL
curl -X POST https://api.relayer.fi/v1/action/builders/swap \
-H "Authorization: ApiKey $RELAYER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tokenIn": "0xA0b86a33...",
"tokenOut": "0xC02aaA39...",
"chain": "base",
"title": "Swap USDC → WETH"
}'const response = await fetch("https://api.relayer.fi/v1/action/builders/swap", {
method: "POST",
headers: {
Authorization: `ApiKey ${process.env.RELAYER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
tokenIn: "0xA0b86a33...",
tokenOut: "0xC02aaA39...",
chain: "base",
title: "Swap USDC → WETH",
}),
});
const { data } = await response.json();
// data — canonical swap widget metadata. Use the widget metadata URL
// in your frontend's <Widget url=... /> component.import requests
url = "https://testnet.relayer.fi/v1/action/builders/swap"
payload = {
"protocol": "lfj",
"chainName": "avalanche",
"fromToken": "AVAX",
"toToken": "JOE",
"routerAddress": "0xb00D916688FEE4aB6646994104E1441446947fc9",
"slippageTolerance": 0.5
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'lfj',
chainName: 'avalanche',
fromToken: 'AVAX',
toToken: 'JOE',
routerAddress: '0xb00D916688FEE4aB6646994104E1441446947fc9',
slippageTolerance: 0.5
})
};
fetch('https://testnet.relayer.fi/v1/action/builders/swap', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://testnet.relayer.fi/v1/action/builders/swap",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'protocol' => 'lfj',
'chainName' => 'avalanche',
'fromToken' => 'AVAX',
'toToken' => 'JOE',
'routerAddress' => '0xb00D916688FEE4aB6646994104E1441446947fc9',
'slippageTolerance' => 0.5
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://testnet.relayer.fi/v1/action/builders/swap"
payload := strings.NewReader("{\n \"protocol\": \"lfj\",\n \"chainName\": \"avalanche\",\n \"fromToken\": \"AVAX\",\n \"toToken\": \"JOE\",\n \"routerAddress\": \"0xb00D916688FEE4aB6646994104E1441446947fc9\",\n \"slippageTolerance\": 0.5\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://testnet.relayer.fi/v1/action/builders/swap")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"lfj\",\n \"chainName\": \"avalanche\",\n \"fromToken\": \"AVAX\",\n \"toToken\": \"JOE\",\n \"routerAddress\": \"0xb00D916688FEE4aB6646994104E1441446947fc9\",\n \"slippageTolerance\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://testnet.relayer.fi/v1/action/builders/swap")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"protocol\": \"lfj\",\n \"chainName\": \"avalanche\",\n \"fromToken\": \"AVAX\",\n \"toToken\": \"JOE\",\n \"routerAddress\": \"0xb00D916688FEE4aB6646994104E1441446947fc9\",\n \"slippageTolerance\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"metadata": {}
}{
"statusCode": 400,
"message": [
"<string>"
],
"error": "Bad Request"
}{
"success": true,
"message": "<string>",
"statusCode": 123,
"timestamp": "<string>",
"data": {},
"path": "<string>",
"traceId": "<string>"
}{
"success": true,
"message": "<string>",
"statusCode": 123,
"timestamp": "<string>",
"data": {},
"path": "<string>",
"traceId": "<string>"
}{
"success": true,
"message": "<string>",
"statusCode": 123,
"timestamp": "<string>",
"data": {},
"path": "<string>",
"traceId": "<string>"
}Authorizations
Use this format: ApiKey <your_api_key>
Body
application/json
Parameters for generating swap metadata
Protocol name
Example:
"lfj"
Blockchain name
Example:
"avalanche"
Input token
Example:
"AVAX"
Output token
Example:
"JOE"
KOL Router contract address
Example:
"0x123abc456def789012345678901234567890abcd"
Slippage tolerance (percentage)
Example:
0.5
⌘I