Skip to content

Latest commit

 

History

History
250 lines (147 loc) · 5.81 KB

DataTagApi.md

File metadata and controls

250 lines (147 loc) · 5.81 KB
Raw

intrinio_sdk.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(tag=tag, type=type, parent=parent, statement_code=statement_code, fs_template=fs_template, page_size=page_size, next_page=next_page)

All Data Tags

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

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

tag = ''
type = ''
parent = ''
statement_code = 'income_statement'
fs_template = 'industrial'
page_size = 100
next_page = ''

response = intrinio.DataTagApi().get_all_data_tags(tag=tag, type=type, parent=parent, statement_code=statement_code, fs_template=fs_template, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

Name Type Description Notes
tag str Tag [optional]  
type str Type [optional]  
parent str ID of tag parent [optional]  
statement_code str Statement Code [optional]  
fs_template str Template [optional] [default to industrial]  
page_size int The number of results to return [optional] [default to 100]  
next_page str 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

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'marketcap'

response = intrinio.DataTagApi().get_data_tag_by_id(identifier)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

Name Type Description Notes
identifier str 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, page_size=page_size)

Search Data Tags

Searches for Data Tags matching the text query

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

query = 'revenue'
page_size = 100

response = intrinio.DataTagApi().search_data_tags(query, page_size=page_size)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

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

Return type

ApiResponseDataTagsSearch