docs/TxsApi.md

In graphsense/rgraphsense: R Package Client for GraphSense API

TxsApi

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- GetTx | GET /{currency}/txs/{tx_hash} | Returns details of a specific transaction identified by its hash. GetTxIo | GET /{currency}/txs/{tx_hash}/{io} | Returns input/output values of a specific transaction identified by its hash.

GetTx

Tx GetTx(currency, tx.hash, include.io=FALSE)

Returns details of a specific transaction identified by its hash.

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.tx.hash <- 'ab188013' # character | The transaction hash
var.include.io <- FALSE # character | Whether to include inputs/outputs of a transaction (UTXO only)

#Returns details of a specific transaction identified by its hash.
api.instance <- TxsApi$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$GetTx(var.currency, var.tx.hash, include.io=var.include.io)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | tx.hash | character| The transaction hash | include.io | character| Whether to include inputs/outputs of a transaction (UTXO only) | [optional] [default to FALSE]

Return type

Tx

Authorization

api_key

HTTP request headers

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

HTTP response details

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

GetTxIo

array[TxValue] GetTxIo(currency, tx.hash, io)

Returns input/output values of a specific transaction identified by its hash.

Example

library(graphsense)

var.currency <- 'btc' # character | The cryptocurrency code (e.g., btc)
var.tx.hash <- 'ab188013' # character | The transaction hash
var.io <- 'outputs' # character | Input or outpus values of a transaction

#Returns input/output values of a specific transaction identified by its hash.
api.instance <- TxsApi$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$GetTxIo(var.currency, var.tx.hash, var.io)
dput(result)

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- currency | character| The cryptocurrency code (e.g., btc) | tx.hash | character| The transaction hash | io | Enum [inputs, outputs] | Input or outpus values of a transaction |

Return type

array[TxValue]

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.