Build a Forwarder deposit transaction list
curl --request POST \
--url https://api-tbi.boost.xyz/v1/forwarder/deposit \
--header 'Content-Type: application/json' \
--data '
{
"targetChainId": 123,
"targetAddress": "<string>",
"amount": "<string>",
"sender": "<string>",
"receiver": "<string>",
"inputToken": "<string>"
}
'import requests
url = "https://api-tbi.boost.xyz/v1/forwarder/deposit"
payload = {
"targetChainId": 123,
"targetAddress": "<string>",
"amount": "<string>",
"sender": "<string>",
"receiver": "<string>",
"inputToken": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
targetChainId: 123,
targetAddress: '<string>',
amount: '<string>',
sender: '<string>',
receiver: '<string>',
inputToken: '<string>'
})
};
fetch('https://api-tbi.boost.xyz/v1/forwarder/deposit', 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://api-tbi.boost.xyz/v1/forwarder/deposit",
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([
'targetChainId' => 123,
'targetAddress' => '<string>',
'amount' => '<string>',
'sender' => '<string>',
'receiver' => '<string>',
'inputToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api-tbi.boost.xyz/v1/forwarder/deposit"
payload := strings.NewReader("{\n \"targetChainId\": 123,\n \"targetAddress\": \"<string>\",\n \"amount\": \"<string>\",\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"inputToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api-tbi.boost.xyz/v1/forwarder/deposit")
.header("Content-Type", "application/json")
.body("{\n \"targetChainId\": 123,\n \"targetAddress\": \"<string>\",\n \"amount\": \"<string>\",\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"inputToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-tbi.boost.xyz/v1/forwarder/deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetChainId\": 123,\n \"targetAddress\": \"<string>\",\n \"amount\": \"<string>\",\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"inputToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"action": "deposit",
"flow": "direct",
"forwarderAddress": "<unknown>",
"target": {
"chainId": 123,
"targetAddress": "<unknown>",
"forwarderAddress": "<unknown>",
"acceptedToken": {
"address": "<unknown>",
"decimals": 4503599627370495,
"symbol": "<string>"
},
"acceptedTokens": [
{
"address": "<unknown>",
"decimals": 4503599627370495,
"symbol": "<string>"
}
],
"shareToken": {
"symbol": "<string>",
"decimals": 4503599627370495
},
"protocol": "<string>",
"name": "<string>",
"supportedActions": [
"deposit"
],
"depositActionType": "erc4626-deposit"
},
"transactions": [
{
"chainId": 123,
"to": "<unknown>",
"data": "<unknown>",
"value": "<string>",
"gasEstimate": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}Forwarder
Build a Forwarder deposit transaction list
Builds a direct same-chain Boost Forwarder deposit transaction list for a supported target. The server infers the accepted input token from the target registry.
POST
/
v1
/
forwarder
/
deposit
Build a Forwarder deposit transaction list
curl --request POST \
--url https://api-tbi.boost.xyz/v1/forwarder/deposit \
--header 'Content-Type: application/json' \
--data '
{
"targetChainId": 123,
"targetAddress": "<string>",
"amount": "<string>",
"sender": "<string>",
"receiver": "<string>",
"inputToken": "<string>"
}
'import requests
url = "https://api-tbi.boost.xyz/v1/forwarder/deposit"
payload = {
"targetChainId": 123,
"targetAddress": "<string>",
"amount": "<string>",
"sender": "<string>",
"receiver": "<string>",
"inputToken": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
targetChainId: 123,
targetAddress: '<string>',
amount: '<string>',
sender: '<string>',
receiver: '<string>',
inputToken: '<string>'
})
};
fetch('https://api-tbi.boost.xyz/v1/forwarder/deposit', 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://api-tbi.boost.xyz/v1/forwarder/deposit",
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([
'targetChainId' => 123,
'targetAddress' => '<string>',
'amount' => '<string>',
'sender' => '<string>',
'receiver' => '<string>',
'inputToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api-tbi.boost.xyz/v1/forwarder/deposit"
payload := strings.NewReader("{\n \"targetChainId\": 123,\n \"targetAddress\": \"<string>\",\n \"amount\": \"<string>\",\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"inputToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api-tbi.boost.xyz/v1/forwarder/deposit")
.header("Content-Type", "application/json")
.body("{\n \"targetChainId\": 123,\n \"targetAddress\": \"<string>\",\n \"amount\": \"<string>\",\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"inputToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-tbi.boost.xyz/v1/forwarder/deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetChainId\": 123,\n \"targetAddress\": \"<string>\",\n \"amount\": \"<string>\",\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"inputToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"action": "deposit",
"flow": "direct",
"forwarderAddress": "<unknown>",
"target": {
"chainId": 123,
"targetAddress": "<unknown>",
"forwarderAddress": "<unknown>",
"acceptedToken": {
"address": "<unknown>",
"decimals": 4503599627370495,
"symbol": "<string>"
},
"acceptedTokens": [
{
"address": "<unknown>",
"decimals": 4503599627370495,
"symbol": "<string>"
}
],
"shareToken": {
"symbol": "<string>",
"decimals": 4503599627370495
},
"protocol": "<string>",
"name": "<string>",
"supportedActions": [
"deposit"
],
"depositActionType": "erc4626-deposit"
},
"transactions": [
{
"chainId": 123,
"to": "<unknown>",
"data": "<unknown>",
"value": "<string>",
"gasEstimate": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}{
"error": "<string>",
"code": "INVALID_PARAMS",
"details": null
}Headers
Optional partner attribution reference ID. Values are manually assigned by Boost and must be at most 128 characters.
Required string length:
1 - 128Pattern:
^[A-Za-z0-9][A-Za-z0-9._:-]*$Body
application/json