Reference - Onstacks

Identifiers

Identifier	Format	Example
Workspace API key	`ostk_live_` followed by a random token. Returned once at creation.	`ostk_live_5f3…`
Wallet, transfer, and intent ids	UUID v4	`3c90c3cc-0d44-4b50-8888-8dd25736052a`
Request id	Returned in every response envelope as `request_id`	`req_…`
Webhook event id	Sent in the `X-Onstacks-Webhook-ID` header	UUID v4

Amounts

Amounts are strings in the asset’s base unit. For USDC on Base that is six decimals, so 1000000 is 1.00 USDC. Fiat amounts in quotes are strings in minor units, so 150000 NGN is 1,500.00 NGN.

Networks and assets

Network codes are lowercase with underscores, for example base, ethereum, and ethereum_sepolia. Asset symbols are uppercase, for example USDC, USDT, and CNGN.

Environments

Every environment-scoped route accepts ?environment=sandbox or ?environment=live. The default is sandbox. Sandbox and live resources never mix: a sandbox wallet is invisible to live calls and the reverse.

Response envelope

{
  "data": {},
  "error": null,
  "request_id": "req_..."
}

Errors carry data: null and an error object with a stable code and a human-readable message. See Errors.