Base URL
List of endpoints
Trade options
This endpoint provides a list of supported fiat currencies, blockchain networks, payment channels, and transaction limits supported by Onboard. users to configure their trades.Sample Request
Sample Request
URL
Sample Response
Sample Response
Response
Explanation of key properties
- fiats
- networks
- transactionLimitsConfig
- paymentChannels
Property | Description |
---|---|
name | Full name of the fiat currency. |
isoCode | ISO 4217 code representing the currency. |
symbol | Symbol for the currency. |
unicodeSymbol | Unicode character for the currency. |
logo | URL to the flag or icon representing the currency. |
Get trade URL
Returns the trade URL for the paramaters provided. The URL retuned in the response can then be used in a browser / web view to start an ONRAMP / OFFRAMPSample Parameters
Sample Parameters
URL
Sample Response
Sample Response
Response
Start trade
This endpoint can be used in place ofGet Trade URL
, which returns the trade url in JSON. Instead, the Start trade
endpoint automatically resolves to the trade URL. This endpoint is best used to initiate trades within a browser or webview.
Sample mobile app integration
For mobile apps, the redirect link can be used within an embedded browser or webview component.🤖 Android
🤖 Android
To integrate Connect to your Android app, see the
Java
and Kotlin
snippets below:🍏 iOS
🍏 iOS
To integrate Connect to your iOS app, see the
Swift
and Flutter
snippets below:Get an order’s current price
Sample Parameters
Sample Parameters
URL
Sample Response
Sample Response
Response