Skip to main content
The Onstacks API is a JSON HTTP API. It is organized around auth, workspace configuration, wallets, transfers, provider routing, and developer tooling. Endpoint pages in the API sections are generated from openapi.yaml. They include parameters, request bodies, response schemas, auth requirements, and Mintlify’s interactive API playground.

​
Base URL

Local development: 
https://api.onstacks.io
Production deployments provide an environment-specific base URL.

​
Authentication

Protected routes use a workspace API key: 
Authorization: Bearer <api_key>
Health checks do not require authentication.

​
Environment scope

Environment-partitioned resources accept: 
?environment=sandbox
Supported values are sandbox and live. The default is sandbox.

​
Response envelope

Every JSON response includes:
FieldDescription
dataResponse payload, or null for errors.
errorError details, or null for success.
request_idRequest identifier for support and troubleshooting.