tardis-machine 14.2.2 → 14.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +9 -30
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,49 +2,28 @@
2
2
 
3
3
  [![Version](https://img.shields.io/npm/v/tardis-machine.svg)](https://www.npmjs.org/package/tardis-machine)
4
4
 
5
- [Tardis-machine](https://docs.tardis.dev/api/tardis-machine) is a locally runnable server with built-in data caching that uses [Tardis.dev HTTP API](https://docs.tardis.dev/api/http) under the hood. It provides both **tick-level historical** and **consolidated real-time cryptocurrency market data** via HTTP and WebSocket APIs. Available via [npm](https://docs.tardis.dev/api/tardis-machine#npm) and [Docker](https://docs.tardis.dev/api/tardis-machine#docker).
6
- <br/>
7
- <br/>
8
- ![overview](<https://gblobscdn.gitbook.com/assets%2F-LihqQrMLN4ia7KgxAzi%2F-M2YHT2t5D3zrOL7TEyt%2F-M2YHurMxtHTW9ak0V9I%2Fexcalidraw-2020316131859%20(1).png?alt=media&token=11f81814-6b3e-4254-8047-cb03c433bcde>)
5
+ [Tardis Machine](https://docs.tardis.dev/api/tardis-machine) is a locally runnable server with built-in data caching that uses the [Tardis.dev HTTP API](https://docs.tardis.dev/api/http-api-reference) under the hood. It provides both **tick-level historical** and **consolidated real-time cryptocurrency market data** via HTTP and WebSocket APIs. Available via [npm and Docker](https://docs.tardis.dev/api/tardis-machine/quickstart#installation).
6
+
9
7
  <br/>
10
8
 
11
9
  ## Features
12
10
 
13
- - efficient data replay API endpoints returning historical market data for whole time periods \(in contrast to [Tardis.dev HTTP API](https://docs.tardis.dev/api/http) where single call returns data for single minute time period\)
14
-
15
- - [exchange-native market data APIs](https://docs.tardis.dev/api/tardis-machine#exchange-native-market-data-apis)
16
- - tick-by-tick historical market data replay in [exchange-native format](https://docs.tardis.dev/faq/data#what-is-a-difference-between-exchange-native-and-normalized-data-format)
17
-
18
- - [HTTP](https://docs.tardis.dev/api/tardis-machine#http-get-replay-options-options) and [WebSocket](https://docs.tardis.dev/api/tardis-machine#websocket-ws-replay-exchange-exchange-and-from-fromdate-and-to-todate) endpoints
11
+ - efficient data replay API endpoints returning historical market data for entire time periods
19
12
 
20
- - [WebSocket API](https://docs.tardis.dev/api/tardis-machine#websocket-ws-replay-exchange-exchange-and-from-fromdate-and-to-todate) providing historical market data replay from any given past point in time with the same data format and 'subscribe' logic as real-time exchanges' APIs - in many cases **existing exchanges' WebSocket clients can be used to connect to this endpoint**
13
+ - [exchange-native market data APIs](https://docs.tardis.dev/api/tardis-machine/replaying-historical-data#exchange-native-market-data-apis) — tick-by-tick historical replay in exchange-native format via HTTP and WebSocket endpoints. The WebSocket API replays data with the same format and subscribe logic as real-time exchange APIs existing exchange WebSocket clients can connect to this endpoint.
21
14
 
22
- - [normalized market data APIs](https://docs.tardis.dev/api/tardis-machine#normalized-market-data-apis)
23
- <br/>
24
- - consistent format for accessing market data across multiple exchanges
15
+ - [normalized market data APIs](https://docs.tardis.dev/api/tardis-machine/replaying-historical-data#normalized-market-data-apis) — consistent format across all exchanges via HTTP and WebSocket endpoints. Includes synchronized multi-exchange replay, real-time streaming, customizable order book snapshots and trade bars.
25
16
 
26
- - [HTTP](https://docs.tardis.dev/api/tardis-machine#http-get-replay-normalized-options-options) and [WebSocket](https://docs.tardis.dev/api/tardis-machine#websocket-ws-replay-normalized-options-options) endpoints
17
+ - [seamless switching](https://docs.tardis.dev/api/tardis-machine/replaying-historical-data#normalized-market-data-apis) between real-time streaming and historical replay
27
18
 
28
- - synchronized [historical market data replay across multiple exchanges](https://docs.tardis.dev/api/tardis-machine#http-get-replay-normalized-options-options)
19
+ - transparent local data caching (compressed GZIP on disk, decompressed on demand)
29
20
 
30
- - [consolidated real-time data streaming](https://docs.tardis.dev/api/tardis-machine#websocket-ws-stream-normalized-options-options) connecting directly to exchanges' WebSocket APIs
21
+ - support for many cryptocurrency exchanges — see [docs.tardis.dev](https://docs.tardis.dev) for the full list
31
22
 
32
- - customizable [order book snapshots](https://docs.tardis.dev/api/tardis-machine#book_snapshot_-number_of_levels-_-snapshot_interval-time_unit) and [trade bars](https://docs.tardis.dev/api/tardis-machine#trade_bar_-aggregation_interval-suffix) data types
33
- - seamless [switching between real-time data streaming and historical data replay](https://docs.tardis.dev/api/tardis-machine#normalized-market-data-apis)
34
- <br/>
35
-
36
- - transparent historical local data caching \(cached data is stored on disk in compressed GZIP format and decompressed
37
- on demand when reading the data\)
38
- <br/>
39
-
40
- - support for top cryptocurrency exchanges: BitMEX, Deribit, Binance, Binance Futures, FTX, OKEx, Huobi Global, Huobi DM, bitFlyer, Bitstamp, Coinbase Pro, Crypto Facilities, Gemini, Kraken, Bitfinex, Bybit, OKCoin, CoinFLEX and more
41
- <br/>
42
- <br/>
43
- <br/>
23
+ <br/>
44
24
 
45
25
  ## Documentation
46
26
 
47
27
  ### [See official docs](https://docs.tardis.dev/api/tardis-machine).
48
28
 
49
29
  <br/>
50
- <br/>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tardis-machine",
3
- "version": "14.2.2",
3
+ "version": "14.3.1",
4
4
  "engines": {
5
5
  "node": ">=24"
6
6
  },
@@ -59,7 +59,7 @@
59
59
  "debug": "^4.4.1",
60
60
  "find-my-way": "^9.3.0",
61
61
  "is-docker": "^2.2.1",
62
- "tardis-dev": "^14.2.1",
62
+ "tardis-dev": "^14.3.0",
63
63
  "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.59.0",
64
64
  "yargs": "^17.5.1"
65
65
  },