From 72751310ed74699ac453562a3d71d532bd8c66a6 Mon Sep 17 00:00:00 2001 From: Hirotaka Aoki <113173839+aoki-h-jp@users.noreply.github.com> Date: Thu, 24 Aug 2023 00:25:18 +0900 Subject: [PATCH] Update README.md --- README.md | 59 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 30 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index c95eea7..c0d8de3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # binance-bulk-downloader [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110//) +[![Format code](https://github.com/aoki-h-jp/binance-bulk-downloader/actions/workflows/Formatter.yml/badge.svg?branch=main)](https://github.com/aoki-h-jp/binance-bulk-downloader/actions/workflows/Formatter.yml) ## Python library for bulk downloading Binance historical data A Python library to efficiently and concurrently download historical data files from Binance. @@ -39,45 +40,45 @@ downloader.run_download() ## Status This library is under development. Not all unit tests have been completed yet and the behaviour is unstable. -✅: Implemented and tested. 🚧: Implemented but not tested. ❎: Not available on Binance. +✅: Implemented and tested. 🚧: Implemented but not tested. ❌: Not implemented ❎: Not available on Binance. ### by data_type | data_type | spot | um | cm | options | | :------------------ | :--: | :--: | :--: | :-----: | -| aggTrades | ✅ | ✅ | 🚧 | ❎ | -| bookDepth | ❎ | ✅ | 🚧 | ❎ | -| bookTicker | ❎ | ✅ | 🚧 | ❎ | -| fundingRate | ❎ | ✅ | 🚧 | ❎ | -| indexPriceKlines | ❎ | ✅ | 🚧 | ❎ | -| klines | ✅ | ✅ | 🚧 | ❎ | -| liquidationSnapshot | ❎ | ✅ | 🚧 | ❎ | -| markPriceKlines | ❎ | ✅ | 🚧 | ❎ | -| metrics | ❎ | ✅ | 🚧 | ❎ | -| premiumIndexKlines | ❎ | ✅ | 🚧 | ❎ | -| trades | ✅ | ✅ | 🚧 | ❎ | -| BVOLIndex | ❎ | ❎ | ❎ | 🚧 | -| EOHSummary | ❎ | ❎ | ❎ | 🚧 | +| aggTrades | ✅ | ✅ | ❌ | ❎ | +| bookDepth | ❎ | ✅ | ❌ | ❎ | +| bookTicker | ❎ | ✅ | ❌ | ❎ | +| fundingRate | ❎ | ✅ | ❌ | ❎ | +| indexPriceKlines | ❎ | ✅ | ❌ | ❎ | +| klines | ✅ | ✅ | ❌ | ❎ | +| liquidationSnapshot | ❎ | ✅ | ❌ | ❎ | +| markPriceKlines | ❎ | ✅ | ❌ | ❎ | +| metrics | ❎ | ✅ | ❌ | ❎ | +| premiumIndexKlines | ❎ | ✅ | ❌ | ❎ | +| trades | ✅ | ✅ | ❌ | ❎ | +| BVOLIndex | ❎ | ❎ | ❎ | ❌ | +| EOHSummary | ❎ | ❎ | ❎ | ❌ | ### by data_frequency (klines, indexPriceKlines, markPriceKlines, premiumIndexKlines) | data_frequency | spot | um | cm | options | | :------------- | :--: | :--: | :--: | :-----: | -| 1m | ✅ | ✅ | 🚧 | ❎ | -| 3m | ✅ | ✅ | 🚧 | ❎ | -| 5m | ✅ | ✅ | 🚧 | ❎ | -| 15m | ✅ | ✅ | 🚧 | ❎ | -| 30m | ✅ | ✅ | 🚧 | ❎ | -| 1h | ✅ | ✅ | 🚧 | ❎ | -| 2h | ✅ | ✅ | 🚧 | ❎ | -| 4h | ✅ | ✅ | 🚧 | ❎ | -| 6h | ✅ | ✅ | 🚧 | ❎ | -| 8h | ✅ | ✅ | 🚧 | ❎ | -| 12h | ✅ | ✅ | 🚧 | ❎ | -| 1d | ✅ | ✅ | 🚧 | ❎ | -| 3d | 🚧 | 🚧 | 🚧 | ❎ | -| 1w | 🚧 | 🚧 | 🚧 | ❎ | -| 1mo | 🚧 | 🚧 | 🚧 | ❎ | +| 1m | ✅ | ✅ | ❌ | ❎ | +| 3m | ✅ | ✅ | ❌ | ❎ | +| 5m | ✅ | ✅ | ❌ | ❎ | +| 15m | ✅ | ✅ | ❌ | ❎ | +| 30m | ✅ | ✅ | ❌ | ❎ | +| 1h | ✅ | ✅ | ❌ | ❎ | +| 2h | ✅ | ✅ | ❌ | ❎ | +| 4h | ✅ | ✅ | ❌ | ❎ | +| 6h | ✅ | ✅ | ❌ | ❎ | +| 8h | ✅ | ✅ | ❌ | ❎ | +| 12h | ✅ | ✅ | ❌ | ❎ | +| 1d | ✅ | ✅ | ❌ | ❎ | +| 3d | ❌ | ❌ | ❌ | ❎ | +| 1w | ❌ | ❌ | ❌ | ❎ | +| 1mo | ❌ | ❌ | ❌ | ❎ | ## Disclaimer