Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ramp.gnosis.io/llms.txt

Use this file to discover all available pages before exploring further.

The API Reference tab provides interactive documentation for all Gnosis Ramp endpoints. Use it to explore paths, schemas, and try requests.

​
Base URL

ItemValue
Base URLhttps://api.ramp.gnosis.io
Content typeapplication/json
There is no separate sandbox URL. Sandbox testing is controlled by configuring your ramp providers with sandbox credentials in the dashboard. See Getting Started for details.

​
Authentication

Auth SchemeUsed ForFormat
HTTP BasicProject-scoped endpointsAuthorization: Basic base64(clientId:clientSecret)
Bearer TokenCustomer-scoped endpointsAuthorization: Bearer <accessToken>
Project-scoped endpoints (Basic Auth):
  • POST /customers — Create customers
  • GET /customers — List customers
  • GET /currencies/supported — Get currency pairs
  • GET /providers — List providers
  • GET /intent/requirements — Get requirements schema
  • GET /intent/quote — Get indicative quotes
Customer-scoped endpoints (Bearer Token):
  • POST /intent — Create intents
  • GET /intent — List intents
  • GET /intent/:id — Get intent
  • POST /intent/:id/transaction — Execute transaction
  • GET /intent/:id/transaction — Get transaction
See Authentication for complete details.

​
OpenAPI Spec

  • Download: openapi.yaml
  • Import into Postman, Insomnia, or your preferred client
  • Use schema definitions for strongly typed clients
  • The Mintlify playground supports live requests with credentials

​
Guides

For conceptual explanations, step-by-step walkthroughs, and code examples, see the Guides tab.