Intrinio Python SDK

WARNING: THIS IS IS A BETA - DO NOT USE IN PRODUCTION.

To request a beta access key, sign up here.

Welcome to the Intrinio API! Through our Marketplace, we offer a wide selection of financial data feeds sourced by our own proprietary processes as well as from many data vendors. The primary application of the Intrinio API is for use in third-party applications and integrations or for end-users utilizing the Excel add-in and Google Sheets add-on. The Intrinio API uses HTTPS verbs and a RESTful endpoint structure, which makes it easy to request data from Intrinio. Responses are delivered in JSON format. If you need additional help in using the API, go to our home page (https://intrinio.com) and click on the chat icon in the lower right corner.

• API version: 2.0.1
• Package version: 0.0.1

Requirements.

Python 2.7 and 3.4+

Installation & Usage

Option 1: pip install

You can install directly from GitHub:

pip install git+https://github.com/intrinio/python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/intrinio/python-sdk.git)

Then import the package:

import intrinio_sdk 

Option 2: Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import intrinio_sdk

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import intrinio_sdk
from intrinio_sdk.rest import ApiException
from pprint import pprint

intrinio_sdk.ApiClient().configuration.api_key['api-key'] = 'YOUR_API_KEY' 

company_api = intrinio_sdk.CompanyApi()

try:
    api_response = company_api.filter_companies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompanyApi->filter_companies: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-v2.intrinio.com

Class	Method	HTTP request	Description
CompanyApi	filter_companies	GET /companies/filter	Filter Companies
CompanyApi	filter_company_fundamentals	GET /companies/{identifier}/fundamentals/filter	Filter Fundamentals for a Company
CompanyApi	get_all_companies	GET /companies	Get All Companies
CompanyApi	get_all_company_filings	GET /companies/{identifier}/filings	Filings
CompanyApi	get_all_company_fundamentals	GET /companies/{identifier}/fundamentals	Get All Fundamentals for a Company
CompanyApi	get_company	GET /companies/{identifier}	Get a Company by ID
CompanyApi	get_company_data_point_number	GET /companies/{identifier}/data_point/{item}/number	Get Company Data Point (Number)
CompanyApi	get_company_data_point_text	GET /companies/{identifier}/data_point/{item}/text	Get Company Data Point (Text)
CompanyApi	get_company_historical_data	GET /companies/{identifier}/historical_data/{item}	Get Company Historical Data
CompanyApi	get_news	GET /companies/{identifier}/news	News
CompanyApi	lookup_company_fundamental	GET /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period}	Lookup a Fundamental for a Company
CompanyApi	search_companies	GET /companies/search	Search Companies
DataPointApi	get_data_point_number	GET /data_point/{identifier}/{item}/number	Get a Data Point (Number)
DataPointApi	get_data_point_text	GET /data_point/{identifier}/{item}/text	Get a Data Point (Text)
FilingApi	filter_filings	GET /filings/filter	Filter Filings
FilingApi	get_all_filings	GET /filings	Get All Filings
FilingApi	get_filing_by_id	GET /filings/{id}	Get a Filing by ID
FundamentalsApi	get_fundamental_by_id	GET /fundamentals/{id}	Get a Fundamental by ID
FundamentalsApi	get_fundamental_reported_financials	GET /fundamentals/{id}/reported_financials	Get Reported Financials for a Fundamental
FundamentalsApi	get_fundamental_standardized_financials	GET /fundamentals/{id}/standardized_financials	Get Standardized Financials for a Fundamental
FundamentalsApi	lookup_fundamental	GET /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period}	Lookup a Fundamental
HistoricalDataApi	get_historical_data	GET /historical_data/{identifier}/{item}	Get Historical Data
IndexApi	get_all_economic_indices	GET /indices/economic	Get ALl Economic Indices
IndexApi	get_all_sic_indices	GET /indices/sic	Get All SIC Indices
IndexApi	get_all_stock_market_indices	GET /indices/stock_market	Get All Stock Market Indices
IndexApi	get_economic_index_by_id	GET /indices/economic/{identifier}	Get an Economic Index by ID
IndexApi	get_economic_index_data_point_number	GET /indices/economic/{identifier}/data_point/{item}/number	Get Economic Index Data Point (Number)
IndexApi	get_economic_index_data_point_text	GET /indices/economic/{identifier}/data_point/{item}/text	Get Economic Index Data Point (Text)
IndexApi	get_economic_index_historical_data	GET /indices/economic/{identifier}/historical_data/{item}	Get Economic Index Historical Data
IndexApi	get_sic_index_by_id	GET /indices/sic/{identifier}	Get an SIC Index by ID
IndexApi	get_sic_index_data_point_number	GET /indices/sic/{identifier}/data_point/{item}/number	Get SIC Index Data Point (Number)
IndexApi	get_sic_index_data_point_text	GET /indices/sic/{identifier}/data_point/{item}/text	Get SIC Index Data Point (Text)
IndexApi	get_sic_index_historical_data	GET /indices/sic/{identifier}/historical_data/{item}	Get SIC Index Historical Data
IndexApi	get_stock_market_index_by_id	GET /indices/stock_market/{identifier}	Get a Stock Market Index by ID
IndexApi	get_stock_market_index_data_point_number	GET /indices/stock_market/{identifier}/data_point/{item}/number	Get Stock Market Index Data Point (Number)
IndexApi	get_stock_market_index_data_point_text	GET /indices/stock_market/{identifier}/data_point/{item}/text	Get Stock Market Index Data Point (Text)
IndexApi	get_stock_market_index_historical_data	GET /indices/stock_market/{identifier}/historical_data/{item}	Get Stock Market Index Historical Data
IndexApi	search_economic_indices	GET /indices/economic/search	Search Economic Indices
IndexApi	search_sic_indices	GET /indices/sic/search	Search SIC Indices
IndexApi	search_stock_markets_indices	GET /indices/stock_market/search	Search Stock Market Indices
MutualFundApi	get_all_mutual_funds	GET /mutual_funds	Get All Mutual Funds
MutualFundApi	get_mutual_fund_by_id	GET /mutual_funds/{identifier}	Get a Mutual Fund by ID
MutualFundApi	get_mutual_fund_stats	GET /mutual_funds/{identifier}/stats	Get Stats for a Mutual Fund
MutualFundApi	search_mutual_funds	GET /mutual_funds/search	Search Mutual Funds
SecurityApi	get_all_securities	GET /securities	Get All Securiites
SecurityApi	get_security_by_id	GET /securities/{identifier}	Get a Security by ID
SecurityApi	get_security_data_point_number	GET /securities/{identifier}/data_point/{item}/number	Get Security Data Point (Number)
SecurityApi	get_security_data_point_text	GET /securities/{identifier}/data_point/{item}/text	Get Security Data Point (Text)
SecurityApi	get_security_historical_data	GET /securities/{identifier}/historical_data/{item}	Get Security Historical Data
SecurityApi	get_security_stock_prices	GET /securities/{identifier}/prices	Get Stock Prices for Security
SecurityApi	screen_securities	POST /securities/screen	Screen Securities
SecurityApi	search_securities	GET /securities/search	Search Securities
StandardizedTagApi	filter_standardized_tags	GET /standardized_tags/filter	Filter Standardized Tags
StandardizedTagApi	get_all_standardized_tags	GET /standardized_tags	Get All Standardized Tags
StandardizedTagApi	get_standardized_tag_by_id	GET /standardized_tags/{tag_id}	Get a Standardized Tag by ID
StandardizedTagApi	get_standardized_tag_data_point_number	GET /standardized_tags/{id}/data_point/{identifier}/number	Get Data Point (Number) for The Standardized Tag
StandardizedTagApi	get_standardized_tag_data_point_text	GET /standardized_tags/{id}/data_point/{identifier}/text	Get Data Point (Text) for the Standardized Tag
StandardizedTagApi	get_standardized_tag_historical_data	GET /standardized_tags/{id}/historical_data/{identifier}	Get Historical Data for the Standardized Tag
StandardizedTagApi	search_standardized_tags	GET /standardized_tags/search	Search Standardized Tags
StockExchangeApi	filter_stock_exchanges	GET /stock_exchanges/filter	Filter Stock Exchanges
StockExchangeApi	get_all_stock_exchanges	GET /stock_exchanges	Get All Stock Exchanges
StockExchangeApi	get_stock_exchange_by_id	GET /stock_exchanges/{identifier}	Get Stock Exchange by ID
StockExchangeApi	get_stock_exchange_prices	GET /stock_exchanges/{identifier}/prices	Get Stock Prices by Exchange
StockExchangeApi	get_stock_exchange_securities	GET /stock_exchanges/{identifier}/securities	Get Securities by Exchange

Documentation For Models

• Company
• CompanyNews
• CompanySummary
• DataPointNumber
• DataPointText
• EconomicIndex
• EconomicIndexSummary
• Filing
• FilingSummary
• Fundamental
• FundamentalSummary
• HistoricalData
• MutualFund
• MutualFundStat
• ReportedFinancial
• ReportedTag
• SICIndex
• Security
• SecurityScreenClause
• SecurityScreenGroup
• SecurityScreenResult
• SecurityScreenResultData
• SecuritySummary
• StandardizedFinancial
• StandardizedTag
• StockExchange
• StockMarketIndex
• StockMarketIndexSummary
• StockPrice
• StockPriceSummary