graphsense-python 1.4.0__tar.gz

graphsense-python-1.4.0/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) Iknaio Cryptoasset Analytics GmbH
+Copyright (c) AIT Austrian Institute of Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

graphsense-python-1.4.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.1
+Name: graphsense-python
+Version: 1.4.0
+Summary: GraphSense API
+Home-page: 
+Author: Iknaio Cryptoasset Analytics GmbH
+Author-email: contact@ikna.io
+Keywords: OpenAPI,OpenAPI-Generator,GraphSense API
+Requires-Python: >=3.6
+License-File: LICENSE
+Requires-Dist: urllib3>=1.25.3
+Requires-Dist: python-dateutil
+
+    GraphSense API provides programmatic access to various ledgers' addresses, entities, blocks, transactions and tags for automated and highly efficient forensics tasks.
+    

graphsense-python-1.4.0/README.md

@@ -0,0 +1,231 @@
+# graphsense-python
+GraphSense API provides programmatic access to various ledgers' addresses, entities, blocks, transactions and tags for automated and highly efficient forensics tasks.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.4.0
+- Package version: 1.4.0
+- 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:
+
+```sh
+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:
+```python
+import graphsense
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import graphsense
+```
+
+
+### Generate from OpenAPI specification
+
+In order to generate the client from [Graphsense's OpenAPI specification](https://github.com/graphsense/graphsense-openapi) run the [OpenAPI Generator CLI](https://openapi-generator.tech/), 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](#installation--usage) and then run the following:
+
+```python
+
+import time
+import graphsense
+from pprint import pprint
+from graphsense.api import addresses_api
+from graphsense.model.address import Address
+from graphsense.model.address_tags import AddressTags
+from graphsense.model.address_txs import AddressTxs
+from graphsense.model.entity import Entity
+from graphsense.model.height import Height
+from graphsense.model.links import Links
+from graphsense.model.neighbor_addresses import NeighborAddresses
+# Defining the host is optional and defaults to https://api.ikna.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = graphsense.Configuration(
+    host = "https://api.ikna.io"
+)
+
+# 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 code (e.g., btc)
+address = "addressA" # str | The cryptocurrency address
+
+    try:
+        # Get an address
+        api_response = api_instance.get_address(currency, address)
+        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 *https://api.ikna.io*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AddressesApi* | [**get_address**](docs/AddressesApi.md#get_address) | **GET** /{currency}/addresses/{address} | Get an address
+*AddressesApi* | [**get_address_entity**](docs/AddressesApi.md#get_address_entity) | **GET** /{currency}/addresses/{address}/entity | Get the entity of an address
+*AddressesApi* | [**list_address_links**](docs/AddressesApi.md#list_address_links) | **GET** /{currency}/addresses/{address}/links | Get outgoing transactions between two addresses
+*AddressesApi* | [**list_address_neighbors**](docs/AddressesApi.md#list_address_neighbors) | **GET** /{currency}/addresses/{address}/neighbors | Get an address's neighbors in the address graph
+*AddressesApi* | [**list_address_txs**](docs/AddressesApi.md#list_address_txs) | **GET** /{currency}/addresses/{address}/txs | Get all transactions an address has been involved in
+*AddressesApi* | [**list_tags_by_address**](docs/AddressesApi.md#list_tags_by_address) | **GET** /{currency}/addresses/{address}/tags | Get attribution tags for a given address
+*BlocksApi* | [**get_block**](docs/BlocksApi.md#get_block) | **GET** /{currency}/blocks/{height} | Get a block by its height
+*BlocksApi* | [**list_block_txs**](docs/BlocksApi.md#list_block_txs) | **GET** /{currency}/blocks/{height}/txs | Get block transactions
+*BulkApi* | [**bulk_csv**](docs/BulkApi.md#bulk_csv) | **POST** /{currency}/bulk.csv/{operation} | Get data as CSV in bulk
+*BulkApi* | [**bulk_json**](docs/BulkApi.md#bulk_json) | **POST** /{currency}/bulk.json/{operation} | Get data as JSON in bulk
+*EntitiesApi* | [**get_entity**](docs/EntitiesApi.md#get_entity) | **GET** /{currency}/entities/{entity} | Get an entity
+*EntitiesApi* | [**list_address_tags_by_entity**](docs/EntitiesApi.md#list_address_tags_by_entity) | **GET** /{currency}/entities/{entity}/tags | Get address tags for a given entity
+*EntitiesApi* | [**list_entity_addresses**](docs/EntitiesApi.md#list_entity_addresses) | **GET** /{currency}/entities/{entity}/addresses | Get an entity's addresses
+*EntitiesApi* | [**list_entity_links**](docs/EntitiesApi.md#list_entity_links) | **GET** /{currency}/entities/{entity}/links | Get transactions between two entities
+*EntitiesApi* | [**list_entity_neighbors**](docs/EntitiesApi.md#list_entity_neighbors) | **GET** /{currency}/entities/{entity}/neighbors | Get an entity's direct neighbors
+*EntitiesApi* | [**list_entity_txs**](docs/EntitiesApi.md#list_entity_txs) | **GET** /{currency}/entities/{entity}/txs | Get all transactions an entity has been involved in
+*EntitiesApi* | [**search_entity_neighbors**](docs/EntitiesApi.md#search_entity_neighbors) | **GET** /{currency}/entities/{entity}/search | Search deeply for matching neighbors
+*GeneralApi* | [**get_statistics**](docs/GeneralApi.md#get_statistics) | **GET** /stats | Get statistics of supported currencies
+*GeneralApi* | [**search**](docs/GeneralApi.md#search) | **GET** /search | Returns matching addresses, transactions and labels
+*RatesApi* | [**get_exchange_rates**](docs/RatesApi.md#get_exchange_rates) | **GET** /{currency}/rates/{height} | Returns exchange rate for a given height
+*TagsApi* | [**get_actor**](docs/TagsApi.md#get_actor) | **GET** /tags/actors/{actor} | Returns an actor given its unique id or (unique) label
+*TagsApi* | [**get_actor_tags**](docs/TagsApi.md#get_actor_tags) | **GET** /tags/actors/{actor}/tags | Returns the address tags for a given actor
+*TagsApi* | [**list_address_tags**](docs/TagsApi.md#list_address_tags) | **GET** /tags | Returns address tags associated with a given label
+*TagsApi* | [**list_concepts**](docs/TagsApi.md#list_concepts) | **GET** /tags/taxonomies/{taxonomy}/concepts | Returns the supported concepts of a taxonomy
+*TagsApi* | [**list_taxonomies**](docs/TagsApi.md#list_taxonomies) | **GET** /tags/taxonomies | Returns the supported taxonomies
+*TokensApi* | [**list_supported_tokens**](docs/TokensApi.md#list_supported_tokens) | **GET** /{currency}/supported_tokens | Returns a list of supported token (sub)currencies.
+*TxsApi* | [**get_spending_txs**](docs/TxsApi.md#get_spending_txs) | **GET** /{currency}/txs/{tx_hash}/spending | Returns in which other transaction's outputs the asked transaction spent. Think backwards references is the transaction graph. This endpoint is only available for utxo like currencies.
+*TxsApi* | [**get_spent_in_txs**](docs/TxsApi.md#get_spent_in_txs) | **GET** /{currency}/txs/{tx_hash}/spent_in | Returns in which other transactions, outputs from the asked transaction are spent. Think forward references in the transaction graph. This endpoint is only available for utxo like currencies.
+*TxsApi* | [**get_tx**](docs/TxsApi.md#get_tx) | **GET** /{currency}/txs/{tx_hash} | Returns details of a specific transaction identified by its hash.
+*TxsApi* | [**get_tx_io**](docs/TxsApi.md#get_tx_io) | **GET** /{currency}/txs/{tx_hash}/{io} | Returns input/output values of a specific transaction identified by its hash.
+*TxsApi* | [**list_token_txs**](docs/TxsApi.md#list_token_txs) | **GET** /{currency}/token_txs/{tx_hash} | Returns all token transactions in a given transaction
+
+
+## Documentation For Models
+
+ - [Actor](docs/Actor.md)
+ - [ActorContext](docs/ActorContext.md)
+ - [Actors](docs/Actors.md)
+ - [Address](docs/Address.md)
+ - [AddressTag](docs/AddressTag.md)
+ - [AddressTagAllOf](docs/AddressTagAllOf.md)
+ - [AddressTags](docs/AddressTags.md)
+ - [AddressTx](docs/AddressTx.md)
+ - [AddressTxUtxo](docs/AddressTxUtxo.md)
+ - [AddressTxs](docs/AddressTxs.md)
+ - [Block](docs/Block.md)
+ - [Concept](docs/Concept.md)
+ - [CurrencyStats](docs/CurrencyStats.md)
+ - [Entity](docs/Entity.md)
+ - [EntityAddresses](docs/EntityAddresses.md)
+ - [Height](docs/Height.md)
+ - [LabeledItemRef](docs/LabeledItemRef.md)
+ - [LabeledItemRefs](docs/LabeledItemRefs.md)
+ - [Link](docs/Link.md)
+ - [LinkUtxo](docs/LinkUtxo.md)
+ - [Links](docs/Links.md)
+ - [NeighborAddress](docs/NeighborAddress.md)
+ - [NeighborAddresses](docs/NeighborAddresses.md)
+ - [NeighborEntities](docs/NeighborEntities.md)
+ - [NeighborEntity](docs/NeighborEntity.md)
+ - [Rate](docs/Rate.md)
+ - [Rates](docs/Rates.md)
+ - [SearchResult](docs/SearchResult.md)
+ - [SearchResultByCurrency](docs/SearchResultByCurrency.md)
+ - [SearchResultLabels](docs/SearchResultLabels.md)
+ - [SearchResultLeaf](docs/SearchResultLeaf.md)
+ - [SearchResultLevel1](docs/SearchResultLevel1.md)
+ - [SearchResultLevel2](docs/SearchResultLevel2.md)
+ - [SearchResultLevel3](docs/SearchResultLevel3.md)
+ - [SearchResultLevel4](docs/SearchResultLevel4.md)
+ - [SearchResultLevel5](docs/SearchResultLevel5.md)
+ - [SearchResultLevel6](docs/SearchResultLevel6.md)
+ - [Stats](docs/Stats.md)
+ - [Tag](docs/Tag.md)
+ - [Taxonomy](docs/Taxonomy.md)
+ - [TokenConfig](docs/TokenConfig.md)
+ - [TokenConfigs](docs/TokenConfigs.md)
+ - [TokenValues](docs/TokenValues.md)
+ - [Tx](docs/Tx.md)
+ - [TxAccount](docs/TxAccount.md)
+ - [TxRef](docs/TxRef.md)
+ - [TxSummary](docs/TxSummary.md)
+ - [TxUtxo](docs/TxUtxo.md)
+ - [TxValue](docs/TxValue.md)
+ - [TxValues](docs/TxValues.md)
+ - [TxsAccount](docs/TxsAccount.md)
+ - [Values](docs/Values.md)
+
+
+## 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](https://jupyter.org/) notebooks demonstrating how to use the GraphSense Python API. Please Follow these setup instructions to run them:
+
+Setup a Python environment with [Anaconda](https://www.anaconda.com/products/distribution):
+
+    conda env create -f environment.yml
+    conda activate graphsense-python
+
+Copy the config temp file and enter your Iknaio API key
+
+    cp config.json.tmp config.json
+    vi config.json
+
+Run the jupyter notebooks
+
+    jupyter notebook
+
+

graphsense-python-1.4.0/graphsense/__init__.py

@@ -0,0 +1,28 @@
+# flake8: noqa
+
+"""
+    GraphSense API
+
+    GraphSense API provides programmatic access to various ledgers' addresses, entities, blocks, transactions and tags for automated and highly efficient forensics tasks.  # noqa: E501
+
+    The version of the OpenAPI document: 1.4.0
+    Contact: contact@ikna.io
+    Generated by: https://openapi-generator.tech
+"""
+
+
+__version__ = "1.4.0"
+
+# import ApiClient
+from graphsense.api_client import ApiClient
+
+# import Configuration
+from graphsense.configuration import Configuration
+
+# import exceptions
+from graphsense.exceptions import OpenApiException
+from graphsense.exceptions import ApiAttributeError
+from graphsense.exceptions import ApiTypeError
+from graphsense.exceptions import ApiValueError
+from graphsense.exceptions import ApiKeyError
+from graphsense.exceptions import ApiException

graphsense-python-1.4.0/graphsense/api/__init__.py

@@ -0,0 +1,3 @@
+# do not import all apis into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all apis from one package, import them with
+# from graphsense.apis import AddressesApi