Release version 2024.8.16.10

coinmetrics/__init__.py

@@ -1 +1 @@
-__version__ = "2024.8.14.17"
+__version__ = "2024.8.16.10"

default.nix

@@ -20,7 +20,7 @@
 
 buildPythonPackage rec {
   pname = "coinmetrics-api-client";
-  version = "2024.8.14.17";
+  version = "2024.8.16.10";
   format = "pyproject";
 
   disabled = pythonOlder "3.9";

docs/docs/api_client.md

@@ -4353,182 +4353,6 @@ def get_stream_market_open_interest(
 
 `CmStream`: 
 
-<a id="coinmetrics.api_client.CoinMetricsClient.get_list_of_blocks"></a>
-
-#### get\_list\_of\_blocks
-
-```python
-def get_list_of_blocks(asset: str,
-                       block_hashes: Optional[Union[List[str], str]] = None,
-                       heights: Optional[Union[List[str], str]] = None,
-                       page_size: Optional[int] = None,
-                       paging_from: Optional[Union[PagingFrom, str]] = "start",
-                       start_time: Optional[Union[datetime, date, str]] = None,
-                       end_time: Optional[Union[datetime, date, str]] = None,
-                       start_height: Optional[int] = None,
-                       end_height: Optional[int] = None,
-                       start_inclusive: Optional[bool] = None,
-                       end_inclusive: Optional[bool] = None,
-                       timezone: Optional[str] = None) -> DataCollection
-```
-
-Returns a list of blockchain blocks metadata.
-
-**Arguments**:
-
-- `asset` (`str`): Asset name
-- `block_hashes` (`str, list(str)`): Optional comma separated list of block hashes to filter a response.
-- `heights` (`str, list(str)`): Optional comma separated list of block heights to filter a response.
-- `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number.
-- `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
-- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
-- `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
-- `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default.
-- `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default.
-- `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
-
-**Returns**:
-
-`DataCollection`: list of blockchain blocks metadata
-
-<a id="coinmetrics.api_client.CoinMetricsClient.get_list_of_accounts"></a>
-
-#### get\_list\_of\_accounts
-
-```python
-def get_list_of_accounts(asset: str,
-                         accounts: Optional[Union[List[str], str]] = None,
-                         page_size: Optional[int] = None,
-                         paging_from: Optional[Union[PagingFrom,
-                                                     str]] = "start",
-                         start_time: Optional[Union[datetime, date,
-                                                    str]] = None,
-                         end_time: Optional[Union[datetime, date, str]] = None,
-                         start_height: Optional[int] = None,
-                         end_height: Optional[int] = None,
-                         start_chain_sequence_number: Optional[int] = None,
-                         end_chain_sequence_number: Optional[int] = None,
-                         start_inclusive: Optional[bool] = None,
-                         end_inclusive: Optional[bool] = None,
-                         timezone: Optional[str] = None) -> DataCollection
-```
-
-Returns a list of blockchain accounts with their balances.
-
-**Arguments**:
-
-- `asset` (`str`): Asset name
-- `accounts` (`str, list(str)`): Optional comma separated list of accounts to filter a response.
-- `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number.
-- `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
-- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
-- `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
-- `start_chain_sequence_number` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
-- `end_chain_sequence_number` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
-- `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default.
-- `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default.
-- `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
-
-**Returns**:
-
-`DataCollection`: list of blockchain accounts metadata
-
-<a id="coinmetrics.api_client.CoinMetricsClient.get_list_of_transactions"></a>
-
-#### get\_list\_of\_transactions
-
-```python
-def get_list_of_transactions(asset: str,
-                             transaction_hashes: Optional[Union[List[str],
-                                                                str]] = None,
-                             block_hashes: Optional[Union[List[str],
-                                                          str]] = None,
-                             page_size: Optional[int] = None,
-                             paging_from: Optional[Union[PagingFrom,
-                                                         str]] = "start",
-                             start_time: Optional[Union[datetime, date,
-                                                        str]] = None,
-                             end_time: Optional[Union[datetime, date,
-                                                      str]] = None,
-                             start_height: Optional[int] = None,
-                             end_height: Optional[int] = None,
-                             start_inclusive: Optional[bool] = None,
-                             end_inclusive: Optional[bool] = None,
-                             timezone: Optional[str] = None) -> DataCollection
-```
-
-Returns a list of blockchain transactions metadata.
-
-**Arguments**:
-
-- `asset` (`str`): Asset name
-- `transaction_hashes` (`str, list(str)`): Optional comma separated list of transaction hashes to filter a response.
-- `block_hashes` (`str, list(str)`): Optional comma separated list of block hashes to filter a response.
-- `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number.
-- `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
-- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
-- `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
-- `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default.
-- `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default.
-- `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
-
-**Returns**:
-
-`DataCollection`: list of transaction metadata
-
-<a id="coinmetrics.api_client.CoinMetricsClient.get_list_of_balance_updates"></a>
-
-#### get\_list\_of\_balance\_updates
-
-```python
-def get_list_of_balance_updates(
-        asset: str,
-        accounts: Optional[Union[List[str], str]] = None,
-        transaction_hashes: Optional[Union[List[str], str]] = None,
-        block_hashes: Optional[Union[List[str], str]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        start_chain_sequence_number: Optional[int] = None,
-        end_chain_sequence_number: Optional[int] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None) -> DataCollection
-```
-
-Returns a list of blockchain accounts balance updates.
-
-**Arguments**:
-
-- `asset` (`str`): Asset name
-- `accounts` (`str, list(str)`): Optional comma separated list of accounts to filter a response.
-- `transaction_hashes` (`str, list(str)`): Optional comma separated list of transaction hashes to filter a response.
-- `block_hashes` (`str, list(str)`): Optional comma separated list of block hashes to filter a response.
-- `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number.
-- `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
-- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
-- `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
-- `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
-- `start_chain_sequence_number` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
-- `end_chain_sequence_number` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
-- `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default.
-- `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default.
-- `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
-
-**Returns**:
-
-`DataCollection`: list of balance updates
-
 <a id="coinmetrics.api_client.CoinMetricsClient.get_list_of_blocks_v2"></a>
 
 #### get\_list\_of\_blocks\_v2
@@ -4759,42 +4583,6 @@ Returns a list of blockchain accounts balance updates.
 
 `DataCollection`: list of balance updates
 
-<a id="coinmetrics.api_client.CoinMetricsClient.get_full_transaction_for_block"></a>
-
-#### get\_full\_transaction\_for\_block
-
-```python
-def get_full_transaction_for_block(asset: str, block_hash: str,
-                                   txid: str) -> List[Dict[str, Any]]
-```
-
-**Arguments**:
-
-- `asset` (`str`): Asset name.
-- `block_hash` (`str`): Block hash.
-- `txid` (`str`): Transaction identifier (txid).
-
-**Returns**:
-
-`DataCollection`: Blockchain full transaction.
-
-<a id="coinmetrics.api_client.CoinMetricsClient.get_full_block"></a>
-
-#### get\_full\_block
-
-```python
-def get_full_block(asset: str, block_hash: str) -> Dict[str, Any]
-```
-
-**Arguments**:
-
-- `asset` (`str`): Asset name.
-- `block_hash` (`str`): Block hash.
-
-**Returns**:
-
-`Dict[str, Any]`: Blockchain full block.
-
 <a id="coinmetrics.api_client.CoinMetricsClient.get_full_block_v2"></a>
 
 #### get\_full\_block\_v2
@@ -4817,23 +4605,6 @@ Returns a full blockchain block with all transactions and balance updates.
 
 `list(dict(str), any)`: blockchain block data
 
-<a id="coinmetrics.api_client.CoinMetricsClient.get_full_transaction"></a>
-
-#### get\_full\_transaction
-
-```python
-def get_full_transaction(asset: str, txid: str) -> List[Dict[str, Any]]
-```
-
-**Arguments**:
-
-- `asset` (`Optional[str]`): Asset name.
-- `txid` (`Optional[str]`): Transaction identifier (txid).
-
-**Returns**:
-
-`DataCollection`: Blockchain full transaction.
-
 <a id="coinmetrics.api_client.CoinMetricsClient.get_full_transaction_v2"></a>
 
 #### get\_full\_transaction\_v2