def get_events(symbol, info=None): """Returns the events related to a stock that the user owns. For example, if you owned options for USO and that stock \ underwent a stock split resulting in you owning shares of newly created USO1, then that event will be returned when calling \ get_events('uso1') :param symbol: The stock ticker. :type symbol: str :param info: Will filter the results to get a specific value. :type info: Optional[str] :returns: [list] If the info parameter is provided, then the function will extract the value of the key \ that matches the info parameter. Otherwise, the whole dictionary is returned. :Dictionary Keys: * account * cash_component * chain_id * created_at * direction * equity_components * event_date * id * option * position * quantity * state * total_cash_amount * type * underlying_price * updated_at """ try: symbol = symbol.upper().strip() except AttributeError as message: print(message, file=helper.get_output()) return None payload = {'equity_instrument_id': helper.id_for_stock(symbol)} url = urls.events() data = helper.request_get(url, 'results', payload) return (helper.filter(data, info))
def get_events(symbol, info=None): """Returns the events related to a stock. :param symbol: The stock ticker. :type symbol: str :param info: Will filter the results to get a specific value. :type info: Optional[str] :returns: If the info parameter is provided, then the function will extract the value of the key \ that matches the info parameter. Otherwise, the whole dictionary is returned. """ try: symbol = symbol.upper().strip() except AttributeError as message: print(message) return None payload = {'equity_instrument_id': helper.id_for_stock(symbol)} url = urls.events() data = helper.request_get(url, 'results', payload) return (helper.filter(data, info))