Skip to content

Latest commit

 

History

History
226 lines (195 loc) · 17.3 KB

README.md

File metadata and controls

226 lines (195 loc) · 17.3 KB
Raw

Intrinio Python SDK

To get an API key, sign up here.

Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the Intrinio API documentation. If you need additional help in using the API, please visit the Intrinio website and click on the chat icon in the lower right corner.

  • API version: 2.1.0
  • Package version: 1.1.0

Requirements.

Python 2.7 and 3.4+

Installation

pip install intrinio-sdk

Then import the package:

import intrinio_sdk

Installation 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

Installation from python-sdk repo

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

SDK Code Examples

Code examples for Intrinio SDKs are available at https://github.com/intrinio/sdk-code-samples

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 by Company
CompanyApi get_all_companies GET /companies All Companies
CompanyApi get_all_company_news GET /companies/news All News
CompanyApi get_company GET /companies/{identifier} Lookup Company
CompanyApi get_company_data_point_number GET /companies/{identifier}/data_point/{tag}/number Data Point (Number) for Company
CompanyApi get_company_data_point_text GET /companies/{identifier}/data_point/{tag}/text Data Point (Text) for Company
CompanyApi get_company_filings GET /companies/{identifier}/filings All Filings by Company
CompanyApi get_company_fundamentals GET /companies/{identifier}/fundamentals All Fundamentals by Company
CompanyApi get_company_historical_data GET /companies/{identifier}/historical_data/{tag} Historical Data for Company
CompanyApi get_company_news GET /companies/{identifier}/news All News by Company
CompanyApi get_company_securities GET /companies/{identifier}/securities All Securities by Company
CompanyApi lookup_company_fundamental GET /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental by Company
CompanyApi search_companies GET /companies/search Search Companies
DataPointApi get_data_point_number GET /data_point/{identifier}/{tag}/number Data Point (Number)
DataPointApi get_data_point_text GET /data_point/{identifier}/{tag}/text Data Point (Text)
DataTagApi filter_data_tags GET /data_tags/filter Filter Data Tags
DataTagApi get_all_data_tags GET /data_tags All Data Tags
DataTagApi get_data_tag_by_id GET /data_tags/{identifier} Lookup Data Tag
DataTagApi search_data_tags GET /data_tags/search Search Data Tags
FilingApi filter_filings GET /filings/filter Filter Filings
FilingApi filter_notes GET /filings/notes/filter Filter SEC filing notes
FilingApi get_all_filings GET /filings All Filings
FilingApi get_all_notes GET /filings/notes Get All SEC filing notes
FilingApi get_filing_by_id GET /filings/{id} Lookup Filing
FilingApi get_note GET /filings/notes/{identifier} Get an SEC filing note by ID
FilingApi get_note_html GET /filings/notes/{identifier}/html Returns the content of an SEC filing note as originally filed
FilingApi get_note_text GET /filings/notes/{identifier}/text Returns the content of an SEC filing note stripped of HTML
FilingApi search_notes GET /filings/notes/search Search Filing Notes
FundamentalsApi get_fundamental_by_id GET /fundamentals/{id} Fundamental by ID
FundamentalsApi get_fundamental_reported_financials GET /fundamentals/{id}/reported_financials Reported Financials
FundamentalsApi get_fundamental_standardized_financials GET /fundamentals/{id}/standardized_financials Standardized Financials
FundamentalsApi lookup_fundamental GET /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental
HistoricalDataApi get_historical_data GET /historical_data/{identifier}/{tag} Historical Data
IndexApi get_all_economic_indices GET /indices/economic All Economic Indices
IndexApi get_all_sic_indices GET /indices/sic All SIC Indices
IndexApi get_all_stock_market_indices GET /indices/stock_market All Stock Market Indices
IndexApi get_economic_index_by_id GET /indices/economic/{identifier} Lookup Economic Index
IndexApi get_economic_index_data_point_number GET /indices/economic/{identifier}/data_point/{tag}/number Data Point (Number) for an Economic Index
IndexApi get_economic_index_data_point_text GET /indices/economic/{identifier}/data_point/{tag}/text Data Point (Text) for an Economic Index
IndexApi get_economic_index_historical_data GET /indices/economic/{identifier}/historical_data/{tag} Historical Data for an Economic Index
IndexApi get_sic_index_by_id GET /indices/sic/{identifier} Lookup SIC Index
IndexApi get_sic_index_data_point_number GET /indices/sic/{identifier}/data_point/{tag}/number Data Point (Number) for an SIC Index
IndexApi get_sic_index_data_point_text GET /indices/sic/{identifier}/data_point/{tag}/text Data Point (Text) for an SIC Index
IndexApi get_sic_index_historical_data GET /indices/sic/{identifier}/historical_data/{tag} Historical Data for an SIC Index
IndexApi get_stock_market_index_by_id GET /indices/stock_market/{identifier} Lookup Stock Market Index
IndexApi get_stock_market_index_data_point_number GET /indices/stock_market/{identifier}/data_point/{tag}/number Data Point (Number) for Stock Market Index
IndexApi get_stock_market_index_data_point_text GET /indices/stock_market/{identifier}/data_point/{tag}/text Data Point (Text) for Stock Market Index
IndexApi get_stock_market_index_historical_data GET /indices/stock_market/{identifier}/historical_data/{tag} Historical Data for Stock Market Index
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
SecurityApi get_all_securities GET /securities All Securities
SecurityApi get_security_by_id GET /securities/{identifier} Lookup Security
SecurityApi get_security_data_point_number GET /securities/{identifier}/data_point/{tag}/number Data Point (Number) for Security
SecurityApi get_security_data_point_text GET /securities/{identifier}/data_point/{tag}/text Data Point (Text) for Security
SecurityApi get_security_historical_data GET /securities/{identifier}/historical_data/{tag} Historical Data for Security
SecurityApi get_security_latest_dividend_record GET /securities/{identifier}/dividends/latest Lastest Dividend Record for Security
SecurityApi get_security_latest_earnings_record GET /securities/{identifier}/earnings/latest Lastest Earnings Record for Security
SecurityApi get_security_realtime_price GET /securities/{identifier}/prices/realtime Realtime Stock Price for Security
SecurityApi get_security_stock_price_adjustments GET /securities/{identifier}/prices/adjustments Stock Price Adjustments by Security
SecurityApi get_security_stock_prices GET /securities/{identifier}/prices Stock Prices by Security
SecurityApi screen_securities POST /securities/screen Screen Securities
SecurityApi search_securities GET /securities/search Search Securities
StockExchangeApi filter_stock_exchanges GET /stock_exchanges/filter Filter Stock Exchanges
StockExchangeApi get_all_stock_exchanges GET /stock_exchanges All Stock Exchanges
StockExchangeApi get_stock_exchange_by_id GET /stock_exchanges/{identifier} Lookup Stock Exchange
StockExchangeApi get_stock_exchange_price_adjustments GET /stock_exchanges/{identifier}/prices/adjustments Stock Price Adjustments by Exchange
StockExchangeApi get_stock_exchange_prices GET /stock_exchanges/{identifier}/prices Stock Prices by Exchange
StockExchangeApi get_stock_exchange_realtime_prices GET /stock_exchanges/{identifier}/prices/realtime Realtime Stock Prices by Exchange
StockExchangeApi get_stock_exchange_securities GET /stock_exchanges/{identifier}/securities Securities by Exchange

Documentation For Models