Tiingo Python Client

Tiingo Python is a client library for the Tiingo financial data platform. It provides access to Tiingo's RESTful and Real-Time Data API, which includes support for:

• Stock Market Ticker Closing Prices + Metadata: Data includes full distribution details and is validated using a proprietary EOD Price Engine.
• Curated News: Access to top financial news sources and curated blogs, with stories tagged by Tiingo's algorithms.

Before submitting a pull request, ensure your code adheres to project standards by running flake8 for linting and tox for multi-version Python testing. You can also run the standard test suite via setup.py or py.test.

Note: You must have a valid TIINGO_API_KEY exported in your environment for the tests to make valid API calls.

$ flake8 tiingo tests
$ python setup.py test
$ py.test
$ tox

To run tests, you need a valid TIINGO_API_KEY exported as an environment variable. If you regenerate fixtures by removing them from tests/fixtures, the new fixtures may contain your embedded API key. Use the provided tool to scrub the API key from the newly created test fixtures.

# Set the API key for testing
$ export TIINGO_API_KEY='...insert api key here...'

# Regenerate a fixture
$ rm tests/fixtures/NAME.yaml
$ py.test

# Remove the API key from the new test fixtures
$ ./tools/api_key_tool.py

The preferred method to install Tiingo Python is using pip, which ensures you always have the most recent stable release.

$ pip install tiingo

You can install Tiingo Python from source by cloning the repository or downloading the tarball, then running the setup script.

# Clone the repository
$ git clone git://github.com/hydrosquall/tiingo-python

# OR download the tarball
$ curl -OL https://github.com/hydrosquall-python/tiingo/tarball/master

# Install from the source directory
$ python setup.py install

When submitting a pull request, ensure the following requirements are met:

• Include tests for your changes.
• Update documentation if new functionality is added (include docstrings and update README.rst).
• Ensure compatibility with Python 2.7, 3.6, and 3.7 (verified via GitHub Action checks).

To contribute to the tiingo repository, follow these steps to set up a local development environment using a virtualenv:

1. Fork the repository on GitHub.
2. Clone your fork locally.
3. Create a virtualenv and install your local copy in development mode using python setup.py develop.
4. Create a new branch for your changes.
5. Verify changes using flake8, tox, and the test suite.
6. Push your branch to GitHub and submit a pull request.

$ git clone git@github.com:your_name_here/tiingo-python.git
$ mkvirtualenv tiingo-python
$ cd tiingo-python/
$ python setup.py develop
$ git checkout -b name-of-your-bugfix-or-feature

You can initialize the TiingoClient using an environment variable or a configuration dictionary.

Using Environment Variables

If you set TIINGO_API_KEY in your environment variables (e.g., in your .bash_profile), you can initialize the client without arguments:

from tiingo import TiingoClient
client = TiingoClient()

Using a Configuration Dictionary

If you prefer not to use environment variables, pass a dictionary containing your api_key. You can also enable session to reuse the same HTTP Session across API calls for better performance.

from tiingo import TiingoClient

config = {
    'api_key': "MY_SECRET_API_KEY",
    'session': True
}
client = TiingoClient(config)

Install the core library using pip:

pip install tiingo

If you want to receive results in pandas DataFrame or Series format, install it with the pandas optional dependency:

pip install tiingo[pandas]

To use the Tiingo API, you must first initialize a TiingoClient. You can do this in two ways:

1. Environment Variable: Set TIINGO_API_KEY in your environment (e.g., in your .bash_profile). If this is set, you can initialize the client without arguments.
2. Configuration Dictionary: Pass a dictionary to TiingoClient containing your api_key.

You can also include 'session': True in your configuration dictionary to reuse the same HTTP Session across API calls, which improves performance.

from tiingo import TiingoClient

# Option 1: Using environment variable TIINGO_API_KEY
client = TiingoClient()

# Option 2: Using a configuration dictionary
config = {
    'api_key': "MY_SECRET_API_KEY",
    'session': True  # Enables HTTP session reuse for better performance
}
client = TiingoClient(config)