def order(symbol, quantity, orderType, trigger, side, limitPrice = None, stopPrice = None, timeInForce = 'gtc', extendedHours = False):
"""A generic order function. All parameters must be supplied.
:param symbol: The stock ticker of the stock to sell.
:type symbol: str
:param quantity: The number of stocks to sell.
:type quantity: int
:param orderType: Either 'market' or 'limit'
:type orderType: str
:param trigger: Either 'immediate' or 'stop'
:type trigger: str
:param side: Either 'buy' or 'sell'
:type side: str
:param limitPrice: The price to trigger the market order.
:type limitPrice: float
:param stopPrice: The price to trigger the limit or market order.
:type stopPrice: float
:param timeInForce: Changes how long the order will be in effect for. 'gtc' = good until cancelled. \
'gfd' = good for the day. 'ioc' = immediate or cancel. 'opg' execute at opening.
:type timeInForce: str
:param extendedHours: Premium users only. Allows trading during extended hours. Should be true or false.
:type extendedHours: Optional[str]
:returns: Dictionary that contains information regarding the purchase or selling of stocks, \
such as the order id, the state of order (queued,confired,filled, failed, canceled, etc.), \
the price, and the quantity.
"""
try:
symbol = symbol.upper().strip()
except AttributeError as message:
print(message)
return None
if stopPrice:
stopPrice = helper.round_price(stopPrice)
if limitPrice:
limitPrice = helper.round_price(limitPrice)
else:
limitPrice = helper.round_price(stocks.get_latest_price(symbol)[0])
payload = {
'account': profiles.load_account_profile(info='url'),
'instrument': stocks.get_instruments_by_symbols(symbol, info='url')[0],
'symbol': symbol,
'price': limitPrice,
'quantity': quantity,
'ref_id': str(uuid4()),
'type': orderType,
'stop_price': stopPrice,
'time_in_force': timeInForce,
'trigger': trigger,
'side': side,
'extended_hours': extendedHours
}
url = urls.orders()
data = helper.request_post(url, payload)
return(data)
def order_sell_stop_limit(symbol,
quantity,
limitPrice,
stopPrice,
timeInForce='gtc',
extendedHours=False):
"""Submits a stop order to be turned into a limit order once a certain stop price is reached.
:param symbol: The stock ticker of the stock to sell.
:type symbol: str
:param quantity: The number of stocks to sell.
:type quantity: int
:param limitPrice: The price to trigger the market order.
:type limitPrice: float
:param stopPrice: The price to trigger the limit order.
:type stopPrice: float
:param timeInForce: Changes how long the order will be in effect for. 'gtc' = good until cancelled. \
'gfd' = good for the day. 'ioc' = immediate or cancel. 'opg' execute at opening.
:type timeInForce: Optional[str]
:param extendedHours: Premium users only. Allows trading during extended hours. Should be true or false.
:type extendedHours: Optional[str]
:returns: Dictionary that contains information regarding the selling of stocks, \
such as the order id, the state of order (queued,confired,filled, failed, canceled, etc.), \
the price, and the quantity.
"""
try:
symbol = symbol.upper().strip()
latestPrice = helper.round_price(stocks.get_latest_price(symbol)[0])
stopPrice = helper.round_price(stopPrice)
limitPrice = helper.round_price(limitPrice)
except AttributeError as message:
print(message)
return None
if (latestPrice < stopPrice):
print('Error: stopPrice must be below the current price.')
return (None)
payload = {
'account': profiles.load_account_profile(info='url'),
'instrument': stocks.get_instruments_by_symbols(symbol, info='url')[0],
'symbol': symbol,
'price': limitPrice,
'quantity': quantity,
'ref_id': str(uuid4()),
'type': 'limit',
'stop_price': stopPrice,
'time_in_force': timeInForce,
'trigger': 'stop',
'side': 'sell',
'extended_hours': extendedHours
}
url = urls.orders()
data = helper.request_post(url, payload)
return (data)
def get_order_info(orderID):
"""Returns the information for a single order.
:param orderID: The ID associated with the order. Can be found using get_all_orders(info=None) or get_all_orders(info=None).
:type orderID: str
:returns: Returns a list of dictionaries of key/value pairs for the order.
"""
url = urls.orders(orderID)
data = helper.request_get(url)
return (data)
def get_all_orders(info=None):
"""Returns a list of all the orders that have been processed for the account.
:param info: Will filter the results to get a specific value.
:type info: Optional[str]
:returns: Returns a list of dictionaries of key/value pairs for each order. If info parameter is provided, \
a list of strings is returned where the strings are the value of the key that matches info.
"""
url = urls.orders()
data = helper.request_get(url, 'pagination')
return (helper.filter(data, info))
def get_all_open_orders(info=None):
"""Returns a list of all the orders that are currently open.
:param info: Will filter the results to get a specific value.
:type info: Optional[str]
:returns: Returns a list of dictionaries of key/value pairs for each order. If info parameter is provided, \
a list of strings is returned where the strings are the value of the key that matches info.
"""
url = urls.orders()
data = helper.request_get(url, 'pagination')
data = [item for item in data if item['cancel'] is not None]
return (helper.filter(data, info))
def order_buy_stop_limit(symbol,quantity,limitPrice,stopPrice,timeInForce='gtc'):
"""Submits a stop order to be turned into a limit order once a certain stop price is reached.
:param symbol: The stock ticker of the stock to purchase.
:type symbol: str
:param quantity: The number of stocks to buy.
:type quantity: int
:param limitPrice: The price to trigger the market order.
:type limitPrice: float
:param stopPrice: The price to trigger the limit order.
:type stopPrice: float
:param timeInForce: Changes how long the order will be in effect for. 'gtc' = good until cancelled. \
'gfd' = good for the day. 'ioc' = immediate or cancel. 'opg' execute at opening.
:type timeInForce: Optional[str]
:returns: Dictionary that contains information regarding the purchase of stocks, \
such as the order id, the state of order (queued,confired,filled, failed, canceled, etc.), \
the price, and the quantity.
"""
try:
symbol = symbol.upper().strip()
latestPrice = float(stocks.get_latest_price(symbol)[0])
stopPrice = float(stopPrice)
limitPrice = float(limitPrice)
except AttributeError as message:
print(message)
return None
if (latestPrice > stopPrice):
print('Error: stopPrice must be above the current price.')
return(None)
payload = {
'account': profiles.load_account_profile(info='url'),
'instrument': stocks.get_instruments_by_symbols(symbol,info='url')[0],
'symbol': symbol,
'price': limitPrice,
'quantity': quantity,
'ref_id': helper.get_device_token(),
'type': 'limit',
'stop_price': stopPrice,
'time_in_force': timeInForce,
'trigger': 'stop',
'side': 'buy'
}
url = urls.orders()
data = helper.request_post(url,payload)
return(data)
def cancel_all_open_orders():
"""Cancels all open orders.
:returns: The list of orders that were cancelled.
"""
url = urls.orders()
items = helper.request_get(url, 'pagination')
items = [item['id'] for item in items if item['cancel'] is not None]
for item in items:
cancel_url = urls.cancel(item)
data = helper.request_post(cancel_url)
print('All Orders Cancelled')
return (items)
def order_buy_market(symbol,
quantity,
timeInForce='gtc',
extendedHours='false'):
"""Submits a market order to be executed immediately.
:param symbol: The stock ticker of the stock to purchase.
:type symbol: str
:param quantity: The number of stocks to buy.
:type quantity: int
:param timeInForce: Changes how long the order will be in effect for. 'gtc' = good until cancelled. \
'gfd' = good for the day. 'ioc' = immediate or cancel. 'opg' execute at opening.
:type timeInForce: Optional[str]
:param extendedHours: Premium users only. Allows trading during extended hours. Should be true or false.
:type extendedHours: str
:returns: Dictionary that contains information regarding the purchase of stocks, \
such as the order id, the state of order (queued,confired,filled, failed, canceled, etc.), \
the price, and the quantity.
"""
try:
symbol = symbol.upper().strip()
except AttributeError as message:
print(message)
return None
payload = {
'account': profiles.load_account_profile(info='url'),
'instrument': stocks.get_instruments_by_symbols(symbol, info='url')[0],
'symbol': symbol,
'price': float(stocks.get_latest_price(symbol)[0]),
'quantity': quantity,
'ref_id': str(uuid4()),
'type': 'market',
'stop_price': None,
'time_in_force': timeInForce,
'trigger': 'immediate',
'side': 'buy',
"extended_hours": extendedHours
}
url = urls.orders()
data = helper.request_post(url, payload)
return (data)
def order_sell_limit(symbol,quantity,limitPrice,timeInForce='gtc'):
"""Submits a limit order to be executed once a certain price is reached.
:param symbol: The stock ticker of the stock to sell.
:type symbol: str
:param quantity: The number of stocks to sell.
:type quantity: int
:param limitPrice: The price to trigger the sell order.
:type limitPrice: float
:param timeInForce: Changes how long the order will be in effect for. 'gtc' = good until cancelled. \
'gfd' = good for the day. 'ioc' = immediate or cancel. 'opg' execute at opening.
:type timeInForce: Optional[str]
:returns: Dictionary that contains information regarding the selling of stocks, \
such as the order id, the state of order (queued,confired,filled, failed, canceled, etc.), \
the price, and the quantity.
"""
try:
symbol = symbol.upper().strip()
limitPrice = helper.round_price(limitPrice)
except AttributeError as message:
print(message)
return None
payload = {
'account': profiles.load_account_profile(info='url'),
'instrument': stocks.get_instruments_by_symbols(symbol,info='url')[0],
'symbol': symbol,
'price': limitPrice,
'quantity': quantity,
'ref_id': str(uuid4()),
'type': 'limit',
'stop_price': None,
'time_in_force': timeInForce,
'trigger': 'immediate',
'side': 'sell'
}
url = urls.orders()
data = helper.request_post(url,payload)
return(data)
def find_orders(**arguments):
"""Returns a list of orders that match the keyword parameters.
:param arguments: Variable length of keyword arguments. EX. find_orders(symbol='FB',cancel=None,quantity=1)
:type arguments: str
:returns: Returns a list of orders.
"""
url = urls.orders()
data = helper.request_get(url, 'pagination')
if (len(arguments) == 0):
return (data)
for item in data:
item['quantity'] = str(int(float(item['quantity'])))
if 'symbol' in arguments.keys():
arguments['instrument'] = stocks.get_instruments_by_symbols(
arguments['symbol'], info='url')[0]
del arguments['symbol']
if 'quantity' in arguments.keys():
arguments['quantity'] = str(arguments['quantity'])
stop = len(arguments.keys()) - 1
list_of_orders = []
for item in data:
for i, (key, value) in enumerate(arguments.items()):
if key not in item:
print(helper.error_argument_not_key_in_dictionary(key))
return ([None])
if value != item[key]:
break
if i == stop:
list_of_orders.append(item)
return (list_of_orders)
