You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP →

Book a Demo Install Sign in

intrinio

Package Overview

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

intrinio

Intrinio API client

0.2.1

PyPI

Maintainers: 1

intrinio

|Build Status|

Unofficial Intrinio API client for Python. It gives easy access to financial data.

Setup

Install this package by using the pip tool:

.. code:: bash

pip install intrinio

Before retrieving data using the package the API username and password has to be configured, either by setting the username and password attributes of the intrinio package:

.. code:: python

import intrinio
intrinio.client.username = 'USERNAME_FROM_INTRINIO'
intrinio.client.password = 'PASSWORD_FROM_INTRINIO'

Or by setting the system environment variables:

INTRINIO_USERNAME
INTRINIO_PASSWORD

Quick start

Install the intrinio package, import it and set username and password as above first.

Get prices starting at 2016-01-01 for Apple:

.. code:: python

intrinio.prices('AAPL', start_date='2016-01-01')

Get yearly fundamentals including PE ratio, net debt, total capital and over 100 other variables for Apple:

.. code:: python

intrinio.financials('AAPL')

Get company information about Google:

.. code:: python

intrinio.companies('GOOG')

Get company information about Google using the low level get function:

.. code:: python

intrinio.get('companies', identifier='GOOG')

Get cik, lei, name and ticker of companies with "Bank" in their company name:

.. code:: python

intrinio.companies(query='Bank')

Screen stocks with PE higher than 10:

.. code:: python

intrinio.screener('pricetoearnings~gt~10')

Usage

There are a high- and low level functions used to access the Intrinio API.

The high level functions are mostly simple wrappers of the get function that retrieves all data with optional parameters to filter the data. They might also do some data conversion like for example the prices endpoint where the date column is used as the index for the Pandas DataFrame.

For more information about available endpoints and their parameters, see Intrinio API documentation at: Intrinio Docs <http://docs.intrinio.com/>__

Low level functions


-  get(endpoint, \*\*parameters):

   Get complete dataset from an endpoint using optional query
   parameters.

   Args:

   ::

       endpoint: Intrinio endpoint, for example: companies
       parameters: Optional query parameters

   Returns: Dataset as a Pandas DataFrame

-  get\_page(endpoint, page\_number=1, page\_size=None, \*\*parameters):

   Get a dataset page from an endpoint using optional query parameters.

   Args:

   ::

       endpoint: Intrinio endpoint, for example: companies
       page_number: Optional page number where 1 is first page (default 1)
       page_size: Optional page size (default max page size for the endpoint)
       parameters: Optional query parameters

   Returns: Dataset page as a Pandas DataFrame with an additional
   total\_pages attribute

High level functions

companies(identifier=None, query=None):

Get companies with optional filtering using parameters.

Args:

identifier: Identifier for the legal entity or a security associated
    with the company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
query: Search of company name or ticker symbol