Overview of Onramp APIs
To use the Onramp APIs, developers must:
- Authenticate by getting an Onramp Session Token
- Generate a URL using the session token and pass any relevant parameters
Additionally developers can leverage other API methods to:
- Get a list of available geographies and payment methods
- Generate a quote
- Get the status of a transaction
- Run analytics on transactions
Endpoints
The Onramp API has the following endpoints:
| Method | Description |
|---|---|
| Onramp Session Token | Provides a secure way for the client to initialize the Onramp widget. |
| Buy Config | Returns list of countries supported by Coinbase Onramp, and the payment methods available in each country. |
| Buy Options | Returns supported fiat currencies and available crypto assets that can be passed into the Buy Quote API. |
| Buy Quote | Provides a quote based on the asset the user would like to purchase, plus the network, the dollar payment, the payment currency, payment method, and country. |
| Transaction Status | Provides developers with real time status of an Onramp transaction which they can use to share status updates with end-users. |
| Transactions | Provides developers with their transactions for analytics purposes. |
Rate Limiting
The Buy Quote API is rate limited to prevent abuse that would degrade our ability to maintain consistent API performance for all users. Throttling is enforced per endpoint by app ID at 100 requests per second.
If your requests are being rate limited, HTTP response code 429 is returned with a rate_limit_exceeded error.
Rate limiting is implemented using a sliding window algorithm.