Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Try Our Free AI Strategy Builder

Our AI agent helps you build LumiBot strategies. Explore what others have created, or make your own. Claim your free trial while spots last at BotSpot.trade.

Lumibot Documentation
Light Logo Dark Logo
  • Home
  • Build Bots with AI
  • GitHub
  • Discord Community
  • Getting Started
  • Lifecycle Methods
    • Summary
    • def initialize
    • def on_trading_iteration
    • def before_market_opens
    • def before_starting_trading
    • def before_market_closes
    • def after_market_closes
    • def on_abrupt_closing
    • def on_bot_crash
    • def trace_stats
    • def on_new_order
    • def on_partially_filled_order
    • def on_filled_order
    • def on_canceled_order
    • def on_parameters_updated
  • Strategy Methods
    • 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.get_portfolio_value
      • self.get_cash
      • self.get_position
      • self.get_positions
    • 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
  • Strategy Properties
    • self.cash
    • self.portfolio_value
    • self.first_iteration
    • self.is_backtesting
    • self.quote_asset
    • self.name
    • self.initial_budget
    • self.minutes_before_closing
    • self.minutes_before_opening
    • self.sleeptime
    • self.last_on_trading_iteration_datetime
    • self.timezone
    • self.pytz
    • self.unspent_money
  • Entities
    • Asset
    • Bars
    • Data
    • Order
    • Position
    • Trading Fee
    • Trading Slippage
    • Smart Limit Config
    • Chains Entity
  • Backtesting
    • How To Backtest
    • Files Generated from Backtesting
    • Backtesting Function
    • Yahoo
    • Pandas (CSV or other data)
    • Polygon.io Backtesting
    • DataBento Backtesting
    • ThetaData Backtesting
    • Tearsheet HTML
    • Trades Files
    • Indicators Files
    • Logs CSV
  • Brokers
    • Alpaca
    • Bitunix
    • Crypto Brokers (Using CCXT)
    • Interactive Brokers
    • Interactive Brokers Legacy
    • ProjectX
    • Schwab
    • Tradier
    • Tradovate
  • Reference
    • Variable Backup & Restore
    • Futures Trading
    • Smart Limit Orders
    • Environment Variables
  • Code Examples
  • Deployment Guide
  • Common Mistakes and How to Avoid Them
  • Frequently Asked Questions (FAQ)
  • Get Pre-Built Strategies
Back to top
View this page

Entities¶

Entities are the main object types that are passed around within Lumibot to place orders, get to know your positions, load data and more.

Here’s a list of the main entities in Lumibot:

Contents:

  • Asset
  • Bars
  • Data
  • Order
  • Position
  • Trading Fee
  • Trading Slippage
  • Smart Limit Config
  • Chains Entity
Next
Asset
Previous
self.unspent_money
Copyright © 2021, Lumiwealth
Made with Sphinx and @pradyunsg's Furo
Last updated on January 06, 2026