Quantopian API Documentation
============================


    This project is not supported nor endorsed by `Quantopain <https://www.quantopian.com>`__.


|build| |docs| |pypi| |downloads| |github_release| |requirements| |coverage| |issues| |license|


--------------

This project is alpha and is actively being developed.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Installation
------------

.. code:: bash

    pip install quantopian


Or to manually install, execute the following commands:


.. code:: bash

    git clone https://github.com/Gitlitio/quantopian-api.git
    cd quantopian-api/
    python setup.py install

--------------


Usage
-----

For full API usage documentation, refer to the `API <api.html>`__

--------------


Changelog
---------

v0.0.1a0 - 08/05/2016
^^^^^^^^^^^^^^^^^^^^^

-  Initial pre-release

--------------


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

--------------


Site Map
--------
.. toctree::

    api


.. |build| image:: https://img.shields.io/travis/Gitlitio/quantopian-api.svg
   :alt: Build Status
   :target: https://travis-ci.org/Gitlitio/quantopian-api

.. |docs| image:: https://readthedocs.org/projects/quantopian-api/badge/?version=latest
   :alt: Documentation Status
   :target: http://quantopian-api.readthedocs.io/en/latest/?badge=latest

.. |pypi| image:: https://img.shields.io/pypi/v/quantopian.svg
   :alt: PyPi Version
   :target: https://pypi.python.org/pypi/quantopian/

.. |requirements| image:: https://img.shields.io/requires/github/Gitlitio/quantopian-api.svg
   :alt: Requires.io
   :target: https://requires.io/github/Gitlitio/quantopian-api/requirements/?branch=master

.. |coverage| image:: https://img.shields.io/codecov/c/github/Gitlitio/quantopian-api.svg
   :alt: Codecov.io
   :target: https://codecov.io/gh/Gitlitio/quantopian-api

.. |github_release| image:: https://img.shields.io/github/release/Gitlitio/quantopian-api.svg
   :alt: Github Releases
   :target: https://github.com/Gitlitio/quantopian-api/releases

.. |issues| image:: https://img.shields.io/github/issues/Gitlitio/quantopian-api.svg
   :alt: Github Issues
   :target: https://github.com/Gitlitio/quantopian-api/issues

.. |license| image:: https://img.shields.io/github/license/Gitlitio/quantopian-api.svg
   :alt: License
   :target: https://github.com/Gitlitio/quantopian-api/blob/master/LICENSE

.. |downloads| image:: https://img.shields.io/pypi/dm/quantopian.svg
   :alt: PyPi Downloads
   :target: https://pypi.python.org/pypi/quantopian/