Files
bitfinex-api-py/bfxapi/models/trade.py
2020-04-16 10:45:20 +01:00

82 lines
2.5 KiB
Python

"""
Module used to describe all of the different data types
"""
import datetime
class TradeModel:
"""
Enum used to index the different values in a raw trade array
"""
ID = 0
PAIR = 1
MTS_CREATE = 2
ORDER_ID = 3
EXEC_AMOUNT = 4
EXEC_PRICE = 5
ORDER_TYPE = 6
ORDER_PRICE = 7
MAKER = 8
FEE = 9
FEE_CURRENCY = 10
class Trade:
"""
ID integer Trade database id
PAIR string Pair (BTCUSD, ...)
MTS_CREATE integer Execution timestamp
ORDER_ID integer Order id
EXEC_AMOUNT float Positive means buy, negative means sell
EXEC_PRICE float Execution price
ORDER_TYPE string Order type
ORDER_PRICE float Order price
MAKER int 1 if true, 0 if false
FEE float Fee
FEE_CURRENCY string Fee currency
"""
SHORT = 'SHORT'
LONG = 'LONG'
def __init__(self, tid, pair, mts_create, order_id, amount, price, order_type,
order_price, maker, fee, fee_currency):
# pylint: disable=invalid-name
self.id = tid
self.pair = pair
self.mts_create = mts_create
self.date = datetime.datetime.fromtimestamp(mts_create/1000.0)
self.order_id = order_id
self.amount = amount
self.direction = Trade.SHORT if amount < 0 else Trade.LONG
self.price = price
self.order_type = order_type
self.order_price = order_price
self.maker = maker
self.fee = fee
self.fee_currency = fee_currency
@staticmethod
def from_raw_rest_trade(raw_trade):
"""
Generate a Trade object from a raw trade array
"""
# [24224048, 'tBTCUSD', 1542800024000, 1151353484, 0.09399997, 19963, None, None,
# -1, -0.000188, 'BTC']
tid = raw_trade[TradeModel.ID]
pair = raw_trade[TradeModel.PAIR]
mtsc = raw_trade[TradeModel.MTS_CREATE]
oid = raw_trade[TradeModel.ORDER_ID]
amnt = raw_trade[TradeModel.EXEC_AMOUNT]
price = raw_trade[TradeModel.EXEC_PRICE]
otype = raw_trade[TradeModel.ORDER_TYPE]
oprice = raw_trade[TradeModel.ORDER_PRICE]
maker = raw_trade[TradeModel.MAKER]
fee = raw_trade[TradeModel.FEE]
feeccy = raw_trade[TradeModel.FEE_CURRENCY]
return Trade(tid, pair, mtsc, oid, amnt, price, otype, oprice, maker,
fee, feeccy)
def __str__(self):
return "Trade '{}' x {} @ {} <direction='{}' fee={}>".format(
self.pair, self.amount, self.price, self.direction, self.fee)