graphsense-python 2.10.0__py3-none-any.whl → 2.12.0__py3-none-any.whl

graphsense/__init__.py

@@ -5,20 +5,21 @@
 """
     GraphSense API
 
-    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.  # noqa: E501
+    GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, clusters, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.  ## Versioning and deprecation policy  The API follows semantic versioning. Minor releases are additive and backwards-compatible; breaking changes only happen in major releases, which are rare and announced in advance.  Deprecated endpoints and fields remain fully functional for at least six months after they are marked deprecated. During that window they are highlighted with a strikethrough in the docs and in generated clients, and responses from deprecated endpoints carry a `Deprecation` HTTP header that client tooling can detect. Replacement endpoints and fields are always introduced before the deprecated surface is removed.  See the [full versioning and deprecation policy](https://github.com/graphsense/graphsense-lib/blob/master/README.md#rest-api-evolution-and-deprecation-policy) for details.   # noqa: E501
 
     Contact: contact@iknaio.com
     Generated by: https://openapi-generator.tech
 """
 
 
-__version__ = "2.10.0"
+__version__ = "2.12.0"
 
 # Define package exports
 __all__ = [
     "AddressesApi",
     "BlocksApi",
     "BulkApi",
+    "ClustersApi",
     "EntitiesApi",
     "GeneralApi",
     "RatesApi",
@@ -46,6 +47,8 @@ __all__ = [
     "Block",
     "BlockAtDate",
     "ChangeHeuristics",
+    "Cluster",
+    "ClusterAddresses",
     "CoinJoinConsensus",
     "CoinJoinHeuristics",
     "Concept",
@@ -67,6 +70,8 @@ __all__ = [
     "MultiInputChangeHeuristic",
     "NeighborAddress",
     "NeighborAddresses",
+    "NeighborCluster",
+    "NeighborClusters",
     "NeighborEntities",
     "NeighborEntity",
     "OneTimeChangeHeuristic",
@@ -112,6 +117,7 @@ import graphsense.compat  # noqa: F401
 from graphsense.api.addresses_api import AddressesApi as AddressesApi
 from graphsense.api.blocks_api import BlocksApi as BlocksApi
 from graphsense.api.bulk_api import BulkApi as BulkApi
+from graphsense.api.clusters_api import ClustersApi as ClustersApi
 from graphsense.api.entities_api import EntitiesApi as EntitiesApi
 from graphsense.api.general_api import GeneralApi as GeneralApi
 from graphsense.api.rates_api import RatesApi as RatesApi
@@ -143,6 +149,8 @@ from graphsense.models.address_txs import AddressTxs as AddressTxs
 from graphsense.models.block import Block as Block
 from graphsense.models.block_at_date import BlockAtDate as BlockAtDate
 from graphsense.models.change_heuristics import ChangeHeuristics as ChangeHeuristics
+from graphsense.models.cluster import Cluster as Cluster
+from graphsense.models.cluster_addresses import ClusterAddresses as ClusterAddresses
 from graphsense.models.coin_join_consensus import CoinJoinConsensus as CoinJoinConsensus
 from graphsense.models.coin_join_heuristics import CoinJoinHeuristics as CoinJoinHeuristics
 from graphsense.models.concept import Concept as Concept
@@ -164,6 +172,8 @@ from graphsense.models.location_inner import LocationInner as LocationInner
 from graphsense.models.multi_input_change_heuristic import MultiInputChangeHeuristic as MultiInputChangeHeuristic
 from graphsense.models.neighbor_address import NeighborAddress as NeighborAddress
 from graphsense.models.neighbor_addresses import NeighborAddresses as NeighborAddresses
+from graphsense.models.neighbor_cluster import NeighborCluster as NeighborCluster
+from graphsense.models.neighbor_clusters import NeighborClusters as NeighborClusters
 from graphsense.models.neighbor_entities import NeighborEntities as NeighborEntities
 from graphsense.models.neighbor_entity import NeighborEntity as NeighborEntity
 from graphsense.models.one_time_change_heuristic import OneTimeChangeHeuristic as OneTimeChangeHeuristic

graphsense/api/__init__.py

@@ -4,6 +4,7 @@
 from graphsense.api.addresses_api import AddressesApi
 from graphsense.api.blocks_api import BlocksApi
 from graphsense.api.bulk_api import BulkApi
+from graphsense.api.clusters_api import ClustersApi
 from graphsense.api.entities_api import EntitiesApi
 from graphsense.api.general_api import GeneralApi
 from graphsense.api.rates_api import RatesApi

graphsense/api/addresses_api.py

@@ -3,7 +3,7 @@
 """
     GraphSense API
 
-    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.  # noqa: E501
+    GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, clusters, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.  ## Versioning and deprecation policy  The API follows semantic versioning. Minor releases are additive and backwards-compatible; breaking changes only happen in major releases, which are rare and announced in advance.  Deprecated endpoints and fields remain fully functional for at least six months after they are marked deprecated. During that window they are highlighted with a strikethrough in the docs and in generated clients, and responses from deprecated endpoints carry a `Deprecation` HTTP header that client tooling can detect. Replacement endpoints and fields are always introduced before the deprecated surface is removed.  See the [full versioning and deprecation policy](https://github.com/graphsense/graphsense-lib/blob/master/README.md#rest-api-evolution-and-deprecation-policy) for details.   # noqa: E501
 
     Contact: contact@iknaio.com
     Generated by: https://openapi-generator.tech
@@ -20,6 +20,7 @@ from typing_extensions import Annotated
 from graphsense.models.address import Address
 from graphsense.models.address_tags import AddressTags
 from graphsense.models.address_txs import AddressTxs
+from graphsense.models.cluster import Cluster
 from graphsense.models.entity import Entity
 from graphsense.models.links import Links
 from graphsense.models.neighbor_addresses import NeighborAddresses
@@ -433,6 +434,305 @@ class AddressesApi:
 
 
 
+    @validate_call_compat
+    def get_address_cluster(
+        self,
+        currency: Annotated[StrictStr, Field(description="The cryptocurrency code (e.g., btc)")],
+        address: Annotated[StrictStr, Field(description="The cryptocurrency address")],
+        include_actors: Annotated[Optional[StrictBool], Field(description="Whether to include actor information")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> Cluster:
+        """Get the cluster for an address
+
+        Returns the address cluster that contains the given address.
+
+        :param currency: The cryptocurrency code (e.g., btc) (required)
+        :type currency: str
+        :param address: The cryptocurrency address (required)
+        :type address: str
+        :param include_actors: Whether to include actor information
+        :type include_actors: bool
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_address_cluster_serialize(
+            currency=currency,
+            address=address,
+            include_actors=include_actors,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Cluster",
+            '404': None,
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call_compat
+    def get_address_cluster_with_http_info(
+        self,
+        currency: Annotated[StrictStr, Field(description="The cryptocurrency code (e.g., btc)")],
+        address: Annotated[StrictStr, Field(description="The cryptocurrency address")],
+        include_actors: Annotated[Optional[StrictBool], Field(description="Whether to include actor information")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[Cluster]:
+        """Get the cluster for an address
+
+        Returns the address cluster that contains the given address.
+
+        :param currency: The cryptocurrency code (e.g., btc) (required)
+        :type currency: str
+        :param address: The cryptocurrency address (required)
+        :type address: str
+        :param include_actors: Whether to include actor information
+        :type include_actors: bool
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_address_cluster_serialize(
+            currency=currency,
+            address=address,
+            include_actors=include_actors,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Cluster",
+            '404': None,
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call_compat
+    def get_address_cluster_without_preload_content(
+        self,
+        currency: Annotated[StrictStr, Field(description="The cryptocurrency code (e.g., btc)")],
+        address: Annotated[StrictStr, Field(description="The cryptocurrency address")],
+        include_actors: Annotated[Optional[StrictBool], Field(description="Whether to include actor information")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get the cluster for an address
+
+        Returns the address cluster that contains the given address.
+
+        :param currency: The cryptocurrency code (e.g., btc) (required)
+        :type currency: str
+        :param address: The cryptocurrency address (required)
+        :type address: str
+        :param include_actors: Whether to include actor information
+        :type include_actors: bool
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_address_cluster_serialize(
+            currency=currency,
+            address=address,
+            include_actors=include_actors,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Cluster",
+            '404': None,
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_address_cluster_serialize(
+        self,
+        currency,
+        address,
+        include_actors,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if currency is not None:
+            _path_params['currency'] = currency
+        if address is not None:
+            _path_params['address'] = address
+        # process the query parameters
+        if include_actors is not None:
+            
+            _query_params.append(('include_actors', include_actors))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'api_key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/{currency}/addresses/{address}/cluster',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call_compat
     def get_address_entity(
         self,
@@ -452,9 +752,9 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> Entity:
-        """Get the entity for an address
+        """(Deprecated) Get the entity for an address
 
-        Returns the clustered entity that contains the given address.
+        Deprecated alias for `GET /{currency}/addresses/{address}/cluster`. Returns the address cluster that contains the given address.
 
         :param currency: The cryptocurrency code (e.g., btc) (required)
         :type currency: str
@@ -483,6 +783,7 @@ class AddressesApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("GET /{currency}/addresses/{address}/entity is deprecated.", DeprecationWarning)
 
         _param = self._get_address_entity_serialize(
             currency=currency,
@@ -529,9 +830,9 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[Entity]:
-        """Get the entity for an address
+        """(Deprecated) Get the entity for an address
 
-        Returns the clustered entity that contains the given address.
+        Deprecated alias for `GET /{currency}/addresses/{address}/cluster`. Returns the address cluster that contains the given address.
 
         :param currency: The cryptocurrency code (e.g., btc) (required)
         :type currency: str
@@ -560,6 +861,7 @@ class AddressesApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("GET /{currency}/addresses/{address}/entity is deprecated.", DeprecationWarning)
 
         _param = self._get_address_entity_serialize(
             currency=currency,
@@ -606,9 +908,9 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get the entity for an address
+        """(Deprecated) Get the entity for an address
 
-        Returns the clustered entity that contains the given address.
+        Deprecated alias for `GET /{currency}/addresses/{address}/cluster`. Returns the address cluster that contains the given address.
 
         :param currency: The cryptocurrency code (e.g., btc) (required)
         :type currency: str
@@ -637,6 +939,7 @@ class AddressesApi:
         :type _host_index: int, optional
         :return: Returns the result object.
         """ # noqa: E501
+        warnings.warn("GET /{currency}/addresses/{address}/entity is deprecated.", DeprecationWarning)
 
         _param = self._get_address_entity_serialize(
             currency=currency,

graphsense/api/blocks_api.py

@@ -3,7 +3,7 @@
 """
     GraphSense API
 
-    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.  # noqa: E501
+    GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, clusters, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.  ## Versioning and deprecation policy  The API follows semantic versioning. Minor releases are additive and backwards-compatible; breaking changes only happen in major releases, which are rare and announced in advance.  Deprecated endpoints and fields remain fully functional for at least six months after they are marked deprecated. During that window they are highlighted with a strikethrough in the docs and in generated clients, and responses from deprecated endpoints carry a `Deprecation` HTTP header that client tooling can detect. Replacement endpoints and fields are always introduced before the deprecated surface is removed.  See the [full versioning and deprecation policy](https://github.com/graphsense/graphsense-lib/blob/master/README.md#rest-api-evolution-and-deprecation-policy) for details.   # noqa: E501
 
     Contact: contact@iknaio.com
     Generated by: https://openapi-generator.tech

graphsense/api/bulk_api.py

@@ -3,7 +3,7 @@
 """
     GraphSense API
 
-    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.  # noqa: E501
+    GraphSense API provides programmatic access to blockchain analytics data across multiple ledgers. Use it to explore addresses, clusters, blocks, transactions, tags, token activity, and exchange-rate context, and to integrate investigation workflows into your own applications and automation.  ## Versioning and deprecation policy  The API follows semantic versioning. Minor releases are additive and backwards-compatible; breaking changes only happen in major releases, which are rare and announced in advance.  Deprecated endpoints and fields remain fully functional for at least six months after they are marked deprecated. During that window they are highlighted with a strikethrough in the docs and in generated clients, and responses from deprecated endpoints carry a `Deprecation` HTTP header that client tooling can detect. Replacement endpoints and fields are always introduced before the deprecated surface is removed.  See the [full versioning and deprecation policy](https://github.com/graphsense/graphsense-lib/blob/master/README.md#rest-api-evolution-and-deprecation-policy) for details.   # noqa: E501
 
     Contact: contact@iknaio.com
     Generated by: https://openapi-generator.tech