Quantopian's community platform is shutting down. Please read this post for more information and download your code.
Back to Community
documentation for get_backtest returned object?

Is there any documentation for the dir output of the object returned by get_backtest?

bt = get_backtest('5e6196c900741f46f139fed8')  

dir(bt)  

100% Time:  0:00:36|##########################################################|

['algo_id',
 'attributed_factor_returns',  
 'attrs',  
 'benchmark_security',  
 'capital_base',  
 'create_bayesian_tear_sheet',  
 'create_full_tear_sheet',  
 'create_interesting_times_tear_sheet',  
 'create_perf_attrib_tear_sheet',  
 'create_position_tear_sheet',  
 'create_returns_tear_sheet',  
 'create_simple_tear_sheet',  
 'create_txn_tear_sheet',  
 'cumulative_performance',  
 'daily_performance',  
 'end_date',  
 'factor_exposures',  
 'frames',  
 'from_stream',  
 'launch_date',  
 'orders',  
 'positions',  
 'preview',  
 'pyfolio_positions',  
 'pyfolio_transactions',  
 'recorded_vars',  
 'risk',  
 'scalars',  
 'start_date',  
 'stoppages',  
 'transactions']  
2 responses

Note that the documentation has a search feature on the left side (you can also access it by pressing /), which you can use to search for terms or methods in the docs. Sometimes, the results exist on multiple pages. If you're looking for method or attribute definitions, look for pages in the API Reference.

Disclaimer

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by Quantopian. In addition, the material offers no opinion with respect to the suitability of any security or specific investment. No information contained herein should be regarded as a suggestion to engage in or refrain from any investment-related course of action as none of Quantopian nor any of its affiliates is undertaking to provide investment advice, act as an adviser to any plan or entity subject to the Employee Retirement Income Security Act of 1974, as amended, individual retirement account or individual retirement annuity, or give advice in a fiduciary capacity with respect to the materials presented herein. If you are an individual retirement or other investor, contact your financial advisor or other fiduciary unrelated to Quantopian about whether any given investment idea, strategy, product or service described herein may be appropriate for your circumstances. All investments involve risk, including loss of principal. Quantopian makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances.

Thanks.