DataTagApi.md

intrinioSDK.DataTagApi

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

Method	HTTP request	Description
getAllDataTags	GET /data_tags	All Data Tags
getDataTagById	GET /data_tags/{identifier}	Lookup Data Tag
searchDataTags	GET /data_tags/search	Search Data Tags

getAllDataTags

View Intrinio API Documentation

ApiResponseDataTags getAllDataTags(opts)

All Data Tags

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var dataTag = new intrinioSDK.DataTagApi();

var opts = { 
  'tag': null,
  'type': null,
  'parent': null,
  'statementCode': "income_statement",
  'fsTemplate': "industrial",
  'pageSize': 100,
  'nextPage': null
};

dataTag.getAllDataTags(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
tag	String	Tag	[optional]
type	String	Type	[optional]
parent	String	ID of tag parent	[optional]
statementCode	String	Statement Code	[optional]
fsTemplate	String	Template	[optional] [default to industrial]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseDataTags

getDataTagById

View Intrinio API Documentation

DataTag getDataTagById(identifier)

Lookup Data Tag

Returns the Data Tag with the given `identifier`

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var dataTag = new intrinioSDK.DataTagApi();

var identifier = "marketcap";


dataTag.getDataTagById(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

DataTag

searchDataTags

View Intrinio API Documentation

ApiResponseDataTagsSearch searchDataTags(query, opts)

Search Data Tags

Searches for Data Tags matching the text `query`

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var dataTag = new intrinioSDK.DataTagApi();

var query = "revenue";


var opts = { 
  'pageSize': 100
};

dataTag.searchDataTags(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
query	String
pageSize	Number	The number of results to return	[optional] [default to 100]

Return type

ApiResponseDataTagsSearch