Skip to main content
POST
/
v1
/
swap
/
odos
Python (SDK)
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.swap.swap_odos(token_in="0x0000000000000000000000000000000000000000", token_out="USDT", amount_in=0.0001, max_slippage_percent=1, chain=models.OdosSwapRequestChain.ARBITRUM, sender="0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9", estimate_gas=True)

    # Handle response
    print(res)
import { CompassApiSDK } from "@compass-labs/api-sdk";

const compassApiSDK = new CompassApiSDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await compassApiSDK.swap.swapOdos({
    tokenIn: "0x0000000000000000000000000000000000000000",
    tokenOut: "USDT",
    amountIn: 0.0001,
    maxSlippagePercent: 1,
    chain: "arbitrum",
    sender: "0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9",
  });

  console.log(result);
}

run();
curl --request POST \
  --url https://api.compasslabs.ai/v1/swap/odos \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "chain": "arbitrum",
  "sender": "0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9",
  "token_in": "0x0000000000000000000000000000000000000000",
  "token_out": "USDT",
  "amount_in": 0.0001,
  "max_slippage_percent": 1
}
'
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 'arbitrum',
    sender: '0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9',
    token_in: '0x0000000000000000000000000000000000000000',
    token_out: 'USDT',
    amount_in: 0.0001,
    max_slippage_percent: 1
  })
};

fetch('https://api.compasslabs.ai/v1/swap/odos', 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.compasslabs.ai/v1/swap/odos",
  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([
    'chain' => 'arbitrum',
    'sender' => '0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9',
    'token_in' => '0x0000000000000000000000000000000000000000',
    'token_out' => 'USDT',
    'amount_in' => 0.0001,
    'max_slippage_percent' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.compasslabs.ai/v1/swap/odos"

	payload := strings.NewReader("{\n  \"chain\": \"arbitrum\",\n  \"sender\": \"0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9\",\n  \"token_in\": \"0x0000000000000000000000000000000000000000\",\n  \"token_out\": \"USDT\",\n  \"amount_in\": 0.0001,\n  \"max_slippage_percent\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<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://api.compasslabs.ai/v1/swap/odos")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chain\": \"arbitrum\",\n  \"sender\": \"0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9\",\n  \"token_in\": \"0x0000000000000000000000000000000000000000\",\n  \"token_out\": \"USDT\",\n  \"amount_in\": 0.0001,\n  \"max_slippage_percent\": 1\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.compasslabs.ai/v1/swap/odos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"chain\": \"arbitrum\",\n  \"sender\": \"0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9\",\n  \"token_in\": \"0x0000000000000000000000000000000000000000\",\n  \"token_out\": \"USDT\",\n  \"amount_in\": 0.0001,\n  \"max_slippage_percent\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "transaction": {
    "chainId": "0x2105",
    "data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
    "from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
    "gas": "0x7a120",
    "maxFeePerGas": "0x59682f00",
    "maxPriorityFeePerGas": "0x3b9aca00",
    "nonce": "0x5",
    "to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
    "value": "0x0"
  },
  "amount_out_quote": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json
token_in
string
default:0x0000000000000000000000000000000000000000
required

The symbol or address of the token that is to be sold.

Example:

"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"

token_out
string
default:USDT
required

The symbol or address of the token that is to be bought.

Example:

"0xdac17f958d2ee523a2206206994597c13d831ec7"

amount_in
default:0.0001
required

The amount of token_in to be sold.

Required range: x > 0
Example:

1.5

max_slippage_percent
number
default:1
required

The maximum slippage allowed in percent. e.g. 1 means 1% slippage allowed.

Required range: 0 <= x <= 10
Example:

0.5

chain
enum<string>
default:arbitrum
required
Available options:
arbitrum,
base,
ethereum
Example:

"arbitrum"

sender
string
default:0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type
string
default:ODOS_SWAP
Allowed value: "ODOS_SWAP"
estimate_gas
boolean
default:true

Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.

Response

Successful Response

transaction
UnsignedTransaction · object
required

The unsigned transaction data. User must sign and broadcast to network.

Example:
{
  "chainId": "0x2105",
  "data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
  "from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
  "gas": "0x7a120",
  "maxFeePerGas": "0x59682f00",
  "maxPriorityFeePerGas": "0x3b9aca00",
  "nonce": "0x5",
  "to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
  "value": "0x0"
}
amount_out_quote
string
required

The estimated amount out for the transaction. The actual output amount for this transaction is guaranteed be within the acceptable threshold, defined by the max_slippage_percent, relative to this quote.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$