tickerdax 0.0.29

A python client for tickerdax.com with a built-in caching system.

TickerDax Client

A python package that interfaces with the tickerdax.com REST and websockets API. It handles common data operations like batch downloading data, streaming real-time data, and caching data locally to minimize network requests.

Installation

You can install this package with pip by running the command below.

pip install tickerdax

Docker Dependency

This client interfaces with a redis docker container. In order for the package to work, you must first install docker. Here are instructions per platform.

Mac

Instructions

Linux

Instructions

Windows

Note on windows you must first install WSL then you can install docker. Instructions

Python Examples

Here is a basic example of getting historical data using the python SDK.

Get historical data

from pprint import pprint
from datetime import datetime, timezone
from tickerdax.client import TickerDax

client = TickerDax()
pprint(client.get_route(
    route='predictions/ml-order-book-model-1',
    symbols=["BTC"],
    start=datetime.now(tz=timezone.utc),
    end=datetime.now(tz=timezone.utc)
))

Note that if this data doesn't exist in your cache, the data will be fetched from the REST API. All subsequent calls to the same data will only be from the cache and not the REST API. This is designed give you lighting fast responses and ultimately deliver data to you a cheaper cost.

Stream realtime data

This is how you can stream data to your cache. This will run indefinitely and fill your local cache as new data is available.

client.stream(
    routes={
        'predictions/ml-order-book-model-1': ['BTC', 'LTC'],
    },
)

In another process you can call client.get_route() as many times you like or whenever your app re-evaluates. The data will be available once it is updated by the stream.

CLI

The package also has a command line interface.

 _____  ___   ____  _  __ _____  ____   ____      _    __  __
|_   _||_ _| / ___|| |/ /| ____||  _ \ |  _ \    / \   \ \/ /
  | |   | | | |    | ' / |  _|  | |_) || | | |  / _ \   \  / 
  | |   | | | |___ | . \ | |___ |  _ < | |_| | / ___ \  /  \ 
  |_|  |___| \____||_|\_\|_____||_| \_\|____/ /_/   \_\/_/\_\
                                                             

                                                                                
 Usage: callback [OPTIONS] COMMAND [ARGS]...                                    
                                                                                
 TickerDax CLI 0.0.29. This tool interfaces with the tickerdax.com REST and     
 websockets APIs. Ithandles common data operations like batch downloading,      
 streaming, and caching datalocally to minimize network requests.               
                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version                                                                    │
│ --install-completion          Install completion for the current shell.      │
│ --show-completion             Show completion for the current shell, to copy │
│                               it or customize the installation.              │
│ --help                        Show this message and exit.                    │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create-config  Creates a new ticker dax config.                              │
│ download       Downloads data from the routes with the time interval         │
│                specified in your config.                                     │
│ list-routes    Lists all routes available to download or stream.             │
│ stream         Streams data from the routes specified in your config.        │
╰──────────────────────────────────────────────────────────────────────────────╯

Environment Variables

Name	Description
TICKERDAX_CONFIG	A file path to the config file for the CLI.
TICKERDAX_EMAIL	Your email linked to your tickerdax.com account.
TICKERDAX_REST_API_KEY	Your REST API created with your tickerdax.com account.
TICKERDAX_WEBSOCKET_API_KEY	Your websocket API created with your tickerdax.com account.
TICKERDAX_CACHE_ROOT	An alternative persistent cache location on disk. By default this is written into a tickerdax_cache folder in your system's temp folder.
TICKERDAX_REDIS_SERVER_ADDRESS	An alternative redis server address. Can be useful if redis is on another address besides localhost.
TICKERDAX_REDIS_SERVER_PORT	An alternative redis server port. Can be useful if redis needs to user another port besides 6379.