docs/TagsApi.md

In graphsense/rgraphsense: R Package Client for GraphSense API

TagsApi

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- ListAddressTags | GET /tags | Returns address tags associated with a given label ListConcepts | GET /tags/taxonomies/{taxonomy}/concepts | Returns the supported concepts of a taxonomy ListTaxonomies | GET /tags/taxonomies | Returns the supported taxonomies

ListAddressTags

AddressTags ListAddressTags(label, page=var.page, pagesize=var.pagesize)

Returns address tags associated with a given label

Example

library(graphsense)

var.label <- 'cimedy' # character | The label of an entity
var.page <- 'page_example' # character | Resumption token for retrieving the next page
var.pagesize <- 10 # integer | Number of items returned in a single page

#Returns address tags associated with a given label
api.instance <- TagsApi$new()
api.instance$apiClient$basePath <- 'http://localhost';
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['Authorization'] <- 'WRITE_YOUR_API_KEY_HERE';
result <- api.instance$ListAddressTags(var.label, page=var.page, pagesize=var.pagesize)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- label | character| The label of an entity | page | character| Resumption token for retrieving the next page | [optional] pagesize | integer| Number of items returned in a single page | [optional]

Return type

AddressTags

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - |

ListConcepts

array[Concept] ListConcepts(taxonomy)

Returns the supported concepts of a taxonomy

Example

library(graphsense)

var.taxonomy <- 'foo' # character | The taxonomy

#Returns the supported concepts of a taxonomy
api.instance <- TagsApi$new()
api.instance$apiClient$basePath <- 'http://localhost';
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['Authorization'] <- 'WRITE_YOUR_API_KEY_HERE';
result <- api.instance$ListConcepts(var.taxonomy)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- taxonomy | character| The taxonomy |

Return type

array[Concept]

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - |

ListTaxonomies

array[Taxonomy] ListTaxonomies()

Returns the supported taxonomies

Example

library(graphsense)


#Returns the supported taxonomies
api.instance <- TagsApi$new()
api.instance$apiClient$basePath <- 'http://localhost';
# Configure API key authorization: api_key
api.instance$apiClient$apiKeys['Authorization'] <- 'WRITE_YOUR_API_KEY_HERE';
result <- api.instance$ListTaxonomies()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

array[Taxonomy]

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | OK | - |

graphsense/rgraphsense documentation built on Sept. 2, 2022, 1:45 p.m.