exchange-external-api
Find offers using trading parameters
Changed onget/exchange/api/offers
Request
- Base URLhttps://external.dev.onboardpay.co
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
offerType'ONRAMP' | 'OFFRAMP'
tokenstring
fiatstring
tokenAmountnumber
fiatAmountnumber
networkIdstring
Onboard blockchain network identifier or chain Id e.g Base will be base or 8453 or 0x2105
paymentChannelstring
paymentChannelTypestring
merchantIdstring
pagenumber
limitnumber
Pagination limit
Response
Success
Example response
{
"offers": [
{
"tokenSymbol": "BNB",
"fiatSymbol": "USD, NGN",
"totalUnit": 5000,
"tradedUnit": 5000,
"lockedUnit": 5000,
"rate": 500,
"rateCap": 500,
"flexibleOfferMargin": 10,
"partnerRating": -1,
"partnerStats": {
"averageRating": 3,
"completionPercentage": 94,
"averageResponseTime": 5
},
"maxTimeout": {
"deposit": 1440,
"confirmation": 600
}
}
]
}Changes
- info
endpoint added
- info