Skip to main content
POST
/
api
/
swap
/
native
cURL
curl --request POST \
  --url https://public-beam-backend-mainnet.codemelt.codes/api/swap/native \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokenAId": 123,
  "tokenBId": 123,
  "slippage": 50,
  "amount": "<string>",
  "sender": "<string>",
  "recipient": "<string>",
  "skipNonSwapTransactions": false
}
'
{
  "message": "<string>",
  "data": {
    "path": [
      "<string>"
    ],
    "transactions": [
      {
        "type": "<unknown>",
        "data": "<string>",
        "order": 123,
        "value": 123,
        "to": "<string>",
        "chainType": "<unknown>",
        "rpcUrl": "<string>",
        "gasAmount": 123,
        "gasUsd": 123
      }
    ],
    "dexToUse": "<string>",
    "minAmountOut": 123
  },
  "status": "<unknown>"
}

​
Overview

This endpoint provides native swap functionality for token exchanges. It allows for cross-chain swaps and uses the native DEX of the platform.

​
Using the sdk

import api, { IConnection } from "codemelt-beam-api-sdk"
const connection: IConnection = {
  host: '<enter you host url here>',
  headers: {
    'x-api-key': '<enter your api key here>'
  }
}
const result = await api.functional.api.swap.native.getSwapData(
  connection,
  {
    tokenAId: 1,
    tokenBId: 2,
    slippage: 50,
    amount: '1.5', //amount must be sent as human readable number
    //can also be BTC address or solana address
    sender: '0x0000000000000000000000000000000000000000', 
    recipient: '0x0000000000000000000000000000000000000000',
    //if true, the sdk will skip non-swap transactions and only return swap transactions
    //this will greatly reduce the request time since some rpc calls are no logner executed
    //default is not required: this will also add approvals, etc.
    skipNonSwapTransactions: true //or false
  }
)

Body

application/json
​
tokenAId
integer
required
​
tokenBId
integer
required
​
slippage
number
default:50
required
Required range: x >= 10
​
amount
string
required
​
sender
string
required
​
recipient
string
required
​
skipNonSwapTransactions
boolean
default:false

Response

201 - application/json
  • Option 1
  • Option 2
​
message
string
required
​
data
object
required
​
status
any
required