API Functions

add_job

.add_job(exchange, symbol, type, mode='trades', limit='',
                   since='', auto_since='no', ping_limit=1.0)

Add trade API request job and set parameters for future use.

• exchange : Bitcoin exchange (str)
• symbol : currency symbol (str)
• type : type of API data request ('ticker' or 'trades')
• limit : limit number of trades returned in API request (int)
• since : return trades with a trade ID or timestamp greater than value (int or mm/dd/yy)
• auto_since : minimize size of returned data by only returning data from latest since value ('yes' or 'no')
• ping_limit : set rate limit for API requests (float in requests/sec)

run

.run(exchange, symbol, type)

Run API request job and return trade history as DataFrame

• exchange : Bitcoin exchange (str)
• symbol : currency symbol (str)
• type : type of API data request ('ticker' or 'trades')