graphsense.TagsApi

All URIs are relative to https://api.ikna.io

Method	HTTP request	Description
get_actor	GET /tags/actors/{actor}	Returns an actor given its unique id or (unique) label
get_actor_tags	GET /tags/actors/{actor}/tags	Returns the address tags for a given actor
list_address_tags	GET /tags	Returns address tags associated with a given label
list_concepts	GET /tags/taxonomies/{taxonomy}/concepts	Returns the supported concepts of a taxonomy
list_taxonomies	GET /tags/taxonomies	Returns the supported taxonomies
report_tag	POST /tags/report-tag	Users can use this endpoint to report a missing annotation.

get_actor

Actor get_actor(actor)

Returns an actor given its unique id or (unique) label

Example

Api Key Authentication (api_key):

import time
from dateutil.parser import parse as dateutil_parser
import graphsense
from graphsense.api import tags_api
from graphsense.model.actor import Actor
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "https://api.ikna.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with graphsense.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tags_api.TagsApi(api_client)
    actor = "binance" # str | actor id

    # example passing only required values which don't have defaults set
    try:
        # Returns an actor given its unique id or (unique) label
        api_response = api_instance.get_actor(actor)
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->get_actor: %s\n" % e)

Parameters

Name	Type	Description	Notes
actor	str	actor id
_preload_content	bool	If False, the urllib3.HTTPResponse object will be returned without reading/decoding response data.	[optional] default is True.
async_req	bool	Execute request asynchronously	[optional] default is False.

Return type

Actor

Notes:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
If the HTTP response code is 429 Too Many Requests due to rate limit policies, the underlying urllib3 HTTP client will automatically stall the request as long as advised by the Retry-After header.

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_actor_tags

AddressTags get_actor_tags(actor)

Returns the address tags for a given actor

Example

Api Key Authentication (api_key):

import time
from dateutil.parser import parse as dateutil_parser
import graphsense
from graphsense.api import tags_api
from graphsense.model.address_tags import AddressTags
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "https://api.ikna.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with graphsense.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tags_api.TagsApi(api_client)
    actor = "binance" # str | actor id
    page = "" # str | Resumption token for retrieving the next page (optional)
    pagesize = 10 # int | Number of items returned in a single page (optional)

    # example passing only required values which don't have defaults set
    try:
        # Returns the address tags for a given actor
        api_response = api_instance.get_actor_tags(actor)
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->get_actor_tags: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Returns the address tags for a given actor
        api_response = api_instance.get_actor_tags(actor, page=page, pagesize=pagesize)
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->get_actor_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
actor	str	actor id
page	str	Resumption token for retrieving the next page	[optional]
pagesize	int	Number of items returned in a single page	[optional]
_preload_content	bool	If False, the urllib3.HTTPResponse object will be returned without reading/decoding response data.	[optional] default is True.
async_req	bool	Execute request asynchronously	[optional] default is False.

Return type

AddressTags

Notes:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
If the HTTP response code is 429 Too Many Requests due to rate limit policies, the underlying urllib3 HTTP client will automatically stall the request as long as advised by the Retry-After header.

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_address_tags

AddressTags list_address_tags(label)

Returns address tags associated with a given label

Example

Api Key Authentication (api_key):

import time
from dateutil.parser import parse as dateutil_parser
import graphsense
from graphsense.api import tags_api
from graphsense.model.address_tags import AddressTags
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "https://api.ikna.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with graphsense.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tags_api.TagsApi(api_client)
    label = "cimedy" # str | The label of an entity
    page = "" # str | Resumption token for retrieving the next page (optional)
    pagesize = 10 # int | Number of items returned in a single page (optional)

    # example passing only required values which don't have defaults set
    try:
        # Returns address tags associated with a given label
        api_response = api_instance.list_address_tags(label)
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->list_address_tags: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Returns address tags associated with a given label
        api_response = api_instance.list_address_tags(label, page=page, pagesize=pagesize)
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->list_address_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
label	str	The label of an entity
page	str	Resumption token for retrieving the next page	[optional]
pagesize	int	Number of items returned in a single page	[optional]
_preload_content	bool	If False, the urllib3.HTTPResponse object will be returned without reading/decoding response data.	[optional] default is True.
async_req	bool	Execute request asynchronously	[optional] default is False.

