Quick Start
Prerequisites
- Valid Amberdata API key
- WebSocket client (we’ll use
wscat
for examples)
Installation
Your First Connection
Connect to Amberdata’s WebSocket endpoint with your API key:Your First Subscription
Once connected, subscribe to block events:Connection Endpoints
Use the appropriate endpoint for optimal performance based on your data type:Data Type | Connection URL | Best For |
---|---|---|
General | wss://ws.amberdata.com | Blockchain data, general subscriptions |
Spot Markets | wss://ws.amberdata.com/spot | Spot trading data (OHLCV, tickers, trades) |
Futures | wss://ws.amberdata.com/futures | Futures data (funding rates, liquidations, OI) |
Options | wss://ws.amberdata.com/options | Options data (liquidations, OI, trades) |
DEX | wss://ws.amberdata.com/defi/dex | Decentralized exchange trades |
Subscription Format
All subscription requests follow JSON-RPC 2.0 format:Request Structure
Field | Type | Required | Description |
---|---|---|---|
jsonrpc | string | Yes | Must be “2.0” |
method | string | Yes | ”subscribe” or “unsubscribe” |
params | array | Yes | [subscription_type, options_object] |
id | number | Yes | Client-generated identifier |
Market Data Subscription Examples
Spot Market Data:Supported Blockchains
For specifc blockchains, specify as a header in the initial HTTP upgrade request.Blockchain | Network | Blockchain ID |
---|---|---|
Bitcoin | Mainnet | bitcoin-mainnet |
Bitcoin Cash | Mainnet | bitcoin-abc-mainnet |
Ethereum | Mainnet | ethereum-mainnet |
Litecoin | Mainnet | litecoin-mainnet |