CoinAPI November 2023 Update: Revamped Documentation
One of the biggest changes was an overhaul of the CoinAPI documentation.
We transitioned to a new documentation framework designed to make API references easier to navigate and keep technical information closer to the underlying API definitions.
Today, CoinAPI documentation includes product-specific REST API references, OpenAPI-based request and response examples, how-to guides, and API limits and billing documentation.
Enhanced Search
The updated documentation introduced improved search functionality, making it easier to locate product, endpoint, and integration information.
Improved Link Experience
We also improved deep links and section navigation.
This made it easier to share a specific API endpoint or documentation section without requiring another developer to manually find the relevant information.
Better Request and Response Presentation
The previous documentation was predominantly text-focused.
By moving closer to OpenAPI-based API definitions, request parameters, response structures, and endpoint information could be presented in a format that more closely reflected the actual API.
This reduced the gap between reading the documentation and implementing an integration.
Documentation Closer to the Implementation
The documentation is generated from API definitions and maintained closer to the implementation, helping keep request and response details up to date.
This approach also makes it easier to maintain consistency as APIs evolve.
Faster Documentation Experience
Performance was another part of the documentation update.
The new framework was designed to improve documentation loading and navigation, particularly when moving between API references and individual endpoints.
OpenAPI Publication
Another important part of the November 2023 update was the publication of CoinAPI's OpenAPI specification.
OpenAPI provides a machine-readable description of an API, including its endpoints, parameters, request structures, and responses.
For developers, this makes it easier to work with CoinAPI using API development tools, generate requests, and explore endpoint structures programmatically.
Import CoinAPI Into Postman
One practical use of the OpenAPI specification is importing CoinAPI into Postman.
Instead of manually configuring each endpoint, developers can use the OpenAPI specification to explore endpoints, generate requests, and test integrations more quickly.
For current instructions, see the CoinAPI documentation and current product-specific how-to guides.
Metrics API
The November 2023 release also introduced Metrics API, extending the types of standardized market information available through CoinAPI.
Since that original release, Metrics has evolved and is now part of the CoinAPI Market Data API.
Current Market Data REST documentation includes Metrics V1 and Metrics V2, with Metrics V2 preferred for new integrations.
What Data Is Available Through Market Metrics?
Market Metrics provides standardized analytics across supported resources and datasets.
Depending on the metric and available coverage, metrics can be associated with resources such as:
- Exchanges
- Assets
- Symbols
- Blockchains
- Stablecoins
CoinAPI provides endpoints for discovering available metrics, retrieving current metric values, and accessing historical metric series.
Examples of market information available through the current metrics framework can include derivatives-related metrics, liquidation-related metrics, mark price, implied volatility, and other exchange or symbol metrics, where supported.
The exact metrics available depend on the resource, exchange, symbol, and underlying data coverage.
Rather than relying on a fixed list in this archived article, developers should use the current Metrics listing and documentation to determine which metrics are available for their integration.
Metrics V1 and Metrics V2
The current Market Data API includes both Metrics V1 and Metrics V2 endpoint families.
For new integrations, Metrics V2 is preferred.
The Metrics endpoints can be used to:
- Discover supported metric identifiers
- Retrieve current metric values
- Query historical metric time series
- Identify metric coverage for supported resources
Metrics complement CoinAPI's core market datasets, including trades, quotes, order books, OHLCV, exchange rates, indexes, and metadata.
They provide additional standardized information that can be incorporated into trading models, quantitative research, monitoring systems, dashboards, and market analytics.
For current endpoints and available metrics, see the Market Data REST API documentation.
Getting Started With CoinAPI Today
The documentation and Metrics API described in this November 2023 update have continued to evolve.
Today, developers can create and manage API keys, monitor usage, manage billing and subscriptions, and access other account settings through the API BRICKS Console.
New CoinAPI users can also start with $25 in free credits to test supported REST and WebSocket workflows. A verified payment method and API key are required to unlock the credits.
For the latest information, use the current documentation rather than relying on endpoint paths, feature descriptions, or limits from this archived 2023 release.
