Skip to main content

❓ Query Parameters

ParameterExample ValueTypeDescription
accessTokenc68d9253-9128-4412-a27e-3c55709b0626stringYour Rampnalysis Access Token. You need to pass this in order to integrate all other parameters.
quoteCurrencyAmount1.5numberThis will find the fiat required for the given amount of the defaultCrypto parameter.
cryptoUSDT_ETHstringOnly crypto selected. This will make the user unable to change the crypto.
defaultCryptoUSDT_ETHstringBy default it will show this single crypto.
defaultFiatUSDstringBy default it will show this fiat.
fiatAmount7000numberFiat amount
fiatCurrencyINRstringThe fiat currency that you want to select
isAmountEditabletruebinaryMakes the amount field uneditable
onlyCryptoUSDT_ETH, MATIC_ETHstringComma-separated list of cryptocurrencies to allow. Only these will be shown.
excludeCryptosUSDT_ETH, MATIC_ETHstringComma-separated list of cryptocurrencies to exclude.
onlyCryptoNetworksETH,POLYGONstringFilter available crypto by listed networks.
excludeCryptoNetworksETH,POLYGONstringExclude cryptocurrencies on the listed networks.
onlyFiatUSD,INR,GBPstringComma-separated list of fiat currencies to allow.
excludeFiatsUSD,INR,GBPstringComma-separated list of fiat currencies to exclude.
custom_idc68d9253-9128-4412-a27e-3c55709b0626stringYour custom transaction id.
recommendedCryptoETH,CBANK_BSCstringComma-separated list of cryptocurrencies to highlight as “Popular.”

Swap Params

ParameterExample ValueTypeDescription
fromTokenETHstringDefault cryptocurrency to swap from.
toTokenUSDCstringDefault cryptocurrency to swap to.
fromTokenAmount10numberDefault amount filled in the fromToken field.

Visual Params

ParameterExample ValueTypeDescription
widgetThemedarkstringPre-built theme: light, dark, or blue.
cardColorff0000hexChanges the color of widget cards.
primaryColor8b9dc3hexChanges the color of buttons and accents.
secondaryColorffffffhexChanges the color of dropdowns and secondary elements.
primaryText528491hexChanges the color of primary text.
containerColor528491hexChanges the background color of the widget container.
borderRadius0.3numberChanges the border radius of buttons and containers.
viewbuy,sell,swapstringShow only specific widget types: view=buy, view=sell, or view=swap.

Orderflow

ParameterExample ValueTypeDescription
walletAddress0xc0ffee254729296a45a3885639AC7E10F9d54979stringThe wallet address of the user
firstNameLuffystringThe first name of the user
lastNameMonkeystringThe last name of the user
emailemail%40domain.comstringThe email of the user (e.g. email@domain.com)
mobileNumber+447944866128stringMobile phone of the user with country code
dob1994-09-16stringUser’s date of birth (YYYY-MM-DD)
address1"17 Iconic Road"stringThe first line of the user’s address
address2stringThe second line of the user’s address
cityAtlantastringThe city of the user’s address
stateGAstringThe state or region of the user’s address
postCode92111stringThe postal code or ZIP code of the user’s address
countryCodeUSstringAlpha-2 country code of the user’s country of residence