AlpacaBroker¶
- class src.boatwright.Brokers.AlpacaBroker.AlpacaBroker(key=None, secret_key=None, broker_name=None, quote_symbol='USD', paper=True, debug=False)¶
Alpaca Broker
- Parameters:
key (str)
secret_key (str)
broker_name (str)
quote_symbol (str)
paper (bool)
- abstract cancel_order(order_id)¶
cancels an open order returns “success” or “fail”
- get_account_balance(base_symbol)¶
returns user account info for the specified base_symbol (i.e. how much BTC user has):
- abstract get_order_info(order_id)¶
returns order info, corresponding the to order status. i.e. filled order info will have avg_price, cost, fee, filled size etc returns order info:
order_info = { "order_id": order_status["order_id"], "status": order_status["status"], "time_opened": , "time_closed": , "completion_percentage": order_status["completion_percentage"], "filled_size": order_status["filled_size"], "avg_price": order_status["average_filled_price"], "fee": order_status["total_fees"] }
- get_product_info(base_symbol)¶
- abstract limit_order(order)¶
place limit order
- Parameters:
order (LimitOrder)
- market_order(order)¶
place market order
- Parameters:
order (MarketOrder)
- step(data_row)¶
actions on each ‘step’
- update_aum()¶
update values for cash, stock/crypto/forex etc assets, and total aum :return: None