❓ Query Parameters
Parameter | Example Value | Type | Description |
---|---|---|---|
accessToken | c68d9253-9128-4412-a27e-3c55709b0626 | string | Your Rampnalysis Access Token. You need to pass this in order to integrate all other parameters. |
quoteCurrencyAmount | 1.5 | number | This will find the fiat required for the given amount of the defaultCrypto parameter. |
crypto | USDT_ETH | string | Only crypto selected. This will make the user unable to change the crypto. |
defaultCrypto | USDT_ETH | string | By default it will show this single crypto. |
defaultFiat | USD | string | By default it will show this fiat. |
fiatAmount | 7000 | number | Fiat amount |
fiatCurrency | INR | string | The fiat currency that you want to select |
isAmountEditable | true | binary | Makes the amount field uneditable |
onlyCrypto | USDT_ETH, MATIC_ETH | string | Comma-separated list of cryptocurrencies to allow. Only these will be shown. |
excludeCryptos | USDT_ETH, MATIC_ETH | string | Comma-separated list of cryptocurrencies to exclude. |
onlyCryptoNetworks | ETH,POLYGON | string | Filter available crypto by listed networks. |
excludeCryptoNetworks | ETH,POLYGON | string | Exclude cryptocurrencies on the listed networks. |
onlyFiat | USD,INR,GBP | string | Comma-separated list of fiat currencies to allow. |
excludeFiats | USD,INR,GBP | string | Comma-separated list of fiat currencies to exclude. |
custom_id | c68d9253-9128-4412-a27e-3c55709b0626 | string | Your custom transaction id. |
recommendedCrypto | ETH,CBANK_BSC | string | Comma-separated list of cryptocurrencies to highlight as “Popular.” |
Swap Params
Parameter | Example Value | Type | Description |
---|---|---|---|
fromToken | ETH | string | Default cryptocurrency to swap from. |
toToken | USDC | string | Default cryptocurrency to swap to. |
fromTokenAmount | 10 | number | Default amount filled in the fromToken field. |
Visual Params
Parameter | Example Value | Type | Description |
---|---|---|---|
widgetTheme | dark | string | Pre-built theme: light , dark , or blue . |
cardColor | ff0000 | hex | Changes the color of widget cards. |
primaryColor | 8b9dc3 | hex | Changes the color of buttons and accents. |
secondaryColor | ffffff | hex | Changes the color of dropdowns and secondary elements. |
primaryText | 528491 | hex | Changes the color of primary text. |
containerColor | 528491 | hex | Changes the background color of the widget container. |
borderRadius | 0.3 | number | Changes the border radius of buttons and containers. |
view | buy,sell,swap | string | Show only specific widget types: view=buy , view=sell , or view=swap . |
Orderflow
Parameter | Example Value | Type | Description |
---|---|---|---|
walletAddress | 0xc0ffee254729296a45a3885639AC7E10F9d54979 | string | The wallet address of the user |
firstName | Luffy | string | The first name of the user |
lastName | Monkey | string | The last name of the user |
email | email%40domain.com | string | The email of the user (e.g. email@domain.com ) |
mobileNumber | +447944866128 | string | Mobile phone of the user with country code |
dob | 1994-09-16 | string | User’s date of birth (YYYY-MM-DD) |
address1 | "17 Iconic Road" | string | The first line of the user’s address |
address2 | string | The second line of the user’s address | |
city | Atlanta | string | The city of the user’s address |
state | GA | string | The state or region of the user’s address |
postCode | 92111 | string | The postal code or ZIP code of the user’s address |
countryCode | US | string | Alpha-2 country code of the user’s country of residence |