Skip to content

Latest commit

 

History

History
168 lines (96 loc) · 3.72 KB

DataPointApi.md

File metadata and controls

168 lines (96 loc) · 3.72 KB

Intrinio::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

Float 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

# Load the gem
require 'intrinio-sdk'
require 'pp'

# Setup authorization
Intrinio.configure do |config|
  config.api_key['api_key'] = 'YOUR_API_KEY'
  config.allow_retries = true
end

dataPoint_api = Intrinio::DataPointApi.new
identifier = "AAPL"
tag = "marketcap"

result = dataPoint_api.get_data_point_number(identifier, tag)
pp result

Parameters

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

Return type

Float

get_data_point_text

View Intrinio API Documentation

String 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

# Load the gem
require 'intrinio-sdk'
require 'pp'

# Setup authorization
Intrinio.configure do |config|
  config.api_key['api_key'] = 'YOUR_API_KEY'
  config.allow_retries = true
end

dataPoint_api = Intrinio::DataPointApi.new
identifier = "AAPL"
tag = "ceo"

result = dataPoint_api.get_data_point_text(identifier, tag)
pp result

Parameters

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

Return type

String