graphsense-python

GraphSense API

This Python package is automatically generated by the OpenAPI Generator project:

API version: 0.5
Package version: 0.5
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/graphsense/graphsense-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/graphsense/graphsense-python.git)

Then import the package:

import graphsense

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import graphsense

Generate from OpenAPI specification

In order to generate the client from Graphsense's OpenAPI specification run the OpenAPI Generator CLI, eg. using docker:

    URL=https://github.com/graphsense/graphsense-openapi/blob/master/graphsense.yaml
    docker run --rm \
      -v "${PWD}:/build" \
      openapitools/openapi-generator-cli:v5.1.1 \
      generate -i "$URL" \
        -g python \
        -o /build

Getting Started

Please follow the installation procedure and then run the following:

import time
import graphsense
from pprint import pprint
from graphsense.api import addresses_api
from graphsense.model.address import Address
from graphsense.model.address_tag import AddressTag
from graphsense.model.address_txs import AddressTxs
from graphsense.model.addresses import Addresses
from graphsense.model.entity import Entity
from graphsense.model.link import Link
from graphsense.model.neighbors import Neighbors
# Defining the host is optional and defaults to http://openapi_server:9000
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "http://openapi_server:9000"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'


# Enter a context with an instance of the API client
with graphsense.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = addresses_api.AddressesApi(api_client)
    currency = "btc" # str | The cryptocurrency (e.g., btc)
