def order(symbol,quantity,orderType,limitPrice,stopPrice,trigger,side,timeInForce,extendedHours):
"""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 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 trigger: Either 'immediate' or 'stop'
:type trigger: str
:param side: Either 'buy' or 'sell'
:type side: str
: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: 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()
stopPrice = float(stopPrice)
limitPrice = float(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': helper.get_device_token(),
'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_option_limit(price, symbol, quantity, expirationDate, strike, optionType='both', timeInForce='gfd'):
"""Submits a limit order for an option. i.e. place a short call or a short put.
:param price: The limit price to trigger a sell of the option.
:type price: int
:param symbol: The stock ticker of the stock to trade.
:type symbol: str
:param quantity: The number of options to sell.
:type quantity: int
:param expirationDate: The expiration date of the option in 'YYYY-MM-DD' format.
:type expirationDate: str
:param strike: The strike price of the option.
:type strike: float
:param optionType: This should be 'call' or 'put'
:type optionType: str
: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 options, \
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
optionID = helper.id_for_option(symbol,expirationDate,strike,optionType)
payload = {
'account': profiles.load_account_profile(info='url'),
'direction': 'credit',
'time_in_force': timeInForce,
'legs': [
{'position_effect': 'open', 'side' : 'sell', 'ratio_quantity': 1, 'option': urls.option_instruments(optionID) },
],
'type': 'limit',
'trigger': 'immediate',
'price': price,
'quantity': quantity,
'override_day_trade_checks': False,
'override_dtbp_checks': False,
'ref_id': helper.get_device_token(),
}
url = urls.option_orders()
data = helper.request_post(url,payload, json=True)
return(data)
def order_sell_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 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]
: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 = 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 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': helper.get_device_token(),
'type': 'limit',
'stop_price': stopPrice,
'time_in_force': timeInForce,
'trigger': 'stop',
'side': 'sell'
}
url = urls.orders()
data = helper.request_post(url,payload)
return(data)
def order_sell_crypto_by_price(symbol,amountInDollars,priceType='ask_price',timeInForce='gtc'):
"""Submits a market order for a crypto by specifying the amount in dollars that you want to trade.
:param symbol: The crypto ticker of the crypto to trade.
:type symbol: str
:param amountInDollars: The amount in dollars of the crypto you want to sell.
:type amountInDollars: float
:param priceType: The type of price to get. Can be 'ask_price', 'bid_price', or 'mark_price'
:type priceType: str
: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 options, \
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
crypto_info = crypto.get_crypto_info(symbol)
ask_price = crypto.get_crypto_quote_from_id(crypto_info['id'],info=priceType)
# turn the money amount into decimal number of shares
try:
shares = amountInDollars/float(ask_price)
except:
shares = 0
payload = {
'account_id': crypto.load_crypto_profile(info="id"),
'currency_pair_id': crypto_info['id'],
'price': ask_price,
'quantity': shares,
'ref_id': helper.get_device_token(),
'side': 'sell',
'time_in_force': timeInForce,
'type': 'market'
}
url = urls.order_crypto()
data = helper.request_post(url,payload,json=True)
return(data)
def order_sell_market(symbol,quantity,timeInForce='gtc', extendedHours='false'):
"""Submits a market order to be executed immediately.
: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 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 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
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': helper.get_device_token(),
'type': 'market',
'stop_price': None,
'time_in_force': timeInForce,
'trigger': 'immediate',
'side': 'sell',
'extended_hours': extendedHours
}
url = urls.orders()
data = helper.request_post(url,payload)
return(data)
def order_sell_crypto_by_quantity(symbol,quantity,priceType='ask_price',timeInForce='gtc'):
"""Submits a market order for a crypto by specifying the decimal amount of shares to buy.
:param symbol: The crypto ticker of the crypto to trade.
:type symbol: str
:param quantity: The decimal amount of shares to sell.
:type quantity: float
:param priceType: The type of price to get. Can be 'ask_price', 'bid_price', or 'mark_price'
:type priceType: str
: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 options, \
such as the order id, the state of order (queued,confired,filled, failed, canceled, etc.), \
the price, and the quantity.
"""
crypto_info = crypto.get_crypto_info(symbol)
price = crypto.get_crypto_quote_from_id(crypto_info['id'],info=priceType)
payload = {
'account_id': crypto.load_crypto_profile(info="id"),
'currency_pair_id': crypto_info['id'],
'price': price,
'quantity': quantity,
'ref_id': helper.get_device_token(),
'side': 'sell',
'time_in_force': timeInForce,
'type': 'market'
}
url = urls.order_crypto()
data = helper.request_post(url,payload,json=True)
return(data)