Appearance
API Overview
The Blink API has two surfaces: transactions (write), signed RuntimeCalls submitted Borsh-encoded to the sequencer, and a normalized REST and WebSocket API (read and streaming) served by the indexer. All prices and sizes are integers (ticks, lots, atoms); see Data Structures & Constants.
Start here
- Get Started: the two surfaces, with quickstart examples.
- Signing Transactions: keys, wire format, replay protection.
- Data Structures & Constants: units and scalar types.
Transactions
Every transaction is submitted to the single Submit Transaction endpoint as a signed, Borsh-encoded RuntimeCall. The call is one of the four Blink modules' calls:
- Accounts: deposits, withdrawals, transfers, delegation.
- Spot: spot orders and market administration.
- Perps: margin, orders, leverage, vaults/BLP, protocol operations.
- Oracle: feeds and price updates.
See Signing Transactions for how to build and submit one.
Read (REST)
Served by the indexer; no authentication is required.
- Markets & Orderbook: metadata, depth, candles, stats
- Trades
- Accounts, Positions & Orders: balances, PnL, transfer history
- Funding & Liquidations
- Vaults & BLP
- Tokens: symbol and decimals registry
- System: status, info, config, exchange stats
- Explorer: transaction status and search
Streaming
- WebSocket: real-time orderbook, trades, and account updates.