intrinio_sdk.CompanyApi

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

Method	HTTP request	Description
filter_companies	GET /companies/filter	Filter Companies
filter_company_fundamentals	GET /companies/{identifier}/fundamentals/filter	Filter Fundamentals by Company
get_all_companies	GET /companies	All Companies
get_all_company_news	GET /companies/news	All News
get_company	GET /companies/{identifier}	Lookup Company
get_company_data_point_number	GET /companies/{identifier}/data_point/{tag}/number	Data Point (Number) for Company
get_company_data_point_text	GET /companies/{identifier}/data_point/{tag}/text	Data Point (Text) for Company
get_company_filings	GET /companies/{identifier}/filings	All Filings by Company
get_company_fundamentals	GET /companies/{identifier}/fundamentals	All Fundamentals by Company
get_company_historical_data	GET /companies/{identifier}/historical_data/{tag}	Historical Data for Company
get_company_news	GET /companies/{identifier}/news	All News by Company
get_company_securities	GET /companies/{identifier}/securities	All Securities by Company
lookup_company_fundamental	GET /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period}	Lookup Fundamental by Company
search_companies	GET /companies/search	Search Companies

filter_companies

ApiResponseCompanies filter_companies(last_filing_date=last_filing_date, sic=sic, template=template, sector=sector, industry_category=industry_category, industry_group=industry_group, next_page=next_page)

Filter Companies

Returns Companies matching the specified filters

Example

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()

last_filing_date = '' # date | Last filing date (optional)
sic = '3350' # str | Standard Industrial Classification code (optional)
template = 'industrial' # str | Template (optional)
sector = 'Basic Materials' # str | Industry sector (optional)
industry_category = 'Metals & Mining' # str | Industry category (optional)
industry_group = 'Aluminum' # str | Industry group (optional)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

try:
    api_response = company_api.filter_companies(last_filing_date=last_filing_date, sic=sic, template=template, sector=sector, industry_category=industry_category, industry_group=industry_group, next_page=next_page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompanyApi->filter_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
last_filing_date	date	Last filing date	[optional]
sic	str	Standard Industrial Classification code	[optional]
template	str	Template	[optional]
sector	str	Industry sector	[optional]
industry_category	str	Industry category	[optional]
industry_group	str	Industry group	[optional]
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanies

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filter_company_fundamentals

ApiResponseCompanyFundamentals filter_company_fundamentals(identifier, filed_after=filed_after, filed_before=filed_before, reported_only=reported_only, fiscal_year=fiscal_year, statement_code=statement_code, type=type, start_date=start_date, end_date=end_date, next_page=next_page)

Filter Fundamentals by Company

Returns Fundamentals for the Company with the given identifier and matching the specified filters

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
filed_after = '' # date | Filed on or after this date (optional)
filed_before = '' # date | Filed on or before this date (optional)
reported_only = False # bool | Only as-reported fundamentals (optional)
fiscal_year = 2017 # int | Only for the given fiscal year (optional)
statement_code = '' # str | Only of the given statement code (optional)
type = '' # str | Only of the given type (optional)
start_date = '' # date | Only on or after the given date (optional)
end_date = '' # date | Only on or before the given date (optional)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

try:
    api_response = company_api.filter_company_fundamentals(identifier, filed_after=filed_after, filed_before=filed_before, reported_only=reported_only, fiscal_year=fiscal_year, statement_code=statement_code, type=type, start_date=start_date, end_date=end_date, next_page=next_page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompanyApi->filter_company_fundamentals: %s\n" % e)

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
filed_after	date	Filed on or after this date	[optional]
filed_before	date	Filed on or before this date	[optional]
reported_only	bool	Only as-reported fundamentals	[optional]
fiscal_year	int	Only for the given fiscal year	[optional]
statement_code	str	Only of the given statement code	[optional]
type	str	Only of the given type	[optional]
start_date	date	Only on or after the given date	[optional]
end_date	date	Only on or before the given date	[optional]
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanyFundamentals

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_companies

ApiResponseCompanies get_all_companies(next_page=next_page)

All Companies

Returns all Companies

Example

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()

next_page = '' # str | Gets the next page of data from a previous API call (optional)

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

Parameters

Name	Type	Description	Notes
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanies

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_company_news

ApiResponseNews get_all_company_news(next_page=next_page)

All News

Returns all News for all Companies

Example

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()

next_page = '' # str | Gets the next page of data from a previous API call (optional)

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

Parameters

Name	Type	Description	Notes
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseNews

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company

Company get_company(identifier)

Lookup Company

Returns the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)

Return type

Company

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_data_point_number

float get_company_data_point_number(identifier, tag)

Data Point (Number) for Company

Returns a numeric value for the given tag for the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
tag = 'marketcap' # str | An Intrinio data tag

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

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
tag	str	An Intrinio data tag

Return type

float

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_data_point_text

str get_company_data_point_text(identifier, tag)

Data Point (Text) for Company

Returns a text value for the given tag for the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
tag = 'marketcap' # str | An Intrinio data tag

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

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
tag	str	An Intrinio data tag

Return type

str

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_filings

ApiResponseCompanyFilings get_company_filings(identifier, next_page=next_page)

All Filings by Company

Returns a complete list of SEC filings for the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

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

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanyFilings

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_fundamentals

ApiResponseCompanyFundamentals get_company_fundamentals(identifier, next_page=next_page)

All Fundamentals by Company

Returns all Fundamentals for the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

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

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanyFundamentals

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_historical_data

ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, next_page=next_page)

