GET
/
exchange
/
api
/
orders
/
trade-url

Generate a trade URL using specified parameters such as fiat currency, token, trade type, and network. This URL redirects users to the Onboard web interface to complete transactions and is ideal for low-code integrations with Onboard Connect.

Query Parameters

apiKey
string
required

CEX api key

product
enum<string>
required

Integration product in use e.g web3 or custodial

Available options:
WEB3,
CUSTODIAL
orderId
string

Order ID generated for offramp trades

tradeType
enum<string>
required

Type of trade

Available options:
BUY,
SELL
fiat
string
required

Symbol of fiat currency

fiatAmount
number

Fiat amount

token
string
required

Symbol of token asset

tokenAmount
number

Token amount

networkId
string

Onboard blockchain network identifier or chain Id e.g Base will be base or 8453 or 0x2105

address
string

Wallet address to be debited/credited in order

paymentChannel
string

Payment channel

email
string

Customer's email address

autoselect
boolean
default:
true

Offer auto select flag

Response

200 - application/json

Response for a successful create order command

tradeUrl
string
required

Http link for CEX to redirect to