Skip to main content

A non-official Python toolkit for managing historical market data from data.binance.vision

Project description

Binance DataTool - Built for Agents, Data Delivered.

PyPI Python 3.11+ License: BSD-3-Clause Ruff uv

A non-official Python toolkit for managing historical market data from data.binance.vision — designed from the ground up for AI agents and quantitative workflows.

binance-datatool is designed to make every command equally easy to call for AI agents and humans.:

  • Composable CLI — stdin/stdout pipelines let agents chain commands without glue code
  • Atomic operations — each command does one thing well; agents can inspect, decide, and act step by step
  • Deterministic output — structured, parseable results that agents can reason about
  • Zero interaction — no prompts, no confirmations; dry-run mode for safe previews

Agent Skill

A packaged Agent Skill is included in this repository.

It teaches agents how to use binance-datatool to discover, download, and verify Binance historical market data — no manual command lookup required.

Features

  • Multi-market coverage — Spot, USD-M Futures, and COIN-M Futures
  • Smart symbol filtering — filter by quote asset, exclude stablecoins and leveraged tokens, select contract types
  • Resumable batch downloads — diff-based sync via aria2 that only fetches new or updated files
  • Data integrity verification — SHA256 checksum validation with timestamped marker caching
  • Composable pipelines — Unix-friendly design; commands read from stdin and write to stdout
  • Async I/O — concurrent S3 listing and parallel checksum verification

Quick Start

Prerequisites

  • Python 3.11+
  • uv — fast Python package manager
  • aria2 — required for the download command

Install

# install the CLI
pipx install binance-datatool
# run `pipx ensurepath` if the command isn't found immediately

# system dependency for download command
# macOS
brew install aria2
# Ubuntu/Debian
sudo apt install aria2

export BINANCE_DATATOOL_ARCHIVE_HOME="$HOME/crypto_data/binance_archive"

binance-datatool --help

Try it

# List USDT-quoted spot symbols, excluding stablecoins
binance-datatool list-symbols spot --quote USDT --exclude-stables

# Download daily 1m klines
binance-datatool list-symbols spot --quote USDT --exclude-stables \
  | binance-datatool download spot --type klines --interval 1m

# Verify integrity
binance-datatool verify spot --type klines --interval 1m BTCUSDT

Supported Data Types

Category Types
Trade data klines, aggTrades, trades
Derivatives fundingRate, liquidationSnapshot, metrics
Order book bookDepth, bookTicker
Index data indexPriceKlines, markPriceKlines, premiumIndexKlines

Each type is available in daily or monthly partitions. Kline types support all standard intervals (1m 3m 5m 15m 30m 1h 2h 4h 6h 8h 12h 1d 3d 1w 1mo).

CLI Overview

The entry point is binance-datatool. All data commands are available directly on the root app:

Command Description
list-symbols List available symbols on the remote archive
list-files List archive files for given symbols
download Download new or updated archive files
verify Verify files against SHA256 checksums

[!TIP] Every command accepts symbols from stdin or as positional args, making it trivial to compose pipelines:

binance-datatool list-symbols um --quote USDT \
  | binance-datatool download um --type klines --interval 1m

Run binance-datatool --help for the full option reference.

Architecture

CLI Layer        Thin Typer commands (argument parsing, output formatting)
    │
Workflow Layer   Business logic (diff computation, verification protocol)
    │
Archive Layer    S3 communication (HTTP listing, aria2 downloading, checksums)
    │
Common Layer     Shared types, enums, constants, and utilities

See docs/architecture.md for a detailed design overview.

Documentation

Document Description
Architecture Layered design, data flow, and key decisions
Module Reference Per-subpackage API reference
Extending How to add commands, enums, workflows, and tests
Testing Guide Test organization and conventions
Agent Skill Packaged skill for agents

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

binance_datatool-0.1.1.tar.gz (402.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

binance_datatool-0.1.1-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file binance_datatool-0.1.1.tar.gz.

File metadata

  • Download URL: binance_datatool-0.1.1.tar.gz
  • Upload date:
  • Size: 402.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for binance_datatool-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3ed1d39f096b072b84d7010b9850d1eb3b741301d059591c460c50151cd657fc
MD5 71e706be3baa90e7560bb546e2b5722f
BLAKE2b-256 dd9f7a0ee6f553a7486d0343e9536c9698a4db163b40cf16f1160b9538c1082d

See more details on using hashes here.

Provenance

The following attestation bundles were made for binance_datatool-0.1.1.tar.gz:

Publisher: publish.yml on lostleaf/binance-datatool

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file binance_datatool-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for binance_datatool-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cafc2c3dcc49a6023da6b69a9160edef6ba909704e886b05d6d461fc94a996b1
MD5 d373121f78975fab4ae9454cc58d9ee3
BLAKE2b-256 6143f686afccf1072e523c0d1fa19597e5f90afb9ee99e3307ff40bc22979ddc

See more details on using hashes here.

Provenance

The following attestation bundles were made for binance_datatool-0.1.1-py3-none-any.whl:

Publisher: publish.yml on lostleaf/binance-datatool

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page