Skip to content

Latest commit

 

History

History
274 lines (161 loc) · 5.7 KB

DataTagApi.md

File metadata and controls

274 lines (161 loc) · 5.7 KB
Raw

IntrinioSDK::DataTagApi

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

Method HTTP request Description
get_all_data_tags GET /data_tags All Data Tags
get_data_tag_by_id GET /data_tags/{identifier} Lookup Data Tag
search_data_tags GET /data_tags/search Search Data Tags

get_all_data_tags

View Intrinio API Documentation

ApiResponseDataTags get_all_data_tags(opts)

All Data Tags

Returns all Data Tags. Returns Data Tags matching parameters when specified.

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
DataTagApi <- IntrinioSDK::DataTagApi$new(client)

# Optional params
opts <- list(
  tag = NULL,
  type = NULL,
  parent = NULL,
  statement_code = "income_statement",
  fs_template = "industrial",
  page_size = 100,
  next_page = NULL
)

response <- DataTagApi$get_all_data_tags(opts)

print(response)
print(response$content)

Parameters

Name Type Description Notes
tag Character Tag [optional]  
type Character Type [optional]  
parent Character ID of tag parent [optional]  
statement_code Character Statement Code [optional]  
fs_template Character Template [optional] [default to industrial]  
page_size Integer The number of results to return [optional] [default to 100]  
next_page Character Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseDataTags

get_data_tag_by_id

View Intrinio API Documentation

DataTag get_data_tag_by_id(identifier)

Lookup Data Tag

Returns the Data Tag 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
DataTagApi <- IntrinioSDK::DataTagApi$new(client)

# Required params
identifier <- "marketcap"

response <- DataTagApi$get_data_tag_by_id(identifier)

print(response)
print(response$content)

Parameters

Name Type Description Notes
identifier Character The Intrinio ID or the code-name of the Data Tag  

Return type

DataTag

search_data_tags

View Intrinio API Documentation

ApiResponseDataTagsSearch search_data_tags(query, opts)

Search Data Tags

Searches for Data Tags matching the text query

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
DataTagApi <- IntrinioSDK::DataTagApi$new(client)

# Required params
query <- "revenue"

# Optional params
opts <- list(
  page_size = 100
)

response <- DataTagApi$search_data_tags(query, opts)

print(response)
print(response$content)

Parameters

Name Type Description Notes
query Character  
page_size Integer The number of results to return [optional] [default to 100]  

Return type

ApiResponseDataTagsSearch