Release version 2024.10.4.15

coinmetrics/__init__.py

@@ -1 +1 @@
-__version__ = "2024.9.18.17"
+__version__ = "2024.10.4.15"

default.nix

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

docs/docs/api_client.md

@@ -2026,6 +2026,7 @@ def catalog_market_metrics_v2(
 **Arguments**:
 
 - `markets` (`Optional[Union[str, List[str]]]`): Comma separated list of markets. By default all markets are returned.
+- `metrics` (`Optional[Union[str, List[str]]]`): Comma separated list of metrics. By default all metrics are returned.
 - `exchange` (`Optional[str]`): Unique name of an exchange.
 - `market_type` (`Optional[str]`): Type of markets.
 - `base` (`Optional[str]`): Base asset of markets.
@@ -2471,6 +2472,7 @@ def catalog_full_market_metrics_v2(
 **Arguments**:
 
 - `markets` (`Optional[Union[str, List[str]]]`): Comma separated list of markets. By default all markets are returned.
+- `metrics` (`Optional[Union[str, List[str]]]`): Comma separated list of metrics. By default all metrics are returned.
 - `exchange` (`Optional[str]`): Unique name of an exchange.
 - `market_type` (`Optional[str]`): Type of markets.
 - `base` (`Optional[str]`): Base asset of markets.

docs/docs/index.md

@@ -199,6 +199,11 @@ system
 and `.export_to_json_files()`. Using the methods that return a single output - `.export_to_csv()`, `export_to_list()`, and
 `.export_to_dataframe()` need to join the data from many threads before it can be returned, this may use a lot of memory
 if you are accessing data types like market orderbooks or market trades and could fail altogether
+* If using `export_to_csv/json_files()` functions, note that by default they will be saved in the directory format `/{endpoint}/{parallelize_on}`.
+For example, in `export_to_json_files()`, 
+`client.get_market_trades("coinbase-eth-btc-spot,coinbase-eth-usdc-spot").parallel("markets")` will create a file each like ./market-trades/coinbase-eth-btc-spot.json, ./market-trades/coinbase-eth-usdc-spot.json
+`client.get_asset_metrics('btc,eth', 'ReferenceRateUSD', start_time='2024-01-01', limit_per_asset=1).parallel("assets,metrics", time_increment=timedelta(days=1))`
+will create a file each like ./asset-metrics/btc/ReferenceRateUSD/start_time=2024-01-01T00-00-00Z.json, ./asset-metrics/eth/ReferenceRateUSD/start_time=2024-01-01T00-00-00Z.json
 * If you get the error `BrokenProcessPool` it [might be because you're missing a main() function](https://stackoverflow.com/questions/15900366/all-example-concurrent-futures-code-is-failing-with-brokenprocesspool)
 
 ## Examples

docs/site/api_client.html

@@ -4346,6 +4346,7 @@ <h4 id="catalog_market_metrics_v2">catalog_market_metrics_v2<a class="headerlink
 <p><strong>Arguments</strong>:</p>
 <ul>
 <li><code>markets</code> (<code>Optional[Union[str, List[str]]]</code>): Comma separated list of markets. By default all markets are returned.</li>
+<li><code>metrics</code> (<code>Optional[Union[str, List[str]]]</code>): Comma separated list of metrics. By default all metrics are returned.</li>
 <li><code>exchange</code> (<code>Optional[str]</code>): Unique name of an exchange.</li>
 <li><code>market_type</code> (<code>Optional[str]</code>): Type of markets.</li>
 <li><code>base</code> (<code>Optional[str]</code>): Base asset of markets.</li>
@@ -4719,6 +4720,7 @@ <h4 id="catalog_full_market_metrics_v2">catalog_full_market_metrics_v2<a class="
 <p><strong>Arguments</strong>:</p>
 <ul>
 <li><code>markets</code> (<code>Optional[Union[str, List[str]]]</code>): Comma separated list of markets. By default all markets are returned.</li>
+<li><code>metrics</code> (<code>Optional[Union[str, List[str]]]</code>): Comma separated list of metrics. By default all metrics are returned.</li>
 <li><code>exchange</code> (<code>Optional[str]</code>): Unique name of an exchange.</li>
 <li><code>market_type</code> (<code>Optional[str]</code>): Type of markets.</li>
 <li><code>base</code> (<code>Optional[str]</code>): Base asset of markets.</li>

docs/site/index.html

@@ -786,6 +786,11 @@ <h3 id="to-keep-in-mind-when-using-using-parallel-feature-or-generally-writing-h
 and <code>.export_to_json_files()</code>. Using the methods that return a single output - <code>.export_to_csv()</code>, <code>export_to_list()</code>, and
 <code>.export_to_dataframe()</code> need to join the data from many threads before it can be returned, this may use a lot of memory
 if you are accessing data types like market orderbooks or market trades and could fail altogether</li>
+<li>If using <code>export_to_csv/json_files()</code> functions, note that by default they will be saved in the directory format <code>/{endpoint}/{parallelize_on}</code>.
+For example, in <code>export_to_json_files()</code>, 
+<code>client.get_market_trades("coinbase-eth-btc-spot,coinbase-eth-usdc-spot").parallel("markets")</code> will create a file each like ./market-trades/coinbase-eth-btc-spot.json, ./market-trades/coinbase-eth-usdc-spot.json
+<code>client.get_asset_metrics('btc,eth', 'ReferenceRateUSD', start_time='2024-01-01', limit_per_asset=1).parallel("assets,metrics", time_increment=timedelta(days=1))</code>
+will create a file each like ./asset-metrics/btc/ReferenceRateUSD/start_time=2024-01-01T00-00-00Z.json, ./asset-metrics/eth/ReferenceRateUSD/start_time=2024-01-01T00-00-00Z.json</li>
 <li>If you get the error <code>BrokenProcessPool</code> it <a href="https://stackoverflow.com/questions/15900366/all-example-concurrent-futures-code-is-failing-with-brokenprocesspool">might be because you're missing a main() function</a></li>
 </ul>
 <h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h2>

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "coinmetrics-api-client"
-version = "2024.9.18.17"
+version = "2024.10.4.15"
 description = "Python client for Coin Metrics API v4."
 authors = ["Coin Metrics <[email protected]>", "Oleksandr Buchkovskyi <[email protected]>"]
 license = "MIT"