DataTagApi.md

Intrinio.SDK.Api.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 (string tag = null, string type = null, string parent = null, string statementCode = null, string fsTemplate = null, int? pageSize = null, string nextPage = null)

All Data Tags

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllDataTagsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var dataTagApi = new DataTagApi();
      
      string tag = null;
      string type = null;
      string parent = null;
      string statementCode = "income_statement";
      string fsTemplate = null;
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseDataTags result = dataTagApi.GetAllDataTags(tag, type, parent, statementCode, fsTemplate, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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	int?	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 (string identifier)

Lookup Data Tag

Returns the Data Tag with the given identifier

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetDataTagByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var dataTagApi = new DataTagApi();
      
      string identifier = "marketcap";
      
      DataTag result = dataTagApi.GetDataTagById(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 (string query, int? pageSize = null)

Search Data Tags

Searches for Data Tags matching the text query

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class SearchDataTagsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var dataTagApi = new DataTagApi();
      
      string query = "revenue";
      int? pageSize = 100;
      
      ApiResponseDataTagsSearch result = dataTagApi.SearchDataTags(query, pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name	Type	Description	Notes
query	string
pageSize	int?	The number of results to return	[optional] [default to 100]

Return type

ApiResponseDataTagsSearch