README.md

In graphsense/rgraphsense: R Package Client for GraphSense API

R API client for graphsense

GraphSense API provides programmatic access to various ledgers' addresses, entities, blocks, transactions and tags for automated and highly efficient forensics tasks.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI spec from a remote server, you can easily generate an API client.

• API version: 1.0.1
• Package version: 1.0.1
• Build package: org.openapitools.codegen.languages.RClientCodegen

Installation

Prerequisites

Install the dependencies

install.packages("jsonlite")
install.packages("httr")
install.packages("base64enc")

Build the package

git clone https://github.com/graphsense/rgraphsense
cd rgraphsense
R CMD build .
R CMD check graphsense_1.0.1.tar.gz --no-manual
R CMD INSTALL graphsense_1.0.1.tar.gz

Install the package

install.packages("graphsense")

To install directly from Github, use devtools:

install.packages("devtools")
library(devtools)
install_github("graphsense/rgraphsense")

Usage

library(graphsense)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AddressesApi | GetAddress | GET /{currency}/addresses/{address} | Get an address, optionally with tags AddressesApi | GetAddressEntity | GET /{currency}/addresses/{address}/entity | Get the entity of an address AddressesApi | ListAddressLinks | GET /{currency}/addresses/{address}/links | Get outgoing transactions between two addresses AddressesApi | ListAddressNeighbors | GET /{currency}/addresses/{address}/neighbors | Get an address's neighbors in the address graph AddressesApi | ListAddressTxs | GET /{currency}/addresses/{address}/txs | Get all transactions an address has been involved in AddressesApi | ListTagsByAddress | GET /{currency}/addresses/{address}/tags | Get attribution tags for a given address BlocksApi | GetBlock | GET /{currency}/blocks/{height} | Get a block by its height BlocksApi | ListBlockTxs | GET /{currency}/blocks/{height}/txs | Get block transactions BulkApi | BulkCsv | POST /{currency}/bulk.csv/{operation} | Get data as CSV in bulk BulkApi | BulkJson | POST /{currency}/bulk.json/{operation} | Get data as JSON in bulk EntitiesApi | GetEntity | GET /{currency}/entities/{entity} | Get an entity, optionally with tags EntitiesApi | ListAddressTagsByEntity | GET /{currency}/entities/{entity}/tags | Get address tags for a given entity EntitiesApi | ListEntityAddresses | GET /{currency}/entities/{entity}/addresses | Get an entity's addresses EntitiesApi | ListEntityLinks | GET /{currency}/entities/{entity}/links | Get transactions between two entities EntitiesApi | ListEntityNeighbors | GET /{currency}/entities/{entity}/neighbors | Get an entity's neighbors in the entity graph EntitiesApi | ListEntityTxs | GET /{currency}/entities/{entity}/txs | Get all transactions an entity has been involved in EntitiesApi | SearchEntityNeighbors | GET /{currency}/entities/{entity}/search | Search deeply for matching neighbors GeneralApi | GetStatistics | GET /stats | Get statistics of supported currencies GeneralApi | Search | GET /search | Returns matching addresses, transactions and labels RatesApi | GetExchangeRates | GET /{currency}/rates/{height} | Returns exchange rate for a given height TagsApi | ListAddressTags | GET /tags | Returns address tags associated with a given label TagsApi | ListConcepts | GET /tags/taxonomies/{taxonomy}/concepts | Returns the supported concepts of a taxonomy TagsApi | ListTaxonomies | GET /tags/taxonomies | Returns the supported taxonomies TxsApi | GetTx | GET /{currency}/txs/{tx_hash} | Returns details of a specific transaction identified by its hash. TxsApi | GetTxIo | GET /{currency}/txs/{tx_hash}/{io} | Returns input/output values of a specific transaction identified by its hash.

Documentation for Models

• Address
• AddressTag
• AddressTagAllOf
• AddressTags
• AddressTx
• AddressTxUtxo
• AddressTxs
• Block
• Concept
• CurrencyStats
• Entity
• EntityAddresses
• Link
• LinkUtxo
• Links
• NeighborAddress
• NeighborAddresses
• NeighborEntities
• NeighborEntity
• Rate
• Rates
• SearchResult
• SearchResultByCurrency
• SearchResultLeaf
• SearchResultLevel1
• SearchResultLevel1AllOf
• SearchResultLevel2
• SearchResultLevel2AllOf
• SearchResultLevel3
• SearchResultLevel3AllOf
• SearchResultLevel4
• SearchResultLevel4AllOf
• SearchResultLevel5
• SearchResultLevel5AllOf
• SearchResultLevel6
• SearchResultLevel6AllOf
• Stats
• Tag
• Taxonomy
• Tx
• TxAccount
• TxSummary
• TxUtxo
• TxValue
• Values

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

cookieAuth

• Type: API key
• API key parameter name: session
• Location:

Author

[e-mail]

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