Docs / Documentation

Documentation

Everything here is rendered from the markdown in the public repository, so the page you read is the file the code is built from.

Two ways to run an exchange on Keel: Custodial clients with their own wallets, P2P clients on Keel Wallet: where funds sit, who signs, what it costs.
Building a client: The integration contract: accounts and roles, the per-network switch and readiness, idempotency and reconciliation, streams, signing, pricing.
Read API: The indexer's read API: blocks, accounts, markets, offers, trades, vaults, governance, search and the WebSocket feed.
Node RPC: The node's HTTP API: status, accounts, submitting signed actions, receipts, order book, vaults, governance, readiness, state sync.
WebSocket subscriptions: Filtered, sequenced subscriptions on the node and the indexer: accounts, pairs, deposits, order books, gaps and replay.
Deposits and withdrawals: Funding an account with Bitcoin or Tron on the testnet, confirmation depths, and withdrawing.
Keel Wallet: The wallet's provider API, key model and what a client site needs to connect.
Connect Keel Wallet: Adding a Connect button to a site or app: the provider, login challenges, signing, session keys, mobile.
How the chain works: Consensus, issuance, governance, fees, wallets, custody, markets, P2P trading and the resilience scenarios.
Tokenomics: KEEL supply, allocation and the fee model.
The public testnet: What runs where, how to fund an account and how clients are onboarded.
Lightning: Bitcoin Lightning deposits and payouts through observer pools.
Whitepaper: Why a chain, and why this shape.

Live endpoints