OnRamp API reference
Updated
These tables cover the OnRamp API's base URLs, who can open the API settings page, and how requests use credits.
Base URL
Every OnRamp API endpoint starts with your organization's base URL.
Where your organization is hosted | Base URL |
|---|---|
US |
|
EU data-residency environment |
|
Endpoint documentation
The full list of endpoints lives on the developer docs site. To open it, go to Settings > API & webhooks > API and select Documentation. If your Settings menu isn't grouped into sections such as API & webhooks, select API under Advanced instead, and then select Documentation. The site opens in a new tab.
Every organization links to the same docs site, which covers both the US and EU regions. If your organization is hosted in the EU, Documentation opens the site with the EU region selected.
Who sees the API page
What you see under Settings > API & webhooks > API depends on your seat license.
Seat license | Tabs you see | Page opens on |
|---|---|---|
Super Admin | Keys, Usage and Logs | Keys |
Integrator | Keys | Keys |
Creator | Usage and Logs | Usage |
Contributor or Collaborator | No API page in Settings | — |
Tab | What it's for |
|---|---|
Keys | The API keys that authenticate your requests. Treat each one like a password. To create one, select New API key. |
Usage | Credits used by endpoint and key, against your monthly allocation. |
Logs | Recent API requests, with the status and response time of each. |
API credits
API requests draw on a monthly credit allocation, at a set number of credits per request. The Usage tab shows how many credits one request uses.
Your organization needs API credits before anyone can create a key. Without them:
Selecting New API key opens a dialog titled You don't have API credits yet and doesn't create a key.
A banner on the Keys, Usage and Logs tabs links to Get free API credits. Free credits are available to prototype and test.