The ticker object inherits from the Websocket Manager object, found here. This means that all the functions described in that document will also work here.

One of the most common areas of confusion with our code comes from mistaking what "ticker" means in the context of websockets. In finance, people often use the term tickers to describe the identifier for a certain stock or trading asset, like "BTC-USD" or "AAPL." In the context of websockets, a "tick" actually means an update - generally a change of price. The ticker manager organizes the price events you're watching across different exchanges and assets. This is true of the websocket managers we have in this module. They are each designed to organize a type of websocket connection.

Websocket connections should be used only if strictly necessary for the trading strategy. They require significantly higher CPU, bandwidth & memory usage when compared to making simple REST requests on a set interval.

Any ticker connections to the supported exchanges will give this information for each trade:

{
    'price': 51714.73, 
    'time': 1630896526.812199, 
    'trade_id': 208225105, 
    'symbol': 'BTC-USD', 
    'size': 0.0153549
}

There will also be an 'exchange_specific' tag that will give any extra information given from any exchange.

Creation

A ticker manager can be created by calling ticker = blankly.TickerManager(default_exchange, default_currency).

Because these websocket objects are designed to work across currencies and exchanges, specifying a default exchange and currency for the object to behave on can make interaction significantly simpler.

This call will also automatically switch channels to use the correct subscription for your exchange.

Arguments

Response

Example

import blankly

def price_event(message):
    """
    This callback function will be run for every single update
    
    The message variable has at least these keys:
    {
        'price': 51714.73, 
        'time': 1630896526.812199, 
        'trade_id': 208225105, 
        'symbol': 'BTC-USD', 
        'size': 0.0153549
    }
    """
    print(message)


if __name__ == "__main__":
    # Create a manager - this object can be used for managing       #  many websocket connections
    manager = blankly.TickerManager('coinbase_pro', 'BTC-USD')
    
    # This will create and start a websocket connection. It
    #  will use the defaults defined above unless overridden
    manager.create_ticker(price_event)

Functions

create_ticker(callback, log=None, override_symbol=None, override_exchange=None)

Create a new price event websocket feed.

Arguments

Response