Skip to content

Latest commit

 

History

History
182 lines (126 loc) · 5.63 KB

DataTagApi.md

File metadata and controls

182 lines (126 loc) · 5.63 KB
Raw

intrinio_sdk.DataTagApi

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

Method HTTP request Description
filter_data_tags GET /data_tags/filter Filter Data Tags
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

filter_data_tags

ApiResponseDataTags filter_data_tags(tag=tag, type=type, parent=parent, statement_code=statement_code, fs_template=fs_template, next_page=next_page)

Filter Data Tags

Returns Data Tags that match the given filters

Example

from __future__ import print_function
import time
import intrinio_sdk
from intrinio_sdk.rest import ApiException
from pprint import pprint

intrinio_sdk.ApiClient().configuration.api_key['api_key'] = 'YOUR_API_KEY'

data_tag_api = intrinio_sdk.DataTagApi()

tag = '' # str | Tag (optional)
type = '' # str | Type (optional)
parent = '' # str | ID of tag parent (optional)
statement_code = 'income_statement' # str | Statement Code (optional)
fs_template = 'industrial' # str | Template (optional) (default to industrial)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

try:
    api_response = data_tag_api.filter_data_tags(tag=tag, type=type, parent=parent, statement_code=statement_code, fs_template=fs_template, next_page=next_page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataTagApi->filter_data_tags: %s\n" % e)

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]
next_page str Gets the next page of data from a previous API call [optional]

Return type

ApiResponseDataTags

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_data_tags

ApiResponseDataTags get_all_data_tags(next_page=next_page)

All Data Tags

Returns All Data Tags

Example

from __future__ import print_function
import time
import intrinio_sdk
from intrinio_sdk.rest import ApiException
from pprint import pprint

intrinio_sdk.ApiClient().configuration.api_key['api_key'] = 'YOUR_API_KEY'

data_tag_api = intrinio_sdk.DataTagApi()

next_page = '' # str | Gets the next page of data from a previous API call (optional)

try:
    api_response = data_tag_api.get_all_data_tags(next_page=next_page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataTagApi->get_all_data_tags: %s\n" % e)

Parameters

Name Type Description Notes
next_page str Gets the next page of data from a previous API call [optional]

Return type

ApiResponseDataTags

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_data_tag_by_id

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
from intrinio_sdk.rest import ApiException
from pprint import pprint

intrinio_sdk.ApiClient().configuration.api_key['api_key'] = 'YOUR_API_KEY'

data_tag_api = intrinio_sdk.DataTagApi()

identifier = 'marketcap' # str | The Intrinio ID or the code-name of the Data Tag

try:
    api_response = data_tag_api.get_data_tag_by_id(identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataTagApi->get_data_tag_by_id: %s\n" % e)

Parameters

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

Return type

DataTag

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_data_tags

ApiResponseDataTags search_data_tags(query)

Search Data Tags

Searches for Data Tags matching the text query

Example

from __future__ import print_function
import time
import intrinio_sdk
from intrinio_sdk.rest import ApiException
from pprint import pprint

intrinio_sdk.ApiClient().configuration.api_key['api_key'] = 'YOUR_API_KEY'

data_tag_api = intrinio_sdk.DataTagApi()

query = 'revenue' # str | 

try:
    api_response = data_tag_api.search_data_tags(query)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataTagApi->search_data_tags: %s\n" % e)

Parameters

Name Type Description Notes
query str

Return type

ApiResponseDataTags

[Back to top] [Back to API list] [Back to Model list] [Back to README]