Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 2.5 KB

README.md

File metadata and controls

58 lines (33 loc) · 2.5 KB

Iknaio API Tutorial

This tutorial demonstrates how to use the GraphSense REST API hosted by Iknaio Cryptoasset Analytics GmbH for conducting advanced, data-driven analytics tasks.

The example dataset is a subset of data taken from a scientific study investigating sextortion spam.

Open in Google Colab

Google colab offers a zero setup notebook environment. The only thing needed is a Google account to load our notebooks. Click the following links to open the notebooks.

  • 1 Inspect BTC Addresses - 1 Inspect BTC Addresses
  • 2 Sextortion Study - 2 Sextortion Study
  • 3 Entities Demo - 3 Entities Demo
  • 4 Path Search - 4 Path Search
  • 5 Alice DWM - 5 Alice

Prerequisites

You need an API key provided by Iknaio.

You need Python >= 3.8

python --version

Notebook preparation

The tutorial will make use of several notebooks, which are available in this repository.

As a first step, clone this repository to your local drive

git clone https://github.com/graphsense/iknaio-api-tutorial.git
cd iknaio-api-tutorial

You can run the notebooks locally, as follows:

Setup a Python environment with Anaconda:

conda env create -f environment.yml
conda activate iknaio-api-tutorial

Copy the config template file:

cp config.json.tmp config.json

Run the jupyter notebooks

jupyter notebook

Open config.json, insert your API key and save.

Now you are ready to run the tutorial notebooks!

Documentation

Documentation of the API endpoints can be found in the repository of the GraphSense Python client.