Setup Instructions

Please complete this form to obtain your API Keys.

Getting Started

Please ensure you have a valid API key. You may apply for one using the link provided above. With an API key, you may access the widget through the following URL:

https://widget.uniramp.com/?api_key=pk_prod_xxx

Most users prefer to embed the widget on their website. This can be easily achieved through an iframe embed. Users may choose to style the iframe to fit the website's design. We recommend the following styles as a good starting point:

border: 1px #00000030 solid;
border-radius: 4px;
height: 650px;
width: 450px;

An example of the complete iframe can be found below:

<iframe src="https://widget.uniramp.com/?api_key=pk_prod_xxx" style="border: 1px #00000030 solid; border-radius: 4px; height: 650px; width: 450px;" name="Uniramp"></iframe>

Query Parameters

The following query parameters allow users to customize the widget. In addition, the parameters can be used dynamically (eg. custom onramp_wallet for different users). This can be trivially implemented through URLSearchParams in JavaScript/TypeScript or other similar functions.

Parameter	Description	Required	Example
api_key	api publisher key (eg. pk_prod_xxx)
onramp_wallet	wallet address		0xa90D8432d3d1afb828b0aa3fCB7a6291b20EE64e
onramp_hybrid	if hybrid transactions are enabled		false
onramp_chain	the default chain that is selected. learn more about its usage from the selecting default crypto section		eth
onramp_crypto	the default crypto token that is selected. this field works in tandem with onramp_chain. learn more about its usage from the selecting default crypto section		0x0000000000000000000000000000000000000000

Selecting Default Crypto

Use the onramp_chain and onramp_crypto query parameters to select a default cryptocurrency. Please note that the usage of onramp_chain is required while onramp_crypto is optional. Some common cryptocurrencies and their corresponding query parameters can be found below:

Crypto	onramp_chain	onramp_crypto
Bitcoin	btc
Ethereum	eth
BNB	bsc
Matic	poly
Solana	sol
Litecoin	ltc
Tron	trx
USDT (ETH)	eth	0xdac17f958d2ee523a2206206994597c13d831ec7
USDT (BSC)	bsc	0x55d398326f99059ff775485246999027b3197955
USDT (POLY)	poly	0xc2132d05d31c914a87c6611c10748aeb04b58e8f
USDC (ETH)	eth	0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
USDC (BSC)	bsc	0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d
USDC (POLY)	poly	0x2791bca1f2de4661ed88a30c99a7a9449aa84174