Subscribes to market prices updates, optionally filtered by pair.
Make sure you're connected to this subscription: wss://ws.web3api.io.
Request
All pairs:
{"jsonrpc":"2.0","id":1,"method":"subscribe","params":["market:spot:prices:updates"]}
Specific pair or exchange:
{"jsonrpc":"2.0","id":1,"method":"subscribe","params":["market:spot:prices:updates",{"pair":"ltc_usdt"}]}
Param | Type | Description |
---|---|---|
pair | string | The asset pair by which to filter. |
Response
"result": {
"delistedPair": false,
"delta": 0.00000505928571428572,
"isNewPair": false,
"pair":" eth_btc",
"previousPrice": 0.027663041428571428,
"previousTimestamp": 1562017440000,
"price": 0.027668100714285715,
"timestamp": 1562017500000,
"unchangedPrice": false
}
Field | Type | Description |
---|---|---|
delistedPair | bool | true if pair has been delisted. false otherwise. |
delta | The dollar value change in price since last update. | |
isNewPair | bool | true if pair is new. false otherwise. |
pair | string | The pair. |
previousPrice | The price at time of last update. | |
previousTimestamp | The time of the last update. | |
price | number | The quote price of the asset pair. |
timestamp | number | The time at which the price change took place. |
unchangedPrice | bool | true if price hasn't changed since last update. false otherwise. |
Example
const WebSocket = require('ws');
const ws = new WebSocket('wss://ws.web3api.io', {headers: {x-api-key:'<api_key>'}});
ws.on('open', () => {
ws.send(JSON.stringify({
jsonrpc: '2.0',
method: 'subscribe',
params: ["market:spot:prices:updates",{ "pair": "ltc_usdt"}],
id: 1,
}));
});
ws.on('message', data => {
console.log(JSON.stringify(JSON.parse(data), null, 2));
});