HomeAPI Documentation
API Docs & Integration Guide
Integration docs for Query API and Webhook — signing, queries, push, reorgs, and recommended flow.
HMAC Auth
API Key identifies the caller; API Secret signs locally only.
Query + Webhook
Query on-chain data actively or receive real-time notifications via Webhook.
Reorg Friendly
pending vs stable layers; fix via chain.reorg / chain.removed on reorg.
Platform Overview
The platform continuously syncs on-chain data into an indexed database and exposes two capabilities: Query API for active lookups and Webhook for active push notifications.
Endpoint / Topic
Query API + WebhookNotes
- Query: EVM supports legacy `/v1/*?chainId=` or `/v1/chains/{chainKey}/*`; BTC/Solana require chainKey routes.
- EVM supports internal transfers, NFT balances, and contract events; BTC/Solana support balance/transfer queries only.
- Webhook: EVM coin/token/contract; BTC uses btc.balance_changed; Solana uses sol.balance_changed (SOL/USDT).
- BTC and Solana do not support contract.event or token.balance_changed (non-ERC20).
- Use stable/finalized for settlement; pending for alerts (handle reorg; EVM pending coin excludes internal transfers).
Response / Format
json
{
"query": "Actively query indexed on-chain data",
"webhook": "Push when on-chain changes match your watch config",
"consistency": ["stable", "pending", "finalized"]
}Example
bash
# 1. Create an API Key
# 2. Call Query API with HMAC signing
# 3. Configure Webhook URL and watch targets
# 4. Verify signatures and handle idempotency on your side