Skip to main content

Python client for tardis.dev - historical tick-level cryptocurrency market data replay API.

Project description

tardis-client

PyPi Python Code style: black

tardis-client is deprecated and frozen.

This package has been replaced by tardis-dev, the unified Python package for replay, dataset downloads, exchange metadata, and cache helpers.

This 1.4.1 release does not introduce new features. Its purpose is to point existing tardis-client users to the migration path.

Migrate To tardis-dev

Migration guide:

Install commands:

pip uninstall tardis-client
pip install tardis-dev

Old To New

Replay

Old:

from tardis_client import TardisClient, Channel

client = TardisClient(api_key="YOUR_API_KEY")

async for item in client.replay(
    exchange="bitmex",
    from_date="2019-06-01",
    to_date="2019-06-02",
    filters=[Channel("trade", ["XBTUSD"])],
):
    print(item)

New:

from tardis_dev import Channel, replay

async for item in replay(
    exchange="bitmex",
    from_date="2019-06-01",
    to_date="2019-06-02",
    filters=[Channel("trade", ["XBTUSD"])],
    api_key="YOUR_API_KEY",
):
    print(item)

Cache Cleanup

Old:

from tardis_client import TardisClient

client = TardisClient()
client.clear_cache()

New:

from tardis_dev import clear_cache

clear_cache()

Dataset Downloads

The replacement package also includes dataset downloads directly from the top level:

from tardis_dev import download_datasets

download_datasets(
    exchange="deribit",
    data_types=["trades"],
    symbols=["BTC-PERPETUAL"],
    from_date="2024-01-01",
    to_date="2024-01-02",
    api_key="YOUR_API_KEY",
)

Support Status

  • no new features will be added to tardis-client
  • new Python development continues in tardis-dev
  • future migration guidance will live in the docs, not in this package

License

MPL-2.0

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

tardis_client-1.4.1.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

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

tardis_client-1.4.1-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file tardis_client-1.4.1.tar.gz.

File metadata

  • Download URL: tardis_client-1.4.1.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.12.4 Darwin/24.6.0

File hashes

Hashes for tardis_client-1.4.1.tar.gz
Algorithm Hash digest
SHA256 b0174e985cc5c087aa95ab3c5d00fe1521f13a40673eef75d83aae16cd26be79
MD5 33876e9ee84da12e7fdf751b0060798f
BLAKE2b-256 16e8b566c343f3abc8dcb9e10fb4c676d02841865b09db79c79af6898de2f2ff

See more details on using hashes here.

File details

Details for the file tardis_client-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: tardis_client-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.12.4 Darwin/24.6.0

File hashes

Hashes for tardis_client-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1778d38618de2a7ffbefe474e9b0e01837f034ba2da63166ffdba5a8b70bdb0b
MD5 7f45b4b26c9d625d7a494ae9ca97ad57
BLAKE2b-256 3387ff73c1a6bb844b8027476176d63af676fcccbbfcdea423cbca7e8d05ce75

See more details on using hashes here.

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