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

Base URL for sandbox and live:
Sandbox and live share the base URL; the environment query parameter selects the scope.

Authentication

Protected routes use a workspace API key:
Health checks do not require authentication.

Environment scope

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

Response envelope

Every JSON response includes: