Encode an Ondo swap for broadcast

curl --request POST \
  --url https://api.coinlist.co/v1/ondo/swap/transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "100000000",
  "chain": "ethereum_sepolia",
  "symbol": "AAPLon",
  "wallet_address": "0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512"
}
'

import requests

url = "https://api.coinlist.co/v1/ondo/swap/transaction"

payload = {
    "amount": "100000000",
    "chain": "ethereum_sepolia",
    "symbol": "AAPLon",
    "wallet_address": "0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '100000000',
    chain: 'ethereum_sepolia',
    symbol: 'AAPLon',
    wallet_address: '0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512'
  })
};

fetch('https://api.coinlist.co/v1/ondo/swap/transaction', 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.coinlist.co/v1/ondo/swap/transaction",
  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([
    'amount' => '100000000',
    'chain' => 'ethereum_sepolia',
    'symbol' => 'AAPLon',
    'wallet_address' => '0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.coinlist.co/v1/ondo/swap/transaction"

	payload := strings.NewReader("{\n  \"amount\": \"100000000\",\n  \"chain\": \"ethereum_sepolia\",\n  \"symbol\": \"AAPLon\",\n  \"wallet_address\": \"0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.coinlist.co/v1/ondo/swap/transaction")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"100000000\",\n  \"chain\": \"ethereum_sepolia\",\n  \"symbol\": \"AAPLon\",\n  \"wallet_address\": \"0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coinlist.co/v1/ondo/swap/transaction")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"100000000\",\n  \"chain\": \"ethereum_sepolia\",\n  \"symbol\": \"AAPLon\",\n  \"wallet_address\": \"0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512\"\n}"

response = http.request(request)
puts response.read_body

{
  "action": "broadcast_transaction",
  "data": "0x0c89df8c",
  "expires_at": "2025-01-01T00:00:00.000000Z",
  "fee": "0",
  "notional_value": "100000000",
  "pay_input_amount": "100000000",
  "pay_input_decimals": 6,
  "receive_output_amount": "264000000000000000",
  "receive_output_decimals": 18,
  "to": "0xff9c5ade32d9b4102469bd5f3817cb0061b25fec"
}

{
  "message": "<string>",
  "type": "api_error",
  "code": "<string>",
  "errors": {},
  "event_id": "<string>"
}

Ondo

Encode an Ondo swap for broadcast

Encodes the buy the user just confirmed and returns calldata their wallet can sign and broadcast, plus the amounts it commits to. This is the commit step: it consumes an attestation and the calldata expires, so call it once per confirmation and never poll it. Approve the swap contract for the full amount first; an allowance short of it is rejected here rather than reverting on-chain. The addresses are resolved from the offer, so the request names the asset, not the tokens.

POST

ondo

swap

transaction

Encode an Ondo swap for broadcast

curl --request POST \
  --url https://api.coinlist.co/v1/ondo/swap/transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "100000000",
  "chain": "ethereum_sepolia",
  "symbol": "AAPLon",
  "wallet_address": "0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512"
}
'

import requests

url = "https://api.coinlist.co/v1/ondo/swap/transaction"

payload = {
    "amount": "100000000",
    "chain": "ethereum_sepolia",
    "symbol": "AAPLon",
    "wallet_address": "0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '100000000',
    chain: 'ethereum_sepolia',
    symbol: 'AAPLon',
    wallet_address: '0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512'
  })
};

fetch('https://api.coinlist.co/v1/ondo/swap/transaction', 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.coinlist.co/v1/ondo/swap/transaction",
  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([
    'amount' => '100000000',
    'chain' => 'ethereum_sepolia',
    'symbol' => 'AAPLon',
    'wallet_address' => '0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.coinlist.co/v1/ondo/swap/transaction"

	payload := strings.NewReader("{\n  \"amount\": \"100000000\",\n  \"chain\": \"ethereum_sepolia\",\n  \"symbol\": \"AAPLon\",\n  \"wallet_address\": \"0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.coinlist.co/v1/ondo/swap/transaction")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"100000000\",\n  \"chain\": \"ethereum_sepolia\",\n  \"symbol\": \"AAPLon\",\n  \"wallet_address\": \"0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coinlist.co/v1/ondo/swap/transaction")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"100000000\",\n  \"chain\": \"ethereum_sepolia\",\n  \"symbol\": \"AAPLon\",\n  \"wallet_address\": \"0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512\"\n}"

response = http.request(request)
puts response.read_body

{
  "action": "broadcast_transaction",
  "data": "0x0c89df8c",
  "expires_at": "2025-01-01T00:00:00.000000Z",
  "fee": "0",
  "notional_value": "100000000",
  "pay_input_amount": "100000000",
  "pay_input_decimals": 6,
  "receive_output_amount": "264000000000000000",
  "receive_output_decimals": 18,
  "to": "0xff9c5ade32d9b4102469bd5f3817cb0061b25fec"
}

{
  "message": "<string>",
  "type": "api_error",
  "code": "<string>",
  "errors": {},
  "event_id": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 authorization and token endpoints

Body

Ondo swap transaction params

The buy to encode: an asset, the wallet buying it, and what it pays.

amount

string

required

Gross amount to pay, as a uint256 decimal string in the funding token's smallest unit. This is the figure to approve: the CoinList fee comes off it, and Ondo prices the remainder.

Example:

"100000000"

chain

enum<string>

required

The EVM chain to swap on. Only chains CoinList has deployed a swap contract on are accepted, which is narrower than both this enum and the chains the on-chain reads serve.

Available options:

ethereum_sepolia,

base_sepolia,

ethereum_mainnet,

base_mainnet

Example:

"ethereum_sepolia"

symbol

string

required

Ondo asset symbol to buy

Example:

"AAPLon"

wallet_address

string

required

Wallet that will broadcast the transaction. The calldata is signed over it, so no other wallet can send it.

Example:

"0x2c4c7082a135f6b980cdae4b40c3ebf72cd4a512"

Response

Successful response.

A signed, ready-to-broadcast Ondo swap and the amounts it commits to. Unlike the quote, this spends an attestation and expires, so call it once the user has confirmed and never on a timer.

action

enum<string>

required

Available options:

broadcast_transaction

data

string

required

The encoded swap to broadcast on-chain

Example:

"0x0c89df8c"

expires_at

string<date-time>

required

When the signed calldata stops being accepted. Broadcast before this or request a new transaction; a late send reverts.

Example:

"2025-01-01T00:00:00.000000Z"

fee

string

required

CoinList's cut of pay_input_amount, in the same units. Taken at execution, not on top, so the wallet never approves more than pay_input_amount.

Example:

"0"

notional_value

string

required

The part of pay_input_amount that reaches Ondo, in the same units. This is what the quantity was priced against, and the signature commits to it.

Example:

"100000000"

pay_input_amount

string

required

Total the purchase costs, fee included, as a uint256 decimal string in the funding token's smallest unit. The approval has to cover this.

Example:

"100000000"

pay_input_decimals

integer

required

Decimals pay_input_amount, fee and notional_value are denominated in, read on-chain from the funding token. The token is resolved from the offer rather than named by the caller, so this is the only place its scale is published.

Example:

6

receive_output_amount

string

required

Quantity of the asset the wallet receives, as a uint256 decimal string in the asset's smallest unit. Divide by 10^receive_output_decimals to display whole tokens.

Example:

"264000000000000000"

receive_output_decimals

integer

required

Decimals receive_output_amount is denominated in, reported by whatever priced the quantity rather than looked up separately.

Example:

18

string

required

The swap contract to submit the transaction to

Example:

"0xff9c5ade32d9b4102469bd5f3817cb0061b25fec"