Historical Data for Company

Returns historical values for the given tag and the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
tag = 'marketcap' # str | An Intrinio data-tag
frequency = 'daily' # str | Return historical data in the given frequency (optional) (default to daily)
type = '' # str | Filter by type, when applicable (optional)
start_date = '2018-01-01' # date | Get historical data on or after this date (optional)
end_date = '2019-01-01' # date | Get historical data on or before this date (optional)
sort_order = 'desc' # str | Sort by date `asc` or `desc` (optional) (default to desc)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

try:
    api_response = company_api.get_company_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, next_page=next_page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompanyApi->get_company_historical_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
tag	str	An Intrinio data-tag
frequency	str	Return historical data in the given frequency	[optional] [default to daily]
type	str	Filter by type, when applicable	[optional]
start_date	date	Get historical data on or after this date	[optional]
end_date	date	Get historical data on or before this date	[optional]
sort_order	str	Sort by date `asc` or `desc`	[optional] [default to desc]
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanyHistoricalData

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_news

ApiResponseCompanyNews get_company_news(identifier, next_page=next_page)

All News by Company

Returns news for the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

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

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanyNews

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_securities

ApiResponseCompanySecurities get_company_securities(identifier, next_page=next_page)

All Securities by Company

Returns Securities for the Company with the given identifier

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

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

Parameters

Name	Type	Description	Notes
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
next_page	str	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseCompanySecurities

[Back to top] [Back to API list] [Back to Model list] [Back to README]

lookup_company_fundamental

Fundamental lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)

Lookup Fundamental by Company

Returns the Fundamental for the Company with the given identifier and with the given parameters

Example

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()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
statement_code = 'income_statement' # str | The statement code
fiscal_period = 'FY' # str | The fiscal period
fiscal_year = 2017 # int | The fiscal year

try:
    api_response = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompanyApi->lookup_company_fundamental: %s\n" % e)

Parameters

Name	Type	Description
identifier	str	A Company identifier (Ticker, CIK, LEI, Intrinio ID)
statement_code	str	The statement code
fiscal_period	str	The fiscal period
fiscal_year	int	The fiscal year

Return type

Fundamental

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_companies

ApiResponseCompanies search_companies(query)

Search Companies

Searches for Companies matching the text query

Example

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()

query = 'Apple' # str | Search parameters

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

Parameters

Name	Type	Description	Notes
query	str	Search parameters

Return type

ApiResponseCompanies

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CompanyApi.md

Latest commit

History

CompanyApi.md

File metadata and controls

intrinio_sdk.CompanyApi

filter_companies

Example

Parameters

Return type

filter_company_fundamentals

Example

Parameters

Return type

get_all_companies

Example

Parameters

Return type

get_all_company_news

Example

Parameters

Return type

get_company

Example

Parameters

Return type

get_company_data_point_number

Example

Parameters

Return type

get_company_data_point_text

Example

Parameters

Return type

get_company_filings

Example

Parameters

Return type

get_company_fundamentals

Example

Parameters

Return type

get_company_historical_data

Example

Parameters

Return type

get_company_news

Example

Parameters

Return type

get_company_securities

Example

Parameters

Return type

lookup_company_fundamental

Example

Parameters

Return type

search_companies

Example

Parameters

Return type