graphsense-python 2.9.8

GraphSense API

graphsense-python

GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, entities, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.

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

• API version: 2.9.8
• Package version: 2.9.8
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.iknaio.com/

Requirements.

Python 3.9+

Installation & Usage

pip install

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

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.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

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import graphsense
from graphsense.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.iknaio.com
# See configuration.py for a list of all supported configuration parameters.
configuration = graphsense.Configuration(
    host = "https://api.iknaio.com"
)

# 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'] = os.environ["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 = graphsense.AddressesApi(api_client)
    currency = 'btc' # str | The cryptocurrency code (e.g., btc)
    address = '1Archive1n2C579dMsAu3iC6tWzuQJz8dN' # str | The cryptocurrency address
    include_actors = True # bool | Whether to include actor information (optional) (default to True)

    try:
        # Get an address
        api_response = api_instance.get_address(currency, address, include_actors=include_actors)
        print("The response of AddressesApi->get_address:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddressesApi->get_address: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.iknaio.com

Class	Method	HTTP request	Description
AddressesApi	get_address	GET /{currency}/addresses/{address}	Get an address
AddressesApi	get_address_entity	GET /{currency}/addresses/{address}/entity	Get the entity for an address
AddressesApi	get_tag_summary_by_address	GET /{currency}/addresses/{address}/tag_summary	Get address attribution tag summary
AddressesApi	list_address_links	GET /{currency}/addresses/{address}/links	List transactions between two addresses
AddressesApi	list_address_neighbors	GET /{currency}/addresses/{address}/neighbors	List neighboring addresses
AddressesApi	list_address_txs	GET /{currency}/addresses/{address}/txs	List transactions involving an address
AddressesApi	list_related_addresses	GET /{currency}/addresses/{address}/related_addresses	List related addresses
AddressesApi	list_tags_by_address	GET /{currency}/addresses/{address}/tags	List attribution tags for an address
BlocksApi	get_block	GET /{currency}/blocks/{height}	Get block details by height
BlocksApi	get_block_by_date	GET /{currency}/block_by_date/{date}	Get block at or before a date
BlocksApi	list_block_txs	GET /{currency}/blocks/{height}/txs	List transactions in a block
BulkApi	bulk_csv	POST /{currency}/bulk.csv/{operation}	Stream bulk operation results as CSV
BulkApi	bulk_json	POST /{currency}/bulk.json/{operation}	Stream bulk operation results as JSON
EntitiesApi	get_entity	GET /{currency}/entities/{entity}	Get entity details
EntitiesApi	list_address_tags_by_entity	GET /{currency}/entities/{entity}/tags	List entity address tags
EntitiesApi	list_entity_addresses	GET /{currency}/entities/{entity}/addresses	List entity addresses
EntitiesApi	list_entity_links	GET /{currency}/entities/{entity}/links	List transactions between entities
EntitiesApi	list_entity_neighbors	GET /{currency}/entities/{entity}/neighbors	List neighboring entities
EntitiesApi	list_entity_txs	GET /{currency}/entities/{entity}/txs	List entity transactions
EntitiesApi	search_entity_neighbors	GET /{currency}/entities/{entity}/search	Search entity neighborhood
GeneralApi	get_statistics	GET /stats	Get platform statistics for supported currencies
GeneralApi	search	GET /search	Search addresses, transactions, actors, and labels
RatesApi	get_exchange_rates	GET /{currency}/rates/{height}	Get fiat exchange rates at a block height
TagsApi	get_actor	GET /tags/actors/{actor}	Get actor details by ID
TagsApi	get_actor_tags	GET /tags/actors/{actor}/tags	List tags associated with an actor
TagsApi	list_address_tags	GET /tags	List address tags by label
TagsApi	list_concepts	GET /tags/taxonomies/{taxonomy}/concepts	List concepts for a taxonomy
TagsApi	list_taxonomies	GET /tags/taxonomies	List all taxonomies
TagsApi	report_tag	POST /tags/report-tag	Submit a user-reported tag
TokensApi	list_supported_tokens	GET /{currency}/supported_tokens	List supported tokens for a currency
TxsApi	get_spending_txs	GET /{currency}/txs/{tx_hash}/spending	List source transactions
TxsApi	get_spent_in_txs	GET /{currency}/txs/{tx_hash}/spent_in	List spending transactions
TxsApi	get_tx	GET /{currency}/txs/{tx_hash}	Get transaction details by hash
TxsApi	get_tx_conversions	GET /{currency}/txs/{tx_hash}/conversions	List DeFi conversions in a transaction
TxsApi	get_tx_io	GET /{currency}/txs/{tx_hash}/{io}	List transaction inputs or outputs
TxsApi	list_token_txs	GET /{currency}/token_txs/{tx_hash}	List token transfers in a transaction
TxsApi	list_tx_flows	GET /{currency}/txs/{tx_hash}/flows	List transaction asset flows

Documentation For Models

• Actor
• ActorContext
• Address
• AddressTag
• AddressTags
• AddressTx
• AddressTxUtxo
• AddressTxs
• Block
• BlockAtDate
• Concept
• CurrencyStats
• Entity
• EntityAddresses
• ExternalConversion
• HTTPValidationError
• LabelSummary
• LabeledItemRef
• Link
• LinkUtxo
• Links
• LinksInner
• LocationInner
• NeighborAddress
• NeighborAddresses
• NeighborEntities
• NeighborEntity
• Rate
• Rates
• RelatedAddress
• RelatedAddresses
• SearchResult
• SearchResultByCurrency
• SearchResultLevel1
• SearchResultLevel2
• SearchResultLevel3
• SearchResultLevel4
• SearchResultLevel5
• SearchResultLevel6
• Stats
• Tag
• TagCloudEntry
• TagSummary
• Taxonomy
• TokenConfig
• TokenConfigs
• Tx
• TxAccount
• TxRef
• TxSummary
• TxUtxo
• TxValue
• UserReportedTag
• UserTagReportResponse
• ValidationError
• Values

Documentation For Authorization

Authentication schemes defined for the API:

api_key

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

Author

[e-mail]