- Fixed the error where
_schema_constants.pymodule is not in the Python Client package.
- Fixed a bug where nullable columns for
blockchain-v2endpoints andtimeseries/market-tradeswere not returned when calling.to_dataframe().
- Added
.to_dataframe()forget_full_block_v2(),get_full_transaction_v2(), andget_full_transaction_for_block_v2(). - Added the API schema as part of the package build.
- Fixed a bug where nullable columns from
timeseries/*-metrics endpointsare sometimes not returned when calling.to_dataframe(). This happened when the first row's columns are not the same as any of the subsequent rows.
- Parallelization support to
get_predicted_funding_rates().
- Changed the default to format=json_stream for the following functions:
- All of
reference_data. - All of
catalog_*_v2. get_market_orderbooks,get_market_quotes,get_market_open_interest,get_market_trades,get_market_candles,get_asset_metrics
- All of
- Timezone normalization when using the parallel option with datetime.timedelta.
- Install CHANGELOG to correct location for documentation site.
- Fix broken image link in Best Practices user guide.
- Allow
optimize_pandas_typesargument as an alias foroptimize_dtypesinDataCollection.to_dataframe()calls but issue a deprecated warning. Prevents exception for code using the old name.
- Made Pandas and Polars mandatory packages.
get_network_profiles, missingformatparam toget_market_orderbooks,ignore_*_errorstoget_stream_asset_metrics,
- Enhanced documentation for API flows
- Polars dependency issues.
Note: This release may be unstable if you do not have polars installed. Please update to 2025.2.12.22 for a patched version.
- Added Polars dataframes and LazyFrames. They can be accessed using
DataCollection.to_dataframe(dataframe_type='polars')andDataCollection.to_lazyframe()respectively.
DataCollectionattributeoptimize_pandas_typeschanged tooptimize_dtypes.
- Type annotations in docstrings
- CHANGELOG.md
- pd.DateOffset as a valid data type for
time_incrementinparallel()
- Update pandas dependency to >= 2.0 and websocket-client >= 1.6.0
- Allowed pandas Timestamp data type to be passed in
clientAPI calls - Added "deprecated" flag to catalog v1 endpoints
- Catalog-v2/blockchain endpoints
- Removed unused columns for
reference_data_*().to_dataframe()return - Improved casting for return data types
- Upgraded the typer dependency to >= 0.6.1
- Set
format=json_streamforcatalogandreference_datafunctions by default, drastically improving speed
- Bug where requests have double '/' in URL
- Updated the request header to denote User-Agent as a Python API Client user
txidsas a validparallelize_onvariable
- Transformation logic for
catalog_*_v2().to_dataframe()that flattens these dataframes
- Type casting for
coin_metrics_idfield from pandas dataframes for very large integers
- Auto-retry logic for Websockets
- Redundant tests
- Bug on parallelization where
end_timeuses user's timezone instead of UTC
base_nativeandquote_nativefields toreference_data_markets()
- Removed JSON parsing on
on_errorforCmStreamdefault
- Atlas V1 (
get_blockchain_()) endpoints
- Warnings for upcoming
catalogdeprecation
txid,accounts,block_hashes,heights, andsub_accountsas validparallelvariablesheight_incrementas a validparallelparameter
- Temporary patch for returning all columns for
to_dataframe()call forreference_data_*andsecurity_master_*functions
- Allowed timezone aware datetimes to be passed to client API calls
- Functions
get_market_funding_rates_predicted,catalog_{full}_market_funding_rates_predicted_v2 - Generic examples for Python API Client functions
- Bug where
blockchain_metadatafunctions were not being called properly
blockchain_metadata_tags()andblockchain_metadata_tagged_entitiesfunctions
- Updated README to shorten example code and remove catalog v1
- Functions
get_snapshots_of_asset_metric_constituentsandget_timeframes_of_asset_metric_constituents
- Function
get_stream_market_open_interest
- Function
get_stream_market_liquidations
metricsparameter tocatalog_{full}_markets_v2catalog_index_levels_v2andreference_data_markets
- Parallelization support for
blockchainendpoints
- Replaced
frequencyparameter withgranularityforget_market_quotesandget_market_orderbooks
- Functions
reference_data_assets,reference_data_indexes,reference_data_pairs
- Functions
security_master_assets,security_master_markets
- Functions
catalog_{full}_pair_candles_v2,catalog_{full}_index_candles_v2,catalog_{full}_asset_chains_v2,catalog_{full}_mempool_feerates_v2,catalog_{full}_mining_pool_tips_summaries_v2,catalog_{full}_transaction_tracker_assets_v2
- Ability to parallelize API request for significantly improved data pull speed
- Functions
reference_data_asset_metrics,reference_data_institution_metrics
- Added
frequencyparameter toget_market_orderbooks(fixed in 2023.9.11.14)
- Functions
catalog_{full}_asset_metrics_v2,catalog_exchange_{full}_metrics_v2,catalog_{full}_exchange_asset_metrics_v2,catalog_{full}_pair_metrics_v2,catalog_{full}_institution_metrics_v2
on_closehandler toCmStream
- Functions
catalog_{full}_contract_prices_v2,catalog_{full}_market_trades_v2,catalog_{full}_market_candles_v2,catalog_{full}_market_orderbooks_v2,catalog_{full}_market_quotes_v2,catalog_{full}_market_funding_rates_v2,catalog_{full}_market_contract_prices_v2,catalog_{full}_market_implied_volatility_v2,catalog_{full}_market_greeks_v2,catalog_{full}_market_open_interest,catalog_{full}_market_liquidations_v2,catalog_{full}_market_metrics_v2.
- Market metrics catalog implementation to prevent duplicate rows
- Added test to verify one row per frequency
- Transaction tracker parameters
- Include heartbeats functionality
- Fixed catalog performance issues
- Walkthrough notebook for DS UA Workshop
- Rate limiter for community users
- Multithreading to CI pipeline
- Sample script for exporting atlas balance updates
- URL fixes
- Missing catalog endpoints
- Support for optional columns in API data
- New endpoint and tests
- Updated Dockerfile and dependencies
- Updated poetry lock file
- Bug fixes in examples
- Missing timeseries stream endpoints
- Missing functions and parameters
- Missing functions parameters
- Improved documentation for DataCollections usage
- Unauthorized error handling to FlatFilesExporter
- Updated CI pipeline
- Debug mode to help figure out performance issues
- Documentation updates for to_dataframe() method for catalog
- Automated testing code coverage
- Error handling for large requests (URI too long)
- Support for secondary_level parameter in to_dataframe()
- Support for index levels via WS in the client
- Modified API Client to use python requests.Session for improved performance
- Taxonomy endpoints
- Updated Atlas V2 balance endpoints
- Fixed broken examples using
typeparameter
- Updated build pipeline
- New catalog endpoints for metrics
- Automated version updates on release
- Documentation generation