Skip to content

Latest commit

 

History

History
176 lines (100 loc) · 3.97 KB

DataPointApi.md

File metadata and controls

176 lines (100 loc) · 3.97 KB

IntrinioSDK::DataPointApi

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

Method HTTP request Description
get_data_point_number GET /data_point/{identifier}/{tag}/number Data Point (Number)
get_data_point_text GET /data_point/{identifier}/{tag}/text Data Point (Text)

get_data_point_number

View Intrinio API Documentation

Numeric get_data_point_number(identifier, tag)

Data Point (Number)

Returns a numeric value for the given tag and the entity with the given identifier

Example

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
DataPointApi <- IntrinioSDK::DataPointApi$new(client)

# Required params
identifier <- "AAPL"
tag <- "marketcap"

response <- DataPointApi$get_data_point_number(identifier, tag)

print(response)
print(response$content)

Parameters

Name Type Description Notes
identifier Character An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)  
tag Character An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  

Return type

Numeric

get_data_point_text

View Intrinio API Documentation

Character get_data_point_text(identifier, tag)

Data Point (Text)

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

Example

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
DataPointApi <- IntrinioSDK::DataPointApi$new(client)

# Required params
identifier <- "AAPL"
tag <- "ceo"

response <- DataPointApi$get_data_point_text(identifier, tag)

print(response)
print(response$content)

Parameters

Name Type Description Notes
identifier Character An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)  
tag Character An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  

Return type

Character