docs/AddressesApi.md

In graphsense/rgraphsense: R Package Client for GraphSense API

AddressesApi

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- GetAddress | GET /{currency}/addresses/{address} | Get an address, optionally with tags GetAddressEntity | GET /{currency}/addresses/{address}/entity | Get the entity of an address ListAddressLinks | GET /{currency}/addresses/{address}/links | Get outgoing transactions between two addresses ListAddressNeighbors | GET /{currency}/addresses/{address}/neighbors | Get an address's neighbors in the address graph ListAddressTxs | GET /{currency}/addresses/{address}/txs | Get all transactions an address has been involved in ListTagsByAddress | GET /{currency}/addresses/{address}/tags | Get attribution tags for a given address

GetAddress

Address GetAddress(currency, address)

Get an address, optionally with tags

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.address <- 'addressA' # character | The cryptocurrency address

#Get an address, optionally with tags
api.instance <- AddressesApi$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$GetAddress(var.currency, var.address)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | address | character| The cryptocurrency address |

Return type

Address

Authorization

api_key

HTTP request headers

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

HTTP response details

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

GetAddressEntity

Entity GetAddressEntity(currency, address)

Get the entity of an address

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.address <- 'addressA' # character | The cryptocurrency address

#Get the entity of an address
api.instance <- AddressesApi$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$GetAddressEntity(var.currency, var.address)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | address | character| The cryptocurrency address |

Return type

Entity

Authorization

api_key

HTTP request headers

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

HTTP response details

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

ListAddressLinks

Links ListAddressLinks(currency, address, neighbor, page=var.page, pagesize=var.pagesize)

Get outgoing transactions between two addresses

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.address <- 'addressA' # character | The cryptocurrency address
var.neighbor <- 'addressE' # character | Neighbor address
var.page <- 'page_example' # character | Resumption token for retrieving the next page
var.pagesize <- 10 # integer | Number of items returned in a single page

#Get outgoing transactions between two addresses
api.instance <- AddressesApi$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$ListAddressLinks(var.currency, var.address, var.neighbor, page=var.page, pagesize=var.pagesize)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | address | character| The cryptocurrency address | neighbor | character| Neighbor address | page | character| Resumption token for retrieving the next page | [optional] pagesize | integer| Number of items returned in a single page | [optional]

Return type

Links

Authorization

api_key

HTTP request headers

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

HTTP response details

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

ListAddressNeighbors

NeighborAddresses ListAddressNeighbors(currency, address, direction, include.labels=FALSE, page=var.page, pagesize=var.pagesize)

Get an address's neighbors in the address graph

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.address <- 'addressA' # character | The cryptocurrency address
var.direction <- 'out' # character | Incoming or outgoing neighbors
var.include.labels <- FALSE # character | Whether to include labels of first page of tags
var.page <- 'page_example' # character | Resumption token for retrieving the next page
var.pagesize <- 10 # integer | Number of items returned in a single page

#Get an address's neighbors in the address graph
api.instance <- AddressesApi$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$ListAddressNeighbors(var.currency, var.address, var.direction, include.labels=var.include.labels, page=var.page, pagesize=var.pagesize)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | address | character| The cryptocurrency address | direction | Enum [in, out] | Incoming or outgoing neighbors | include.labels | character| Whether to include labels of first page of tags | [optional] [default to FALSE] page | character| Resumption token for retrieving the next page | [optional] pagesize | integer| Number of items returned in a single page | [optional]

Return type

NeighborAddresses

Authorization

api_key

HTTP request headers

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

HTTP response details

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

ListAddressTxs

AddressTxs ListAddressTxs(currency, address, page=var.page, pagesize=var.pagesize)

Get all transactions an address has been involved in

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.address <- 'addressA' # character | The cryptocurrency address
var.page <- 'page_example' # character | Resumption token for retrieving the next page
var.pagesize <- 10 # integer | Number of items returned in a single page

#Get all transactions an address has been involved in
api.instance <- AddressesApi$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$ListAddressTxs(var.currency, var.address, page=var.page, pagesize=var.pagesize)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | address | character| The cryptocurrency address | page | character| Resumption token for retrieving the next page | [optional] pagesize | integer| Number of items returned in a single page | [optional]

Return type

AddressTxs

Authorization

api_key

HTTP request headers

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

HTTP response details

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

ListTagsByAddress

AddressTags ListTagsByAddress(currency, address, page=var.page, pagesize=var.pagesize)

Get attribution tags for a given address

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.address <- 'addressA' # character | The cryptocurrency address
var.page <- 'page_example' # character | Resumption token for retrieving the next page
var.pagesize <- 10 # integer | Number of items returned in a single page

#Get attribution tags for a given address
api.instance <- AddressesApi$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$ListTagsByAddress(var.currency, var.address, page=var.page, pagesize=var.pagesize)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | address | character| The cryptocurrency address | 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 | - |

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