Quickstart
Sign in, exchange a session token, and make your first authenticated request.
Authentication
Use workspace API keys as bearer tokens for API requests.
Wallets and balances
Create wallets, derive accounts, read balances, and manage address book entries.
Transfers
Preview withdrawals, create transfers, approve or cancel transfers, and reconcile status.
Core concepts
- A workspace scopes API keys, webhooks, wallets, balances, transfer policy, and environment settings.
- An API key authenticates requests with
Authorization: Bearer <api_key>. - An environment partitions mutable platform resources. Use
environment=sandboxfor tests andenvironment=livefor production operations. - A wallet is an Onstacks record linked to BlockOps custody infrastructure.
- A wallet account is an asset and network-specific deposit lane.
- A transfer records the local lifecycle before and after provider submission.
Base URL
Local development runs on:Response format
Successful responses use a consistent envelope:data: null and an error object:
