Make your first request
API model
- Canonical configuration.
GET /v1/protocol/configpublishes the active network, contracts, collateral decimals, limits, fees and realtime capabilities. Do not hard-code these values. - Immediate market data. Market summaries, the versioned order book and point-in-time BUY/SELL quotes reflect the instant clearinghouse venue.
- Rich lifecycle. Market responses distinguish registration, trading,
resolution, settlement and claimability instead of relying on one ambiguous
activeflag. - Durable realtime. Fetch-based SSE uses schema version 2, source-vector cursors and explicit reset frames. REST snapshots carry the cursor needed for race-free resume.
- Private authority. Account and private realtime reads require the matching wallet session. Trading writes require a separate user-created restricted authorization plus the scoped developer key; the write does not receive an unrelated session bearer. A developer key alone never reveals or controls a user’s account.
- Reconciliation.
GET /v1/transactions/{txId}combines Alephium node state with privacy-filtered Aura indexing and recovery state. - Webhooks. Developer webhooks share the durable event backbone, use HMAC signatures, and deliver at least once.
number.
Your first API call
Read configuration, markets and a versioned book.
Prepare API trading
Compose a builder identity with explicit user authority.
Authentication
Public access, developer keys and wallet-bound sessions.
Native funding
Exact spendability, deposits and session-only withdrawals.
Realtime data
Snapshot, resume and recover safely from a reset.
On-chain operations
Understand the remaining non-trading transaction builders.
Errors
Stable codes, request IDs and safe retries.
Base URLs
/v1/protocol/config and verify the network and contract configuration you
expected.
Specifications and SDK
The public OpenAPI 3.1 document is served from/openapi.json. The TypeScript builder
SDK is @aura/builder-sdk; it includes exact-money types, header-based auth,
fetch-SSE resume/reset handling and webhook verification.
