Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.79 KB

HistoricalDataApi.md

File metadata and controls

61 lines (44 loc) · 2.79 KB
Raw

intrinio_sdk.HistoricalDataApi

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

Method HTTP request Description
get_historical_data GET /historical_data/{identifier}/{tag} Historical Data

get_historical_data

ApiResponseHistoricalData get_historical_data(identifier, tag, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, next_page=next_page)

Historical Data

Returns historical values for the given tag and the entity represented by 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'

historical_data_api = intrinio_sdk.HistoricalDataApi()

identifier = 'AAPL' # str | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
tag = 'marketcap' # str | An Intrinio data tag ID or code-name
type = '' # str | Filter by type, when applicable (optional)
start_date = '2015-01-01' # date | Get historical data on or after this date (optional)
end_date = '2019-01-01' # date | Get historical date 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 = historical_data_api.get_historical_data(identifier, tag, 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 HistoricalDataApi->get_historical_data: %s\n" % e)

Parameters

Name Type Description Notes
identifier str An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
tag str An Intrinio data tag ID or code-name
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 date 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

ApiResponseHistoricalData

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