Return type

AddressTags

Notes:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
If the HTTP response code is 429 Too Many Requests due to rate limit policies, the underlying urllib3 HTTP client will automatically stall the request as long as advised by the Retry-After header.

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_concepts

[Concept] list_concepts(taxonomy)

Returns the supported concepts of a taxonomy

Example

Api Key Authentication (api_key):

import time
from dateutil.parser import parse as dateutil_parser
import graphsense
from graphsense.api import tags_api
from graphsense.model.concept import Concept
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "https://api.ikna.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with graphsense.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tags_api.TagsApi(api_client)
    taxonomy = "concept" # str | The taxonomy

    # example passing only required values which don't have defaults set
    try:
        # Returns the supported concepts of a taxonomy
        api_response = api_instance.list_concepts(taxonomy)
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->list_concepts: %s\n" % e)

Parameters

Name	Type	Description	Notes
taxonomy	str	The taxonomy
_preload_content	bool	If False, the urllib3.HTTPResponse object will be returned without reading/decoding response data.	[optional] default is True.
async_req	bool	Execute request asynchronously	[optional] default is False.

Return type

[Concept]

Notes:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
If the HTTP response code is 429 Too Many Requests due to rate limit policies, the underlying urllib3 HTTP client will automatically stall the request as long as advised by the Retry-After header.

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_taxonomies

[Taxonomy] list_taxonomies()

Returns the supported taxonomies

Example

Api Key Authentication (api_key):

import time
from dateutil.parser import parse as dateutil_parser
import graphsense
from graphsense.api import tags_api
from graphsense.model.taxonomy import Taxonomy
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "https://api.ikna.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with graphsense.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tags_api.TagsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Returns the supported taxonomies
        api_response = api_instance.list_taxonomies()
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->list_taxonomies: %s\n" % e)

Parameters

Return type

[Taxonomy]

Notes:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
If the HTTP response code is 429 Too Many Requests due to rate limit policies, the underlying urllib3 HTTP client will automatically stall the request as long as advised by the Retry-After header.

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

report_tag

report_tag(user_reported_tag)

Users can use this endpoint to report a missing annotation.

Example

Api Key Authentication (api_key):

import time
from dateutil.parser import parse as dateutil_parser
import graphsense
from graphsense.api import tags_api
from graphsense.model.user_reported_tag import UserReportedTag
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "https://api.ikna.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with graphsense.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tags_api.TagsApi(api_client)
    user_reported_tag = UserReportedTag(
        address="address_example",
        network="network_example",
        label="label_example",
        actor="actor_example",
        description="description_example",
    ) # UserReportedTag | 

    # example passing only required values which don't have defaults set
    try:
        # Users can use this endpoint to report a missing annotation.
        api_instance.report_tag(user_reported_tag)
    except graphsense.ApiException as e:
        print("Exception when calling TagsApi->report_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_reported_tag	UserReportedTag
_preload_content	bool	If False, the urllib3.HTTPResponse object will be returned without reading/decoding response data.	[optional] default is True.
async_req	bool	Execute request asynchronously	[optional] default is False.

Return type

void (empty response body)

Notes:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
If the HTTP response code is 429 Too Many Requests due to rate limit policies, the underlying urllib3 HTTP client will automatically stall the request as long as advised by the Retry-After header.

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Disabled or wrong input	-

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

FilesExpand file tree

TagsApi.md

Latest commit

History

TagsApi.md

File metadata and controls

graphsense.TagsApi

get_actor

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_actor_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_address_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_concepts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_taxonomies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

report_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details