docs/GeneralApi.md

In graphsense/rgraphsense: R Package Client for GraphSense API

GeneralApi

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- GetStatistics | GET /stats | Get statistics of supported currencies Search | GET /search | Returns matching addresses, transactions and labels

GetStatistics

Stats GetStatistics()

Get statistics of supported currencies

Example

library(graphsense)


#Get statistics of supported currencies
api.instance <- GeneralApi$new()
api.instance$apiClient$basePath <- 'http://localhost';
result <- api.instance$GetStatistics()
dput(result)

Parameters

This endpoint does not need any parameter.

Return type

Stats

Authorization

No authorization required

HTTP request headers

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

HTTP response details

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

Search

SearchResult Search(q, currency=var.currency, limit=10)

Returns matching addresses, transactions and labels

Example

library(graphsense)

var.q <- 'foo' # character | It can be (the beginning of) an address, a transaction or a label
var.currency <- 'btc' # character | The cryptocurrency (e.g., btc)
var.limit <- 10 # integer | Maximum number of search results

#Returns matching addresses, transactions and labels
api.instance <- GeneralApi$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$Search(var.q, currency=var.currency, limit=var.limit)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- q | character| It can be (the beginning of) an address, a transaction or a label | currency | character| The cryptocurrency (e.g., btc) | [optional] limit | integer| Maximum number of search results | [optional] [default to 10]

Return type

SearchResult

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.