Skip to content

Latest commit

 

History

History
178 lines (122 loc) · 6.48 KB

FundamentalsApi.md

File metadata and controls

178 lines (122 loc) · 6.48 KB
Raw

intrinio_sdk.FundamentalsApi

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

Method HTTP request Description
get_fundamental_by_id GET /fundamentals/{id} Fundamental by ID
get_fundamental_reported_financials GET /fundamentals/{id}/reported_financials Reported Financials
get_fundamental_standardized_financials GET /fundamentals/{id}/standardized_financials Standardized Financials
lookup_fundamental GET /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental

get_fundamental_by_id

Fundamental get_fundamental_by_id(id)

Fundamental by ID

Returns detailed fundamental data for the given id.

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'

fundamentals_api = intrinio_sdk.FundamentalsApi()

id = 'fun_ge9LlE' # str | The Intrinio ID for the Fundamental

try:
    api_response = fundamentals_api.get_fundamental_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FundamentalsApi->get_fundamental_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str The Intrinio ID for the Fundamental

Return type

Fundamental

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

get_fundamental_reported_financials

ApiResponseReportedFinancials get_fundamental_reported_financials(id)

Reported Financials

Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company

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'

fundamentals_api = intrinio_sdk.FundamentalsApi()

id = 'fun_ge9LlE' # str | The Intrinio ID for the Fundamental

try:
    api_response = fundamentals_api.get_fundamental_reported_financials(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FundamentalsApi->get_fundamental_reported_financials: %s\n" % e)

Parameters

Name Type Description Notes
id str The Intrinio ID for the Fundamental

Return type

ApiResponseReportedFinancials

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

get_fundamental_standardized_financials

ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)

Standardized Financials

Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.

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'

fundamentals_api = intrinio_sdk.FundamentalsApi()

id = 'fun_ge9LlE' # str | The Intrinio ID for the Fundamental

try:
    api_response = fundamentals_api.get_fundamental_standardized_financials(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FundamentalsApi->get_fundamental_standardized_financials: %s\n" % e)

Parameters

Name Type Description Notes
id str The Intrinio ID for the Fundamental

Return type

ApiResponseStandardizedFinancials

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

lookup_fundamental

Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)

Lookup Fundamental

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'

fundamentals_api = intrinio_sdk.FundamentalsApi()

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

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

Parameters

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

Return type

Fundamental

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