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.2 release does not introduce new features. Its purpose is to point existing tardis-client users to the migration path.

Migrate To tardis-dev

Migration notice:

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.2.tar.gz (15.7 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.2-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tardis_client-1.4.2.tar.gz
  • Upload date:
  • Size: 15.7 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.2.tar.gz
Algorithm Hash digest
SHA256 11147046db9d37d291fa5b9bb0087983f3b701018a0ea753ec4b097fc9d2b9a6
MD5 acf7a7fa654841c3cd363cb4afaa6feb
BLAKE2b-256 543741ce92199e74571d8bd73b3deb08372cc1837056e4611bd0c27d0f8da187

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tardis_client-1.4.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a26bab35a475605e8d43de0aea2f9691afb6e952b945bc80439f198427eb1471
MD5 607be2f382eefc298910ca57f2c0db7c
BLAKE2b-256 6d737a1cb2adb809535dbb828b00344fd2268a74363ffd03048e841810250ea6

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