Strategy Methods

Strategy methods are the methods that you will use inside of a strategy to do things such as submit orders, get pricing data and more. We have divided them into sections for you so that you get get a sense of what each one is used for.

For a copy-and-run introduction to the most common methods, start with Strategy API Overview.

Every strategy method will be used inside of one of your functions or lifecycle methods (eg. inside of on_trading_iteration()) and is usually preceded by “self.” (eg. self.submit_order())

Check out the list of available strategy methods below:

Contents:

• Order Management
  • self.create_order
  • self.submit_order
  • self.submit_orders
  • self.cancel_order
  • self.cancel_orders
  • self.cancel_open_orders
  • self.get_selling_order
  • self.sell_all
  • self.get_order
  • self.get_orders
  • self.get_asset_potential_total
• Account Management
  • self.adjust_cash
  • self.configure_cash_financing
  • self.deposit_cash
  • self.get_portfolio_value
  • self.get_cash
  • self.get_position
  • self.get_positions
  • self.set_cash_financing_rates
  • self.withdraw_cash
• Data
  • self.get_last_price
  • self.get_last_prices
  • self.get_historical_prices
  • self.get_historical_prices_for_assets
  • self.get_quote
  • self.get_yesterday_dividend
  • self.get_next_trading_day
• Chart Functions
  • self.add_marker
  • self.add_line
  • self.get_markers_df
  • self.get_lines_df
• Parameters
  • self.get_parameters
  • self.set_parameters
• Options
  • self.get_chain
  • self.get_chains
  • self.get_greeks
  • self.get_strikes
  • self.get_expiration
  • self.get_multiplier
  • self.options_expiry_to_datetime_date
  • self.get_next_trading_day
• DateTime
  • self.get_datetime
  • self.get_timestamp
  • self.get_round_minute
  • self.get_last_minute
  • self.get_round_day
  • self.get_last_day
  • self.get_datetime_range
  • self.localize_datetime
  • self.to_default_timezone
• Miscellaneous
  • self.log_message
  • self.sleep
  • self.set_market
  • self.update_parameters
  • self.get_parameters
  • self.await_market_to_close
  • self.await_market_to_open
  • self.wait_for_order_registration
  • self.wait_for_order_execution
  • self.wait_for_orders_registration
  • self.wait_for_orders_execution
  • self.register_cron_callback