API ✨

This page is written for software engineers who require more granular, low-level interaction with Uniramp. For most users, we suggest leveraging the Uniramp Widget for hassle-free integration.
Environments
We offer a sandbox environment for development purposes. The sandbox environment allows developers to bypass transactions through our partner's dashboard and will complete DeFi swaps on testnets.
Environments
Endpoint
Production
api.uniramp.io/v1
Sandbox
sandbox.api.uniramp.io/v1
Authentication
Please complete this form to obtain your API Keys.
The Uniramp API uses API keys to authenticate requests through bearer authentication. Requests are required to include a valid bearer token in the x-api-key header. API requests without authentication will fail. An example of an authenticated request can be found below:
$ curl https://api.uniramp.io/v1/onramp/supported/fiat \
  -H "x-api-key: pk_prod_LGZp4n7498RW5E1IwR3mJ9Ep"
To ensure secure communication and data integrity, the Uniramp API exclusively supports HTTPS for all API requests. Any attempts to make requests over plain HTTP will not be successful.
Types of API Keys
There are a total of four different types of API keys. API keys grant you access to the Uniramp API.
Test secret key
Example: sk_sand_LGZp4n7498RW5E1IwR3mJ9Ep
Used to authenticate requests on the server (stored as an environment variable or in a credential management system) for the sandbox environment. This key can be used to perform API requests without restrictions. Do not expose this key on any client-side code or store this key on the version control system.

Test publishable key
Example: pk_sand_LGZp4n7498RW5E1IwR3mJ9Ep
Used to authenticate requests on the client for the sandbox environment. This key can be stored on the client-side code. API access using this key may be more restrictive.

Production secret key
Example: sk_prod_LGZp4n7498RW5E1IwR3mJ9Ep
Similar to the test secret key, use this key to authenticate requests on the production endpoint. Do not expose this key on any client-side code or store this key on the version control system.

Production publishable key
Example: pk_prod_LGZp4n7498RW5E1IwR3mJ9Ep
Similar to the test publisher key, use this key to authenticate requests on the production endpoint.
Mathematical Operations
All numbers sent and received through the Uniramp API are represented as integers. No floating point or decimal values are used by the API.
Representing Fiat and Cryptocurrency
Numbers representing currencies (fiat and cryptocurrency) should be converted to the smallest unit. For example, Ethereum should be represented as Wei and United States Dollar should be represented by cents. A $100 USD can be represented by 10000. A formula for the conversion can be found below:
amount * (10 ** decimal)
We highly recommend using bigint (for javascript) or an equivalent data type.
Endpoints
get
https://api.uniramp.io/v1
/onramp/supported/fiat
Supported Fiats
get
https://api.uniramp.io/v1
/onramp/supported/fiat/[id]
Retrieve Supported Fiat
get
https://api.uniramp.io/v1
/onramp/supported/crypto
Supported Cryptocurrencies
get
https://api.uniramp.io/v1
/onramp/supported/cefi/gateway
Supported CeFi Gateways
get
https://api.uniramp.io/v1
/onramp/supported/cefi/payment
Supported CeFi Payment Methods
get
https://api.uniramp.io/v1
/onramp/supported/defi/gateway
Supported DeFi Gateways
get
https://api.uniramp.io/v1
/onramp/supported/ip
Query IP Address
get
https://api.uniramp.io/v1
/onramp/quote/cefi
Aggregate CeFi Onramps
get
https://api.uniramp.io/v1
/onramp/quote/defi
Aggregate DeFi Liquidity via Uniramp Protocol
post
https://api.uniramp.io/v1
/onramp/transaction
Create Transaction
get
https://api.uniramp.io/v1
/onramp/transaction
Retrieve Transaction

Environments	Endpoint
Production	api.uniramp.io/v1
Sandbox	sandbox.api.uniramp.io/v1

Product - Previous

Widget 🔥

Last modified 2mo ago