DataTagApi.md

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(tag, type, parent, statementCode, fsTemplate, pageSize, nextPage)

All Data Tags

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    DataTagApi dataTagApi = new DataTagApi();
    String tag = null;
    String type = null;
    String parent = null;
    String statementCode = "income_statement";
    String fsTemplate = "industrial";
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseDataTags result = dataTagApi.getAllDataTags(tag, type, parent, statementCode, fsTemplate, pageSize, nextPage);
    System.out.println(result);
  }
}

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] [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]
fsTemplate	String	Template	[optional] [default to industrial] [enum: industrial, financial]
pageSize	Integer	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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    DataTagApi dataTagApi = new DataTagApi();
    String identifier = "marketcap";
    DataTag result = dataTagApi.getDataTagById(identifier);
    System.out.println(result);
  }
}

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, pageSize)

Search Data Tags

Searches for Data Tags matching the text `query`

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    DataTagApi dataTagApi = new DataTagApi();
    String query = "revenue";
    Integer pageSize = 100;
    ApiResponseDataTagsSearch result = dataTagApi.searchDataTags(query, pageSize);
    System.out.println(result);
  }
}

Parameters

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

Return type

ApiResponseDataTagsSearch