address = "1Archive1n2C579dMsAu3iC6tWzuQJz8dN" # str | The cryptocurrency address
include_tags = False # bool | Whether tags should be included (optional) (default to False)

    try:
        # Get an address, optionally with tags
        api_response = api_instance.get_address(currency, address, include_tags=include_tags)
        pprint(api_response)
    except graphsense.ApiException as e:
        print("Exception when calling AddressesApi->get_address: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://openapi_server:9000

Class	Method	HTTP request	Description
AddressesApi	get_address	GET /{currency}/addresses/{address}	Get an address, optionally with tags
AddressesApi	get_address_entity	GET /{currency}/addresses/{address}/entity	Get the entity of an address
AddressesApi	list_address_links	GET /{currency}/addresses/{address}/links	Get transactions between two addresses
AddressesApi	list_address_links_csv	GET /{currency}/addresses/{address}/links.csv	Get transactions between two addresses as CSV
AddressesApi	list_address_neighbors	GET /{currency}/addresses/{address}/neighbors	Get an addresses' neighbors in the address graph
AddressesApi	list_address_neighbors_csv	GET /{currency}/addresses/{address}/neighbors.csv	Get an addresses' neighbors in the address graph as CSV
AddressesApi	list_address_txs	GET /{currency}/addresses/{address}/txs	Get all transactions an address has been involved in
AddressesApi	list_address_txs_csv	GET /{currency}/addresses/{address}/txs.csv	Get all transactions an address has been involved in as CSV
AddressesApi	list_addresses	GET /{currency}/addresses	Get addresses
AddressesApi	list_addresses_csv	GET /{currency}/addresses.csv	Get addresses as CSV
AddressesApi	list_tags_by_address	GET /{currency}/addresses/{address}/tags	Get attribution tags for a given address
AddressesApi	list_tags_by_address_csv	GET /{currency}/addresses/{address}/tags.csv	Get attribution tags for a given address
BlocksApi	get_block	GET /{currency}/blocks/{height}	Get a block by its height
BlocksApi	list_block_txs	GET /{currency}/blocks/{height}/txs	Get block transactions (100 per page)
BlocksApi	list_block_txs_csv	GET /{currency}/blocks/{height}/txs.csv	Get block transactions as CSV
BlocksApi	list_blocks	GET /{currency}/blocks	Get all blocks
EntitiesApi	get_entity	GET /{currency}/entities/{entity}	Get an entity, optionally with tags
EntitiesApi	list_entities	GET /{currency}/entities	Get entities
EntitiesApi	list_entities_csv	GET /{currency}/entities.csv	Get entities as CSV
EntitiesApi	list_entity_addresses	GET /{currency}/entities/{entity}/addresses	Get an entity's addresses
EntitiesApi	list_entity_addresses_csv	GET /{currency}/entities/{entity}/addresses.csv	Get an entity's addresses as CSV
EntitiesApi	list_entity_neighbors	GET /{currency}/entities/{entity}/neighbors	Get an entity's neighbors in the entity graph
EntitiesApi	list_entity_neighbors_csv	GET /{currency}/entities/{entity}/neighbors.csv	Get an entity's neighbors in the entity graph as CSV
EntitiesApi	list_tags_by_entity	GET /{currency}/entities/{entity}/tags	Get tags for a given entity
EntitiesApi	list_tags_by_entity_by_level_csv	GET /{currency}/entities/{entity}/tags.csv	Get address or entity tags for a given entity as CSV
EntitiesApi	search_entity_neighbors	GET /{currency}/entities/{entity}/search	Search deeply for matching neighbors
GeneralApi	get_statistics	GET /stats	Get statistics of supported currencies
GeneralApi	search	GET /search	Returns matching addresses, transactions and labels
RatesApi	get_exchange_rates	GET /{currency}/rates/{height}	Returns exchange rate for a given height
TagsApi	list_concepts	GET /tags/taxonomies/{taxonomy}/concepts	Returns the supported concepts of a taxonomy
TagsApi	list_tags	GET /tags	Returns address and entity tags associated with a given label
TagsApi	list_taxonomies	GET /tags/taxonomies	Returns the supported taxonomies
TxsApi	get_tx	GET /{currency}/txs/{tx_hash}	Returns details of a specific transaction identified by its hash.
TxsApi	list_txs	GET /{currency}/txs	Returns transactions

Documentation For Models

Documentation For Authorization

api_key

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

Examples

In ./examples you can find example Python scripts and Jupyter notebooks demonstrating how to use the GraphSense Python API. Please Follow these setup instructions to run them:

Clone this repository

git clone git@github.com:graphsense/graphsense-python.git
cd graphsense-python

Recommended: create and activate a virtual Python environment

python3 -m venv venv-gpython
. ./venv-gpython/bin/activate

Upgrade pip and install all dependencies

python -m pip install --upgrade pip
pip install -r examples/requirements.txt

Install the GraphSense python client

pip install git+https://github.com/graphsense/graphsense-python.git

Install a custom iPython kernel that uses the virtual Python environment

ipython kernel install --name=venv-gpython

Run the Jupyter notebook

jupyter notebook

Open the notebooks in your browser

http://localhost:8889/notebooks/examples/basic_entities_demo.ipynb
http://localhost:8889/notebooks/examples/sextortion_study.ipynb

Make sure you select the right kernel (venv-gpython) before running the notebooks (Kernel -> Change kernel -> venv-gpython)

Name		Name	Last commit message	Last commit date
Latest commit History 41 Commits
docs		docs
examples		examples
graphsense		graphsense
test		test
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
.openapi-generator-ignore		.openapi-generator-ignore
.travis.yml		.travis.yml
LICENSE		LICENSE
README.md		README.md
git_push.sh		git_push.sh
requirements.txt		requirements.txt
setup.cfg		setup.cfg
setup.py		setup.py
test-requirements.txt		test-requirements.txt
tox.ini		tox.ini

Navigation Menu

Repository files navigation

graphsense-python

Requirements.

Installation & Usage

pip install

Setuptools

Generate from OpenAPI specification

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

api_key

Examples

About

Releases

Packages

Contributors

Languages

Folders and files

Latest commit

History

Repository files navigation

graphsense-python

Requirements.

Installation & Usage

pip install

Setuptools

Generate from OpenAPI specification

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

api_key

Examples

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages