Quantopian's community platform is shutting down. Please read this post for more information and download your code.
Back to Community
Where to find the full Quantopian API documentation
Ueli Hofstetter
posted Feb 24, 2018
API

Coming back to Quantopian after a while and finding that the API has become more sophisticated (which is a good thing), I am struggling to find my way around. My main frustration is that I cannot find a comprehensive but succinct API documentation, which I am used to from other languages and frameworks. Just to give you an example: The CustomFilter class, which I consider to be quite important is not documented in the API reference (https://www.quantopian.com/help) and the only documentation I could find was an example in an old forum post (https://www.quantopian.com/posts/custom-filter-for-stocks-in-a-list).

Wouldn't it be possible to provide the same kind of API documentation available for zipline (http://www.zipline.io/appendix.html) for the Quantopian specific packages, classes and functions as well?

4 responses
Grant Kiehne
Feb 24, 2018

https://www.quantopian.com/tutorials/pipeline#lesson10

Not exactly what you are asking for but perhaps still helpful.

Nick Blanchet
Feb 25, 2018

I've found going to the open source python code most helpful to really understanding what is going on.

https://github.com/quantopian/zipline
alphalens, pyfolio, emperyical are helpful as well (also on github)

Unfortunately, optimize and a handful of others are not super well documented nor open source so I generally search the forums for examples that I can learn from.

Hope that helps.

Grant Kiehne
Feb 25, 2018

I was told by Q support that the Optimize API should eventually be open source. The QTradableUS will be closed source, if I understood correctly. Details on the risk model will be in a forthcoming white paper, but I gathered that there is no commitment to open source the code.

Ueli Hofstetter
Feb 26, 2018

Thanks to both of you!

About Quantopian
Careers
Community
Events
Documentation
Academia
Lectures
Status
Facebook
Twitter
LinkedIn
YouTube
Terms of Use
Privacy Policy

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.