.. _API documentation:

API documentation
=================

All the api points are available through the `timeseries` object. As in:

.. highlight:: python
.. code-block:: python

 from tshistory.api import timeseries
 tsa = timeseries('http://refinery.datascience.com')
 ts = tsa.get('banana-spot-price')

The available methods are the same and behave the same wether you use
an http uri or a direct postgres uri.

The methods description below appear to belong to the `mainsource`
object, which talks directly to postgres. This is an unimportant
implementation detail.

.. toctree::
   :maxdepth: 1

   base_series
   search_and_baskets
   groups
   supervision
   formulas
   excel
   dashboards
   formula_cache
   tasks