Metadata-Version: 1.1
Name: tiingo
Version: 0.4.3
Summary: REST Client for Tiingo Data Platform API
Home-page: https://github.com/hydrosquall/tiingo-python
Author: Cameron Yick
Author-email: cameron.yick@enigma.com
License: MIT license
Description: =============
        Tiingo Python
        =============
        
        
        .. image:: https://img.shields.io/pypi/v/tiingo.svg?maxAge=600
                :target: https://pypi.python.org/pypi/tiingo
        
        .. image:: https://img.shields.io/codecov/c/github/hydrosquall/tiingo-python.svg?maxAge=600
             :target: https://codecov.io/gh/hydrosquall/tiingo-python
             :alt: Coverage
        
        .. image:: https://img.shields.io/travis/hydrosquall/tiingo-python.svg?maxAge=600
                :target: https://travis-ci.org/hydrosquall/tiingo-python
        
        .. image:: https://readthedocs.org/projects/tiingo-python/badge/?version=latest&maxAge=600
                :target: https://tiingo-python.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://pyup.io/repos/github/hydrosquall/tiingo-python/shield.svg?maxAge=600
             :target: https://pyup.io/repos/github/hydrosquall/tiingo-python/
             :alt: Updates
        
        
        Tiingo is a financial data platform that makes high quality financial tools available to all. Tiingo has a REST and Real-Time Data API, which this library helps you to access. Presently, the API includes support for the following endpoints:
        
        * Stock Market Ticker Closing Prices + Metadata. Data includes full distribution details and is validated using a proprietary EOD Price Engine.
        * Curated news from top financial news sources + blogs. Stories are tagged with topic tags and relevant stock tickers by Tiingo's algorithms. 
        
        
        Usage
        --------
        
        First, install the library from PyPi:
        
        .. code-block:: shell
        
           pip install tiingo
        
        Next, initialize your client. It is recommended to use an environment
        variable to initialize your client for convenience.
        
        .. code-block:: python
        
          from tiingo import TiingoClient
          # Set TIINGO_API_KEY in your environment variables in your .bash_profile, OR
          # pass a dictionary with 'api_key' as a key into the TiingoClient.
        
          client = TiingoClient()
        
        Alternately, you may use a dictionary to customize/authorize your client.
        
        .. code-block:: python
        
          config = {}
        
          # To reuse the same HTTP Session across API calls (and have better performance), include a session key.
          config['session'] = True
        
          # If you don't have your API key as an environment variable,
          # pass it in via a configuration dictionary.
          config['api_key'] = "MY_SECRET_API_KEY"
        
          # Initialize
          client = TiingoClient(config)
        
        Now you can use ``TiingoClient`` to make your API calls. (Other parameters are available for each endpoint beyond what is used in the below examples, inspect the docstring for each function for details.).
        
        .. code-block:: python
          
          # Get Ticker
          ticker_metadata = client.get_ticker_metadata("GOOGL")
        
          # Get latest prices, based on 3+ sources as JSON, sampled weekly
          ticker_price = client.get_ticker_price("GOOGL", frequency="weekly")
        
          # Get historical GOOGL prices from August 2017 as JSON, sampled daily
          historical_prices = client.get_ticker_price("GOOGL",
                                                      fmt='json',
                                                      startDate='2017-08-01',
                                                      endDate='2017-08-31',
                                                      frequency='daily')
        
          # Check what tickers are available, as well as metadata about each ticker
          # including supported currency, exchange, and available start/end dates.
          tickers = client.list_stock_tickers()
        
          # Get news articles about given tickers or search terms from given domains
          articles = client.get_news(tickers=['GOOGL', 'APPL'], 
                                      tags=['Laptops'], 
                                      sources=['washingtonpost.com'],
                                      startDate='2017-01-01',
                                      endDate='2017-08-31')
        
        
        Further Docs
        --------
        
        * Official Tiingo Documentation: https://api.tiingo.com
        * Tiingo-Python Documentation (Under Construction): https://tiingo-python.readthedocs.io.
        
        Features
        --------
        
        * Easy programmatic access to Tiingo API
        * Reuse requests session across API calls for better performance
        * On most methods, pass in `fmt="object"` as a keyword to have your responses come back as `NamedTuples`, which should have a lower memory impact than regular Python dictionaries.
        
        Roadmap:
        --------
        
        * Client-side validation of tickers
        * Data validation of returned responses 
        * Case insensitivity for ticker names
        * More documentation / code examples
        
        Feel free to file a PR that implements any of the above items.
        
        Credits
        ---------
        
        * Many thanks to Rishi Singh for creating Tiingo.
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        =======
        History
        =======
        
        0.4.0 (2017-10-22)
        ------------------
        
        * Make tests run in 1/10th the time with ``vcr.py`` (@condemil #32)
        * Add support for returning python objects instead of dictionaries (@BharatKalluri #33)
        
        
        0.3.0 (2017-09-17)
        ------------------
        
        * Add support for listing all tickers + date ranges
        * Add support for interacting with the ``/news`` API
        * Improve logging of REST client errors
        
        
        0.2.0 (2017-09-01)
        ------------------
        
        * Improve test coverage of tickers endpoint
        * Deprecate the Mutual Funds endpoint
        
        0.1.0 (2017-08-24)
        ------------------
        
        * First release on PyPI.
        
Keywords: tiingo,finance,stocks
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
