API Reference

Get a quote for exchanging fiat to crypto

get
https://capi.boomfi.xyz/v1/ramp/quote

Returns price, fee breakdown, and a session token. Exactly one of sell_amount or buy_amount must be provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Fiat currency the user is paying with (symbol, e.g. “EUR”).

string
required

Token contract address to buy (must be from a Digital currency).

string
required

Currency symbol you want to buy (must be Digital).

integer
required

Blockchain chain ID for the selected token.

string
enum
required

Payment method to use.

Allowed:
number

The exact amount of fiat currency to sell.
Provide either sell_amount (to specify how much fiat you’re spending) or buy_amount (to specify how much crypto you want), but not both.

number

The exact amount of cryptocurrency to buy.
Provide either buy_amount (to specify how much crypto you want) or sell_amount (to specify how much fiat you’re spending), but not both.

string

Allows the affiliate to add their organisation ID to get an affiliate fee.

Responses

Updated 4 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago