---

# Custom Integration

## Custom Data Integrations & Private Connectivity

FinFeedAPI and CoinAPI support custom data integrations for teams that need more than off-the-shelf APIs. We work with clients to integrate proprietary data sources, private exchange accounts, and non-standard market feeds directly into our infrastructure. This approach allows teams to use our existing ingestion, normalization, and delivery systems while maintaining control over access, security, and data scope.

## What Is a Custom Integration?

A custom integration is a **bespoke data connection** built specifically for your environment, data source, or workflow. Instead of adapting your systems to multiple third-party APIs, we adapt our infrastructure to your requirements.

Custom integrations can include:

* Private exchange APIs and authenticated market data feeds
* Proprietary datasets not available through public endpoints
* Non-standard formats or exchange-specific message structures
* Custom delivery methods aligned with internal systems

## Private Exchange Links

# Private Exchange Links



For clients working with **private exchange accounts**, market makers, or liquidity providers, we offer **secure private connectivity**.

Private Exchange Links allow you to:

* Connect authenticated exchange accounts to a **dedicated API instance**
* Access **private market data, balances, or execution data** where permitted
* Use the same schemas and access patterns as public APIs
* Keep credentials isolated and access tightly controlled

This is commonly used by **institutional trading firms, hedge funds, and infrastructure teams** that require direct exchange connectivity without exposing sensitive credentials.

## What Can Be Integrated

We support custom integration across multiple data categories, including:

* Crypto exchange market data (spot, futures, perpetuals)
* Stock and FX-related data feeds
* Prediction markets data sources
* Regulatory and disclosure datasets
* Internal or partner-provided financial data

Once integrated, data can be delivered through **REST APIs, WebSocket streams, JSON-RPC, or Flat Files**, depending on your use case.

## How Custom Integrations Work

### Scope definition
We start by talking through your requirements. This includes the data sources you want to integrate, how you currently access them, what level of detail you need, and how the data will be used in your systems. Together, we define the scope, access method, update frequency, and delivery format so the integration fits your workflow from day one.
— Scope definition
[Learn more](https://www.apibricks.io/blog/custom-data-integrations-and-private-connectivity)

### Secure connectivity setup
Once the scope is clear, we establish secure access to the data source. This can involve authenticated APIs, VPN connections, IP-restricted endpoints, or other private connectivity options. Credentials and access permissions are handled carefully to ensure isolation, security, and compliance with your internal policies.
— Secure connectivity setup
[Learn more](https://www.apibricks.io/blog/custom-data-integrations-and-private-connectivity)

### Normalization and validation
After connectivity is in place, we map the incoming data into consistent, well-defined schemas. This step removes format inconsistencies, validates fields, and aligns identifiers with existing CoinAPI or FinFeedAPI data models where applicable. The goal is to deliver data that is ready to use, not data that needs cleaning.
— Normalization and validation
[Learn more](https://www.apibricks.io/blog/custom-data-integrations-and-private-connectivity)

### Delivery and monitoring
The integrated data is then deployed into our production infrastructure and delivered through the agreed access method, such as REST APIs, WebSocket streams, JSON-RPC, or Flat Files. We monitor data flow, freshness, and reliability to ensure the integration performs as expected over time.
— Delivery and monitoring
[Learn more](https://www.apibricks.io/blog/custom-data-integrations-and-private-connectivity)

### Ongoing support and scaling
Custom integrations are not one-off projects. We handle ongoing maintenance, updates caused by upstream changes, and scaling as data volume or usage grows. This allows your team to focus on building products instead of maintaining fragile data pipelines.
— Ongoing support and scaling
[Learn more](https://www.apibricks.io/blog/custom-data-integrations-and-private-connectivity)

## Custom integrations are typically used by teams that:

### Need data not available via public APIs

You rely on datasets that aren’t exposed through standard endpoints, such as proprietary feeds, partner data, or restricted sources that require special access.

### Work with private or restricted exchange accounts

You access exchanges or venues through authenticated accounts, private APIs, or permissioned connections that can’t be shared publicly.

### Require custom schemas or delivery guarantees

You need data delivered in a specific structure, format, or cadence to match internal systems, contracts, or operational requirements.

### Want to reduce long-term maintenance of internal data pipelines

You prefer not to build and maintain fragile ingestion scripts, parsers, and connectors that break when upstream systems change.

### Operate institutional or production-grade systems

Your systems run in production environments where stability, security, monitoring, and predictable behavior matter more than quick prototypes.

## Frequently Asked Questions

### Why Build on API Bricks Infrastructure?
By building custom integrations on top of **API Bricks**, clients avoid reinventing core data infrastructure while still meeting unique requirements.

You get:

* Proven ingestion and delivery systems
* Consistent data models across products
* Secure, monitored production environments
* A single partner for public APIs and private data

### What is a custom data integration in financial APIs?
A custom data integration is a tailored connection between your data sources and an API platform. Instead of using only public endpoints, custom integrations allow proprietary datasets, private exchange feeds, or non-standard formats to be ingested, normalized, and delivered through a consistent API.

### Can you integrate private exchange accounts or authenticated APIs?
Yes. API Bricks supports **private exchange links** that securely connect authenticated exchange accounts or restricted APIs to a dedicated instance of our infrastructure. Credentials remain isolated, and access is controlled according to your requirements.

### What types of data can be integrated through custom solutions?
Custom integrations can include **crypto exchange data, stock and FX feeds, prediction markets data, regulatory datasets, and proprietary internal data sources**. Both public and private data feeds can be supported, depending on access permissions.

### How is custom-integrated data delivered?
Integrated data can be delivered through **REST APIs, WebSocket streams, FIX protocol, JSON-RPC interfaces, or Flat Files via S3-compatible storage**. Delivery methods are chosen based on how the data is consumed and operational constraints.

### Is custom-integrated data normalized like standard APIs?
Yes. Custom-integrated data is mapped into **the same standardized schemas** used across CoinAPI and FinFeedAPI wherever possible. This ensures consistent formats, identifiers, and access patterns across public and private datasets.

### How secure are private exchange integrations?
Private integrations are built with **credential isolation, restricted access scopes, and secure connectivity options** such as private endpoints or network-level controls. Sensitive credentials are never exposed through public APIs.

### Can custom integrations support high-volume or institutional workloads?
Yes. Custom integrations are built on the same **production-grade infrastructure** used by CoinAPI and FinFeedAPI, designed to handle high data volumes, sustained throughput, and enterprise-grade workloads.

### Do you support bespoke schemas or custom data formats?
Yes. When required, custom schemas or transformations can be implemented to match internal systems or legacy data models. This avoids forcing teams to redesign downstream systems to fit generic APIs.

### Who typically uses custom data integrations?
Custom integrations are commonly used by **institutional trading firms, hedge funds, fintech platforms, data teams, and infrastructure providers** that require access to private data or non-standard market feeds.

### How long does it take to build a custom integration?
Timelines depend on the data source, access method, and complexity of normalization. Simple integrations can be completed in 1 - 2 weeks, while more complex or multi-source setups require additional planning and validation.

### Can custom integrations coexist with standard APIs?
Yes. Many clients use **standard CoinAPI or FinFeedAPI endpoints alongside custom integrations**, all accessed through the same infrastructure and authentication model.

### Why choose API Bricks for custom data integration?
API Bricks combines **proven market data infrastructure** with the flexibility to support private and bespoke data sources. This allows teams to avoid building and maintaining fragile ingestion pipelines while still meeting unique data requirements.

### How do I start a custom integration?
You can start by **contacting the API Bricks team** to discuss your data sources, access requirements, and delivery preferences. From there, a scoped integration plan can be proposed.

## Need data that doesn’t fit a standard API?

Let’s design a custom integration that works with your systems.

[Contact us](https://www.apibricks.io/contact-us)

---

# CoinAPI

## All crypto APIs in one place

Access real-time and historical crypto trades, OHLCV, order books, exchange rates, indexes, and trading APIs across 400+ exchanges. Build, analyze, and trade using a single, consistent crypto market data platform.

- [Learn more](https://www.coinapi.io/?utm_source=apibricks.io&utm_medium=referral&utm_campaign=apibricks_coinapi_page)

- [Check Documentation](https://www.coinapi.io/docs)

## Discover Our Crypto APIs

### Market Data API

Get unified real-time and historical spot, futures, and perpetual crypto trades, OHLCV, and order book data from CEX and DEX through a single API.

### EMS Trading API

Execute, manage, and monitor orders across supported centralized exchanges. 
The API supports order placement, cancellation, and execution reporting via REST and FIX.

### Indexes API

Access CoinAPI’s VWAP, PRIMKT, and CAPIVIX indexes, providing aggregated price and volatility reference data with historical time series.

### Flat Files

Access bulk historical crypto trades, OHLCV, and order book datasets delivered as CSV files for large-scale analysis and offline processing.

### Exchange Rates API

Get standardized real-time and historical cryptocurrency exchange rates calculated from aggregated market data sources.

### Exchange Link

Connect private exchange accounts through a unified interface that abstracts exchange-specific private APIs.

## Key Features for your Application

### Unified Crypto Market Data API

Access cryptocurrency market data through a single API instead of integrating directly with individual exchanges.
All supported venues are exposed using consistent endpoints and schemas.

### Real-Time and Historical Data

Consume real-time market data streams and historical datasets using the same data models.
This enables consistent workflows for trading, backtesting, and research.

### Spot, Futures, and Perpetual Coverage

CoinAPI provides market data for spot markets as well as futures and perpetual derivatives.
Each instrument type is clearly identified and normalized across exchanges.

### Centralized and Decentralized Exchange Sources

Market data is collected from both centralized exchanges (CEX) and decentralized exchanges (DEX).
Data from different venue types is standardized into a common format.

### Normalized Symbols and Instruments

Exchange-specific symbols and instrument definitions are mapped to unified identifiers.
This allows reliable cross-exchange aggregation and comparison.

### Multiple Data Delivery Protocols

Market data is available via REST, WebSocket, and FIX depending on the use case.
This supports both request-based access and low-latency streaming consumption.

### Managed Data Environment

CoinAPI monitors and maintains exchange integrations, data ingestion, and normalization pipelines.
Customers consume processed market data without managing exchange connections or infrastructure.

### Uninterrupted Service

The platform is built on distributed infrastructure designed to handle exchange outages and regional disruptions.
Failover mechanisms help maintain continuous data availability.

### Tailored Data Solutions

CoinAPI supports custom data requests, including non-standard instruments and exchange-specific fields.
Solutions are adapted to meet specific trading, analytics, or research requirements.

### Bulk Historical Data Access

Historical trades, OHLCV, and selected order book data are available as downloadable flat files.
This supports large-scale analysis, audits, and offline processing.

## Why Developers Love Us?

Our API is built by developers, for developers. We give the right tools and resources to streamline your workflow and complete products faster and more efficiently.

## Request a Custom Enterprise Plan

---

# FinFeedAPI

## Financial data API for your application

FinFeedAPI provides APIs for historical stock market data, real-time and historical currency exchange rates, SEC filings, and prediction markets data. Developers access structured financial data through a single, consistent API designed for research, analytics, and data-driven applications, without complexity.

- [Learn more](https://www.finfeedapi.com/?utm_source=apibricks.io&utm_medium=referral&utm_campaign=apibricks_coinapi_page)

- [Check Documentation](https://www.finfeedapi.com/docs)

## Discover Our Finance APIs

### Stock API

Access T+1 historical stock market data delivered through a simple REST API. Data covers equities from 40+ global exchanges and is provided in a standardized, raw format.

### Currencies API

Retrieve real-time and historical currency exchange rates from both traditional FX markets and crypto markets. Data is available via REST, WebSocket, and FIX APIs.

### SEC API

Access structured SEC filing data through a dedicated REST API. The API delivers parsed filings and metadata, removing the need to handle raw documents or complex extraction logic.

### Flat Files S3 API

Download historical stock market datasets delivered as flat files via an S3-compatible interface for bulk data processing, offline analysis, and long-term storage workflows.

### Prediction Markets API

Access real-time prices, historical OHLCV, and order book data from prediction markets through a single REST API. Supported sources include Polymarket, Kalshi, Myriad, and Manifold.

## Key Features for your Application

### Historical Stock Prices

Access T+1 historical stock price data covering 11,000+ publicly listed companies.
Data is available with an unlimited historical lookback period.

### Real-Time and Historical Currency Prices

Retrieve real-time and historical exchange rates between fiat currencies and crypto assets.
Rates are accessible through a single request using standardized currency pairs.

### SEC filings

Access structured and parsed SEC filings through a dedicated API.
Coverage spans over 30 years of corporate disclosures, including filings metadata and content.

### Prediction Markets Data Access

Access prediction markets data including prices, OHLCV, and order books through a single API.
Supported platforms include Polymarket, Kalshi, Myriad, and Manifold.

### MCP Compatibility

FinFeedAPI supports integration with the Model Context Protocol (MCP) for AI-driven applications.
This allows structured financial data to be consumed directly by LLM-based systems.

### Multiple API Protocols

Data is delivered through REST, WebSocket, and FIX APIs depending on the dataset.
This supports both request-based access and streaming use cases.

### Custom Integrations

FinFeedAPI supports custom integration requirements across different architectures and data workflows.
This includes dataset adjustments and integration-level customization where needed.

### Standardized Financial Data Models

Stock, currency, and filings data are exposed using consistent schemas.
This reduces the need for custom parsing across different datasets.

### Bulk Historical Data via Flat Files

Large historical datasets are available as flat files through an S3-compatible interface.
This supports offline analysis, research workflows, and long-term storage.

### Managed Data Environment

FinFeedAPI manages data ingestion, processing, and delivery pipelines.
Customers consume ready-to-use data without maintaining source integrations.

## Why Developers Love Us?

Our API is built by developers, for developers. We give the right tools and resources to streamline your workflow and complete products faster and more efficiently.

## Request a Custom Enterprise Plan

---

# About us

## Data Infrastructure

Instead of integrating multiple data providers, clients use a single, consistent API ecosystem to access financial data across different asset classes. API Bricks products are used by fintech companies, trading platforms, analysts, and developers who rely on accurate financial data for applications, research, and decision-making.  Our goal is to make financial market data easier to access, easier to integrate, and easier to scale as data needs grow.

## Our story: From crypto data to a Unified Financial Platform

### 2017: The creation of CoinAPI

We started in 2017 with the launch of CoinAPI. At the time, cryptocurrency market data was fragmented, unreliable, and inconsistent across exchanges. CoinAPI was built to solve these issues by providing structured, normalized crypto market data with institution-grade quality, helping traders, fintech companies, and researchers work with digital asset data more reliably.

### Responding to a new demand: FinFeedAPI

After earning the trust of over 300 global clients with CoinAPI, we heard a consistent request: the same level of data quality and infrastructure reliability for traditional financial markets and new emerging prediction markets. To meet this need, we developed FinFeedAPI, applying our proven data aggregation model to equities and prediction markets.

### Today: The API Bricks ecosystem

API Bricks brings together our specialized data services under one company.
Through a single, consistent infrastructure, clients access normalized crypto market data via CoinAPI and regulated market data including stocks, FX, and prediction markets via FinFeedAPI.
This makes it easier to build hybrid portfolios, run cross-market analysis, and create new financial products that connect crypto and traditional markets.

## Global infrastructure

Speed and reliability guide how we design and operate our platform.

Our infrastructure runs across **AWS and Google Cloud regions worldwide**, with additional presence in **Equinix, Cyxtera, and CoreSite** data centers. This distributed setup supports low-latency data collection and delivery, with built-in redundancy across regions.

As a result, clients have stable access to financial market data across **North America, EMEA, and APAC**, supporting use cases in **crypto, stocks, FX, and prediction markets**.

- [Contact us](/contact-us)

---

# Customers

## Become Our Customer

API Bricks works with organizations and individuals who build, use, and analyze financial market data. We collaborate with banks, fintech companies, trading platforms, research teams, infrastructure providers, and startups.  If your work involves crypto, stocks, FX, or prediction markets data, there is likely an opportunity to work together.

- [Contact us](https://www.apibricks.io/contact-us)

## Reach Out to Us If…

### You need specific market data
* You’re looking for **crypto market data APIs** (spot, futures, or perpetuals)
* You need **historical stock market data** or **T+1 equities data**
* You work with **FX rates**, **currency exchange data**, or **crypto-to-fiat pricing**
* You need access to **SEC filings data** or **structured regulatory disclosures**
* You want **prediction markets data** from platforms like Kalshi or Polymarket

### You care about data quality and consistency
* You need **normalized financial data** across multiple sources
* You care about **clean schemas**, stable identifiers, and reproducible datasets
* You want the **same data models** for real-time and historical analysis
* You prefer working with **raw or minimally transformed data**, not black boxes

### You want to reduce integration and maintenance work
* You want **one API instead of many exchange or data provider integrations**
* You want to avoid maintaining **exchange-specific quirks and breaking changes**
* You’d rather consume **ready-to-use market data** than build ingestion pipelines
* You want to focus on **your product logic**, not data infrastructure

### You’re building or scaling a data-driven product
* You’re building a **trading platform, analytics tool, or research product**
* You’re integrating market data into **internal systems or client-facing apps**
* You need data that can **scale with usage, volume, and new markets**
* You want a provider that supports **custom data or integration requirements**

### You work with AI, analytics, or research workflows
* You’re feeding financial data into **AI or LLM-based applications**
* You need structured data compatible with **MCP or similar frameworks**
* You run **backtesting, modeling, or large-scale historical analysis**
* You care about **traceability and methodology**, not just raw numbers

**Products used:**

---

# News

## APIBrics News

Latest ApiBricks News!

## Blog Articles

### [Build vs Buy vs Custom Integration](/blog/build-vs-buy-vs-custom-integration)
Build, buy, or go custom? Learn how to choose the right financial data infrastructure based on cost, control, scalability, and technical requirements.

### [Currency Exchange Rates API: Real-Time and Historical EUR, GBP, and USD Rates](/blog/currency-exchange-rates-api-real-time-and-historical-eur-gbp-and-usd-rates)
Access real-time and historical currency exchange rates for EUR, GBP, USD, and more. Learn how FinFeedAPI supports currency conversion, financial reporting, and market analysis.

### [Financial Data API Architecture: How to Build a Multi-Asset Data Stack That Actually Scales](/blog/financial-data-api-architecture-how-to-build-a-multi-asset-data-stack)
Learn how to build a scalable financial data stack using APIs, streaming, Flat Files, normalized identifiers, and MCP across multiple asset classes.

### [REST, WebSocket, or Flat Files S3?](/blog/rest-websocket-or-flat-files-s3)
REST, WebSocket, and Flat Files solve different market data problems. Learn when to stream live data, query APIs, or use bulk historical files for backtesting, research, ML, and data lakes.

### [Why Most Financial Data APIs Break AI Agents](/blog/why-most-financial-data-apis-break-ai-agents)
AI agents can retrieve valid financial data and still get the answer wrong. Here’s what makes financial data reliable for AI.

### [How Do Subscriptions, Committed Plans, Usage Credits, Auto-Recharge, and Overages Work Together?](/blog/how-do-subscriptions-committed-plans-usage-credits-auto-recharge-and-overages-work-together)
Learn how API Bricks combines subscriptions, Usage Credits, committed plans, auto-recharge, and overage protection into one flexible billing model.

### [Building Better AI With CoinAPI and FinFeedAPI](/blog/building-better-ai-with-coinapi-and-finfeedapi)
Combine CoinAPI and FinFeedAPI data to give AI and ML models a richer view of market behavior, expectations, and the events driving them.

### [Prediction Market Data API Handbook: Tracking Polymarket, Kalshi, and Outcome Feeds](/blog/prediction-market-data-api-handbook)
Explore how a prediction market API simplifies data from Polymarket, Kalshi, and other outcome markets with normalized trades, quotes, OHLCV, and order books.

### [Alternative Data API: Use Cases, Integration & Provider Selection](/blog/alternative-data-api-use-cases-integration-and-provider-selection)
Discover how to use alternative data APIs for trading and research, from prediction markets and SEC filings to backtesting, integration, and provider selection.

### [Best Financial Data APIs for Developers: 2026 Comparison](/blog/best-financial-data-apis-for-developers-2026-comparison)
Compare the best financial data APIs for developers in 2026, including API BRICKS, Polygon, and Databento. Explore market coverage, pricing, latency, APIs, and multi-asset support.

### [The Problem FinFeedAPI Was Built to Solve](/blog/the-problem-finfeedapi-was-built-to-solve)
Modern financial applications need more than one API. Discover how FinFeedAPI unifies real-time and historical financial data through one developer-friendly platform.

### [The Hidden Cost of API Sprawl: 7 Problems That Only Appear at Scale](/blog/the-hidden-cost-of-api-sprawl-7-problems-that-only-appear-at-scale)
Modern applications rely on dozens of APIs, each with its own credentials, permissions, and operational workflows. This article explores the hidden costs of API sprawl and why managing APIs is just as important as integrating them.

### [The Problem CoinAPI Was Built to Solve](/blog/the-problem-coinapi-was-built-to-solve)
CoinAPI transforms fragmented cryptocurrency market data into a single, standardized platform. Explore how our data simplify development for modern trading and AI systems.

### [What's the Difference Between CoinAPI and FinFeedAPI?](/blog/what-s-the-difference-between-coinapi-and-finfeedapi)
Wondering what the difference is between CoinAPI and FinFeedAPI? Learn which platform is right for your project and how they work together to power modern financial applications.

### [From Order Flow to Outcome Markets: The Complete Hyperliquid Data Stack](/blog/from-order-flow-to-outcome-markets-the-complete-hyperliquid-data-stack)
Hyperliquid now spans both perpetual futures and outcome markets. Learn how ApiBricks combines CoinAPI and FinFeedAPI to deliver the complete Hyperliquid data stack.

### [The Data API Stack: Why APIs Alone Don't Solve Data Problems](/blog/the-data-api-stack-why-apis-alone-don-t-solve-data-problems)
A data API is only one layer of modern data architecture. Learn why data sources, normalization, validation, storage, and AI infrastructure matter just as much as API access.

### [Quant Research in 2026: Combining Traditional Infrastructure with Alternative Data APIs for Alpha Generation](/blog/quant-research-in-2026-combining-traditional-infrastructure-with-alternative-data-apis-for-alpha-generation)
Quant researchers are combining alternative data and institutional-grade market data to uncover new sources of alpha in increasingly efficient markets.

### [API Solutions for Data: When to Build, Buy, or Integrate](/blog/api-solutions-for-data-when-to-build-buy-or-integrate)
Not every data problem requires a custom pipeline. Explore when to build, buy, integrate, or combine APIs and how to avoid costly infrastructure mistakes

### [The 2026 Data Infrastructure Supercycle: What CTOs Need to Know](/blog/the-2026-data-infrastructure-supercycle-what-ctos-need-to-know)
Navigate the 2026 data supercycle. Power your platform with real-time feeds from CoinAPI and FinFeedAPI.

### [Hyperliquid Market Data Is Expanding Fast - Spot, Perpetuals and Now Outcome Markets](/blog/hyperliquid-market-data-is-expanding-fast-spot-perpetuals-and-now-outcome-markets)
Access Hyperliquid spot, perpetual, and HIP-4 outcome market data with CoinAPI and FinFeedAPI APIs.

### [Prediction Market API: One Data Layer for the Future of Event Markets](/blog/prediction-market-api-one-data-layer-for-the-future-of-event-markets)
Explore API Bricks’ Prediction Market API by FinFeedAPI. Access market metadata, trades, quotes, OHLCV, order books, and historical prediction market data.

### [The Cost of Maintaining Your Own Market Data Infrastructure](/blog/the-cost-of-maintaining-your-own-market-data-infrastructure)
Stop building "digital plumbing" and start building your product. Maintaining market data infrastructure is a hidden cost trap - buy the signal so you can focus on the growth.

### [Best Ethereum APIs (Quick Overview for Developers)](/blog/best-ethereum-apis-quick-overview-for-developers)
Ethereum is now multi-chain, and developers need multiple APIs to track wallets, tokens, and activity. This guide highlights key Ethereum APIs and how CoinAPI adds the market data layer.

### [What Makes a Financial Data API Reliable?  ](/blog/what-makes-a-financial-data-api-reliable)
A reliable financial API goes beyond uptime... it delivers accurate data, strong validation, and dependable performance when it matters most.

### [Combining Market Data and Alternative Data in One API](/blog/combining-market-data-and-alternative-data-in-one-api)
Combine CoinAPI’s market data with FinFeedAPI’s stock, SEC, and alternative data to access price, fundamentals, and market expectations in one unified API.

### [Security and Compliance Are Foundations of API BRICKS Infrastructure](/blog/security-and-compliance-are-foundations-of-api-bricks-infrastructure)
Learn how API BRICKS builds security into our products: TLS 1.2+ encryption, key management with cloud KMS, layered authentication, RBAC, immutable audit trails, and enterprise-grade access controls.

### [MCP API Upgrade: Built for AI Agents Across CoinAPI and FinFeedAPI](/blog/mcp-api-upgrade-built-for-ai-agents-across-coinapi-and-finfeedapi)
APIs are evolving and so is MCP. With a full redesign for AI agents, CoinAPI and FinFeedAPI now offer faster, cleaner, and more reliable data access, alongside a critical migration away from SSE.

### [The Hidden Layer of Crypto Trading: Data APIs](/blog/the-hidden-layer-of-crypto-trading-data-apis)
Crypto trading runs on strategies but it depends on data APIs to make those strategies possible. The real edge comes from how well your systems see and structure the market before a single trade is executed.

### [Why Machine-Readable Data Is the Real Asset](/blog/why-machine-readable-data-is-the-real-asset)
Machine-readable financial data is what turns raw information into real value. When data is structured from the start, systems can move faster, scale easier, and focus on decisions instead of cleanup.

### [From Raw Feeds to Structured Intelligence: The Data Transformation Layer](/blog/the-data-transformation-layer)
Learn what a financial data transformation layer does, why raw feeds break at scale, and how structured APIs help teams build reliable products faster.

### [Why Do Modern Trading Platforms Rely on Financial APIs?](/blog/why-do-modern-trading-platforms-rely-on-financial-apis)
Financial APIs power modern trading platforms by delivering real-time market data, historical datasets, and structured financial information through a single integration layer.

### [What Counts as Alternative Data in 2026? Top 10 Alternative Data API Providers](/blog/what-counts-as-alternative-data-in-2026-top-10-alternative-data-api-providers)
Top 10 Alternative Data API Providers which help teams detect business momentum before it appears in financial reports.

### [What Is a Data API? (And Why Every Fintech Depends on One)](/blog/what-is-a-data-api)
A data API turns raw financial data into structured, machine-readable input and without a reliable financial data API, no modern fintech product can scale.

### [Custom Data Integrations and Private Connectivity](/blog/custom-data-integrations-and-private-connectivity)
Financial and trading teams increasingly rely on data that cannot be accessed through public APIs alone.

### [Financial Data for AI: What LLMs Actually Need](/blog/financial-data-for-ai-what-llms-actually-need)
LLMs need structured, consistent, and precisely timestamped financial data - because broken data breaks AI reasoning.

### [How to Choose the Right Financial Data API](/blog/how-to-choose-the-right-financial-data-api)
The right financial data API goes beyond market data, covering exchange rates, SEC and EDGAR data, currencies, and prediction market data in a structured, reliable way.

### [How One API Can Power Multiple Financial Products](/blog/how-one-api-can-power-multiple-financial-products)
One unified financial data API can power apps, research, reporting, and AI workflows because the same structured data works across various products.

### [The Hidden Cost of Maintaining Your Own Market Data Pipeline](/blog/the-hidden-cost-of-maintaining-your-own-market-data-pipeline)
A “simple” market data pipeline quickly turns into full-time infrastructure work: time bugs, schema drift, backfills and nonstop maintenance.

### [How Developers Use Financial APIs in Real Products](/blog/how-developers-use-financial-apis-in-real-products)
Developers actually use financial APIs in real products - trading apps, dashboards, alerts, analytics systems and AI tools.

### [Financial Data vs Market Data: What’s the Difference?](/blog/financial-data-vs-market-data-what-s-the-difference)
Modern APIs unify both financial data and market data under one structured interface. What is the difference?

### [Why Machine-Readable Financial Data Matters](/blog/why-machine-readable-financial-data-matters)
AI doesn’t run on 'information',  AI runs on structured financial data it can trust. That’s why machine-readable financial data matters right now.

### [What Is a Financial Data API?](/blog/what-is-a-financial-data-api)
Financial data powers almost everything today. This guide explains what a financial data API is, how a market data API works.

### [Stock API Announces Major Global Expansion with Six New Exchanges](/blog/stock-api-six-new-exchanges)
FinFeedAPI is excited to announce a significant expansion of Stock API market data with the addition of six new stock exchanges from across Europe, Africa, and Asia. 

### [FinFeedAPI announces Flat Files S3 API](/blog/announcing-flat-files-s3-api)
Streamline your research with the Flat Files S3 API direct, bulk access to our historical data using any S3-compatible tool.

### [OHLCV Data Now Available in CoinAPI Flat Files](/blog/ohlcv-data-coinapi-flat-files-crypto-data-download)
CoinAPI Flat Files offer bulk crypto OHLCV data normalized, UTC-aligned, and ready for backtesting or compliance.

### [Introducing the Model Context Protocol MCP: The Future of AI API Integration in Crypto & TradFi](/blog/introducing-the-model-context-protocol-mcp-the-future-of-ai-api-integration-in-crypto-and-tradfi)
Accelerate AI integration with CoinAPI MCP. Use machine-readable endpoints to automate and scale your workflows across CoinAPI and FinFeedAPI.

---

# Blog

Latest articles from APIBricks.

## [Build vs Buy vs Custom Integration](/blog/build-vs-buy-vs-custom-integration)

Build, buy, or go custom? Learn how to choose the right financial data infrastructure based on cost, control, scalability, and technical requirements.

## [Currency Exchange Rates API: Real-Time and Historical EUR, GBP, and USD Rates](/blog/currency-exchange-rates-api-real-time-and-historical-eur-gbp-and-usd-rates)

Access real-time and historical currency exchange rates for EUR, GBP, USD, and more. Learn how FinFeedAPI supports currency conversion, financial reporting, and market analysis.

## [Financial Data API Architecture: How to Build a Multi-Asset Data Stack That Actually Scales](/blog/financial-data-api-architecture-how-to-build-a-multi-asset-data-stack)

Learn how to build a scalable financial data stack using APIs, streaming, Flat Files, normalized identifiers, and MCP across multiple asset classes.

## [REST, WebSocket, or Flat Files S3?](/blog/rest-websocket-or-flat-files-s3)

REST, WebSocket, and Flat Files solve different market data problems. Learn when to stream live data, query APIs, or use bulk historical files for backtesting, research, ML, and data lakes.

## [Why Most Financial Data APIs Break AI Agents](/blog/why-most-financial-data-apis-break-ai-agents)

AI agents can retrieve valid financial data and still get the answer wrong. Here’s what makes financial data reliable for AI.

## [How Do Subscriptions, Committed Plans, Usage Credits, Auto-Recharge, and Overages Work Together?](/blog/how-do-subscriptions-committed-plans-usage-credits-auto-recharge-and-overages-work-together)

Learn how API Bricks combines subscriptions, Usage Credits, committed plans, auto-recharge, and overage protection into one flexible billing model.

## [Building Better AI With CoinAPI and FinFeedAPI](/blog/building-better-ai-with-coinapi-and-finfeedapi)

Combine CoinAPI and FinFeedAPI data to give AI and ML models a richer view of market behavior, expectations, and the events driving them.

## [Prediction Market Data API Handbook: Tracking Polymarket, Kalshi, and Outcome Feeds](/blog/prediction-market-data-api-handbook)

Explore how a prediction market API simplifies data from Polymarket, Kalshi, and other outcome markets with normalized trades, quotes, OHLCV, and order books.

## [Alternative Data API: Use Cases, Integration & Provider Selection](/blog/alternative-data-api-use-cases-integration-and-provider-selection)

Discover how to use alternative data APIs for trading and research, from prediction markets and SEC filings to backtesting, integration, and provider selection.

## [Best Financial Data APIs for Developers: 2026 Comparison](/blog/best-financial-data-apis-for-developers-2026-comparison)

Compare the best financial data APIs for developers in 2026, including API BRICKS, Polygon, and Databento. Explore market coverage, pricing, latency, APIs, and multi-asset support.

## [The Problem FinFeedAPI Was Built to Solve](/blog/the-problem-finfeedapi-was-built-to-solve)

Modern financial applications need more than one API. Discover how FinFeedAPI unifies real-time and historical financial data through one developer-friendly platform.

## [The Hidden Cost of API Sprawl: 7 Problems That Only Appear at Scale](/blog/the-hidden-cost-of-api-sprawl-7-problems-that-only-appear-at-scale)

Modern applications rely on dozens of APIs, each with its own credentials, permissions, and operational workflows. This article explores the hidden costs of API sprawl and why managing APIs is just as important as integrating them.

## [The Problem CoinAPI Was Built to Solve](/blog/the-problem-coinapi-was-built-to-solve)

CoinAPI transforms fragmented cryptocurrency market data into a single, standardized platform. Explore how our data simplify development for modern trading and AI systems.

## [What's the Difference Between CoinAPI and FinFeedAPI?](/blog/what-s-the-difference-between-coinapi-and-finfeedapi)

Wondering what the difference is between CoinAPI and FinFeedAPI? Learn which platform is right for your project and how they work together to power modern financial applications.

## [From Order Flow to Outcome Markets: The Complete Hyperliquid Data Stack](/blog/from-order-flow-to-outcome-markets-the-complete-hyperliquid-data-stack)

Hyperliquid now spans both perpetual futures and outcome markets. Learn how ApiBricks combines CoinAPI and FinFeedAPI to deliver the complete Hyperliquid data stack.

## [The Data API Stack: Why APIs Alone Don't Solve Data Problems](/blog/the-data-api-stack-why-apis-alone-don-t-solve-data-problems)

A data API is only one layer of modern data architecture. Learn why data sources, normalization, validation, storage, and AI infrastructure matter just as much as API access.

## [Quant Research in 2026: Combining Traditional Infrastructure with Alternative Data APIs for Alpha Generation](/blog/quant-research-in-2026-combining-traditional-infrastructure-with-alternative-data-apis-for-alpha-generation)

Quant researchers are combining alternative data and institutional-grade market data to uncover new sources of alpha in increasingly efficient markets.

## [API Solutions for Data: When to Build, Buy, or Integrate](/blog/api-solutions-for-data-when-to-build-buy-or-integrate)

Not every data problem requires a custom pipeline. Explore when to build, buy, integrate, or combine APIs and how to avoid costly infrastructure mistakes

## [The 2026 Data Infrastructure Supercycle: What CTOs Need to Know](/blog/the-2026-data-infrastructure-supercycle-what-ctos-need-to-know)

Navigate the 2026 data supercycle. Power your platform with real-time feeds from CoinAPI and FinFeedAPI.

## [Hyperliquid Market Data Is Expanding Fast - Spot, Perpetuals and Now Outcome Markets](/blog/hyperliquid-market-data-is-expanding-fast-spot-perpetuals-and-now-outcome-markets)

Access Hyperliquid spot, perpetual, and HIP-4 outcome market data with CoinAPI and FinFeedAPI APIs.

## [Prediction Market API: One Data Layer for the Future of Event Markets](/blog/prediction-market-api-one-data-layer-for-the-future-of-event-markets)

Explore API Bricks’ Prediction Market API by FinFeedAPI. Access market metadata, trades, quotes, OHLCV, order books, and historical prediction market data.

## [The Cost of Maintaining Your Own Market Data Infrastructure](/blog/the-cost-of-maintaining-your-own-market-data-infrastructure)

Stop building "digital plumbing" and start building your product. Maintaining market data infrastructure is a hidden cost trap - buy the signal so you can focus on the growth.

## [Best Ethereum APIs (Quick Overview for Developers)](/blog/best-ethereum-apis-quick-overview-for-developers)

Ethereum is now multi-chain, and developers need multiple APIs to track wallets, tokens, and activity. This guide highlights key Ethereum APIs and how CoinAPI adds the market data layer.

## [What Makes a Financial Data API Reliable?  ](/blog/what-makes-a-financial-data-api-reliable)

A reliable financial API goes beyond uptime... it delivers accurate data, strong validation, and dependable performance when it matters most.

## [Combining Market Data and Alternative Data in One API](/blog/combining-market-data-and-alternative-data-in-one-api)

Combine CoinAPI’s market data with FinFeedAPI’s stock, SEC, and alternative data to access price, fundamentals, and market expectations in one unified API.

## [Security and Compliance Are Foundations of API BRICKS Infrastructure](/blog/security-and-compliance-are-foundations-of-api-bricks-infrastructure)

Learn how API BRICKS builds security into our products: TLS 1.2+ encryption, key management with cloud KMS, layered authentication, RBAC, immutable audit trails, and enterprise-grade access controls.

## [MCP API Upgrade: Built for AI Agents Across CoinAPI and FinFeedAPI](/blog/mcp-api-upgrade-built-for-ai-agents-across-coinapi-and-finfeedapi)

APIs are evolving and so is MCP. With a full redesign for AI agents, CoinAPI and FinFeedAPI now offer faster, cleaner, and more reliable data access, alongside a critical migration away from SSE.

## [The Hidden Layer of Crypto Trading: Data APIs](/blog/the-hidden-layer-of-crypto-trading-data-apis)

Crypto trading runs on strategies but it depends on data APIs to make those strategies possible. The real edge comes from how well your systems see and structure the market before a single trade is executed.

## [Why Machine-Readable Data Is the Real Asset](/blog/why-machine-readable-data-is-the-real-asset)

Machine-readable financial data is what turns raw information into real value. When data is structured from the start, systems can move faster, scale easier, and focus on decisions instead of cleanup.

## [From Raw Feeds to Structured Intelligence: The Data Transformation Layer](/blog/the-data-transformation-layer)

Learn what a financial data transformation layer does, why raw feeds break at scale, and how structured APIs help teams build reliable products faster.

## [Why Do Modern Trading Platforms Rely on Financial APIs?](/blog/why-do-modern-trading-platforms-rely-on-financial-apis)

Financial APIs power modern trading platforms by delivering real-time market data, historical datasets, and structured financial information through a single integration layer.

## [What Counts as Alternative Data in 2026? Top 10 Alternative Data API Providers](/blog/what-counts-as-alternative-data-in-2026-top-10-alternative-data-api-providers)

Top 10 Alternative Data API Providers which help teams detect business momentum before it appears in financial reports.

## [What Is a Data API? (And Why Every Fintech Depends on One)](/blog/what-is-a-data-api)

A data API turns raw financial data into structured, machine-readable input and without a reliable financial data API, no modern fintech product can scale.

## [Custom Data Integrations and Private Connectivity](/blog/custom-data-integrations-and-private-connectivity)

Financial and trading teams increasingly rely on data that cannot be accessed through public APIs alone.

## [Financial Data for AI: What LLMs Actually Need](/blog/financial-data-for-ai-what-llms-actually-need)

LLMs need structured, consistent, and precisely timestamped financial data - because broken data breaks AI reasoning.

## [How to Choose the Right Financial Data API](/blog/how-to-choose-the-right-financial-data-api)

The right financial data API goes beyond market data, covering exchange rates, SEC and EDGAR data, currencies, and prediction market data in a structured, reliable way.

## [How One API Can Power Multiple Financial Products](/blog/how-one-api-can-power-multiple-financial-products)

One unified financial data API can power apps, research, reporting, and AI workflows because the same structured data works across various products.

## [The Hidden Cost of Maintaining Your Own Market Data Pipeline](/blog/the-hidden-cost-of-maintaining-your-own-market-data-pipeline)

A “simple” market data pipeline quickly turns into full-time infrastructure work: time bugs, schema drift, backfills and nonstop maintenance.

## [How Developers Use Financial APIs in Real Products](/blog/how-developers-use-financial-apis-in-real-products)

Developers actually use financial APIs in real products - trading apps, dashboards, alerts, analytics systems and AI tools.

## [Financial Data vs Market Data: What’s the Difference?](/blog/financial-data-vs-market-data-what-s-the-difference)

Modern APIs unify both financial data and market data under one structured interface. What is the difference?

## [Why Machine-Readable Financial Data Matters](/blog/why-machine-readable-financial-data-matters)

AI doesn’t run on 'information',  AI runs on structured financial data it can trust. That’s why machine-readable financial data matters right now.

## [What Is a Financial Data API?](/blog/what-is-a-financial-data-api)

Financial data powers almost everything today. This guide explains what a financial data API is, how a market data API works.

## [Stock API Announces Major Global Expansion with Six New Exchanges](/blog/stock-api-six-new-exchanges)

FinFeedAPI is excited to announce a significant expansion of Stock API market data with the addition of six new stock exchanges from across Europe, Africa, and Asia. 

## [FinFeedAPI announces Flat Files S3 API](/blog/announcing-flat-files-s3-api)

Streamline your research with the Flat Files S3 API direct, bulk access to our historical data using any S3-compatible tool.

## [OHLCV Data Now Available in CoinAPI Flat Files](/blog/ohlcv-data-coinapi-flat-files-crypto-data-download)

CoinAPI Flat Files offer bulk crypto OHLCV data normalized, UTC-aligned, and ready for backtesting or compliance.

## [Introducing the Model Context Protocol MCP: The Future of AI API Integration in Crypto & TradFi](/blog/introducing-the-model-context-protocol-mcp-the-future-of-ai-api-integration-in-crypto-and-tradfi)

Accelerate AI integration with CoinAPI MCP. Use machine-readable endpoints to automate and scale your workflows across CoinAPI and FinFeedAPI.

---

# Referral program

## Referral Program Agreement

This Referral Program Agreement ("**Agreement**") is a legal agreement between you ("**Referrer**", "**you**" or "**your**") and API BRICKS LTD F/K/A COINAPI LTD UTR 8050945 ("**Company**", "**we**", "**our**" or "**us**"), a United Kingdom company (together, the "**parties**" and each a "**party**").

This Agreement governs participation in the Company's Referral Program ("**Program**") for API Bricks, CoinAPI, FinFeedAPI, and their associated products and services ("**Services**"). If you participate on behalf of an organization, you represent that you are authorized to bind that organization to this Agreement.

By accessing, using, or distributing referral links or codes, enabling referral attribution through API requests, or receiving referral compensation, you agree to be bound by this Agreement and the Company's applicable Customer Agreement.

### 1. Program Eligibility and Participation

**1.1. Eligibility.** The Program is available to organizations registered with the Company through the API Bricks platform. Participation requires an active organization account and compliance with this Agreement and the applicable Customer Agreement.

**1.2. Referral Identification.** Each participating organization may use its unique organization identifier or a custom referral code. Custom codes must contain between 8 and 32 lowercase letters (a–z) and may be configured only once.

**1.3. Eligible Referrals.** A referral qualifies for compensation only when a separate organization is successfully attributed to the Referrer under the conditions specified in this Agreement.

**1.4. Self-Referrals.** Referrals involving the Referrer's own organization are not eligible for compensation. The Company will not pay referral commissions where the referring and referred organization are the same.

### 2. Referral Attribution

**2.1. Referral Methods.** The Program supports two attribution methods: referral links and API request attribution. Referrals are recorded and evaluated using the Company's internal attribution systems.

**2.2. Referral Links.** Referrers may distribute links containing their organization identifier or custom referral code through the `ref` query parameter. Such links may direct users to any page on the Company's supported websites, including www.apibricks.io, www.coinapi.io, and www.finfeedapi.com.

**2.3. Link Attribution.** A referral link visit is recorded when the link is opened. A subsequently created organization may be attributed to the Referrer when the Company's systems identify a qualifying connection between the recorded visit and the organization's creation. Attribution is determined using available device identification information or, where applicable, IP address information. The referred organization must be created after the qualifying referral visit.

**2.4. API Request Attribution.** Referrals may also be attributed through API requests containing the Referrer's organization identifier or custom referral code in the `X-Referrer` header. The alternative `X-Referer` header is accepted when `X-Referrer` is absent. If neither custom header is present, the standard `Referer` header may be used.

**2.5. Attribution Priority.** Where multiple referral signals exist for the same organization, the Company's attribution system determines the applicable referral record. A qualifying link-based attribution takes precedence over a weaker usage-based attribution for the same organization and reporting month.

**2.6. Usage Qualification.** API usage attribution qualifies for compensation only when the Referrer's identifier or code appears on **more than 51% of the referred organization's successful API requests** during the applicable calendar month. Exactly 51% does not qualify.

For this purpose, a successful API request means an HTTP 200 response or a successfully completed WebSocket upgrade returning HTTP 101. Usage percentages are calculated against all successful requests made by the referred organization during the applicable month.

**2.7. Non-Qualifying Attribution.** Referral signals that do not satisfy the applicable qualification requirements may be recorded for reporting purposes but shall not generate compensation.

### 3. Referral Commissions

**3.1. Commission Rate.** Subject to the eligibility and attribution requirements of this Agreement, the Referrer is entitled to a commission equal to **10% of collected subscription revenue** attributable to qualifying referred organizations.

**3.2. Eligible Products.** The standard Program applies to subscription revenue collected from all eligible products and Services offered by API Bricks, CoinAPI, and FinFeedAPI.

**3.3. Link Attribution Period.** Commission eligibility arising from a qualifying referral link remains in effect for **10 months from the referred organization's first paid subscription**. No further link-based commission accrues after this period unless another valid attribution method independently qualifies under this Agreement.

**3.4. Usage Attribution Period.** API usage-based commissions are assessed independently for each calendar month. Compensation is earned only for months in which the Referrer satisfies the usage qualification threshold specified in Section 2.6.

**3.5. Commission Calculation.** Commissions are calculated on subscription revenue actually collected by the Company from qualifying referred organizations. Referral link visits, account registrations, unsuccessful API requests, and unpaid subscription charges do not independently create an entitlement to compensation.

**3.6. No Guaranteed Earnings.** Participation in the Program does not guarantee any minimum number of referrals, subscription purchases, revenue, or commission payments.

### 4. Reporting, Payment and Payout Methods

**4.1. Reporting Period.** Referral commissions are calculated and reported on a monthly basis using Coordinated Universal Time (UTC). The Company shall make the applicable monthly referral report available within **15 days following the end of the reporting month**.

**4.2. Payment Schedule.** Payment of qualifying commissions shall follow within **15 days after the applicable monthly report** has been issued, subject to successful payout processing and compliance with this Agreement.

**4.3. Available Payment Methods.** Referrers may select one of the following payment methods through the API Bricks console:

(a) **Organization Balance.** Earned commissions are credited to the Referrer's organization balance and applied toward future invoices issued by the Company.

(b) **Stripe Connect.** Earned commissions are paid in cash through Stripe Connect, subject to successful account onboarding and applicable Stripe requirements.

**4.4. Stripe Connect Eligibility.** Stripe Connect onboarding is available only after the Referrer has referred at least one organization other than its own. A Stripe account is considered connected only after Stripe successfully completes the onboarding process.

**4.5. Changes to Payment Method.** Referrers may change their selected payment method through the console. Where a Referrer switches from Stripe Connect to Organization Balance, the previously connected Stripe account may be retained for up to 90 days before removal.

**4.6. Payment Processing.** Cash payouts are subject to the availability and operational requirements of Stripe Connect. The Company is not responsible for restrictions, verification requirements, or processing failures imposed by Stripe or applicable financial institutions.

### 5. Referral Records and Verification

**5.1. Referral Statistics.** The Company provides referral reporting through the API Bricks console, including recorded link visits, associated devices and IP addresses, referred organizations, paying organizations, and collected revenue.

**5.2. Referral Ledger.** The referral ledger records attributed organizations, reporting months, attribution sources, qualification statuses, applicable usage percentages, eligible revenue, and calculated commissions.

**5.3. Attribution Records.** The Company's systems record referral activity and evaluate attribution according to the technical rules applicable at the time of processing. API usage attribution is recalculated periodically for the current and preceding UTC reporting month.

**5.4. Non-Qualifying Records.** Referral records may be classified as non-qualifying due to insufficient API usage, self-referral, or failure to satisfy applicable eligibility conditions. Such records do not create an entitlement to commission payments.

**5.5. Verification.** The Company may review referral records and payment calculations to verify compliance with this Agreement. Referral compensation is subject to the qualification rules and recorded subscription revenue maintained by the Company.

### 6. Restrictions and General Conditions

**6.1. Compliance.** Referrers must comply with applicable laws, regulations, the Company's Customer Agreement, and any relevant third-party platform requirements when distributing referral links or codes.

**6.2. Misuse.** Referrers must not engage in fraudulent, deceptive, or misleading referral activity, including manipulation of referral identifiers, artificial API traffic, or attempts to obtain compensation for ineligible organizations.

**6.3. Suspension or Disqualification.** The Company may suspend Program participation, withhold disputed commissions, or disqualify referrals where there is reasonable evidence of fraud, misuse, or violation of this Agreement.

**6.4. Independent Relationship.** Participation in the Program does not establish an employment, agency, partnership, joint venture, or exclusive commercial relationship between the Referrer and the Company. Referrers have no authority to bind the Company or make commitments on its behalf.

**6.5. Taxes.** Referrers are responsible for determining and fulfilling any tax reporting or payment obligations arising from referral compensation, except where applicable law requires the Company to withhold or remit taxes.

**6.6. Program Changes.** The Company may amend, suspend, or discontinue the Program, subject to applicable law and any notice requirements under the Company's Customer Agreement. Changes shall not retroactively eliminate commissions already earned under the terms applicable at the time of qualification, except where required by law or where such commissions arose from fraud or material non-compliance.

**6.7. Governing Terms.** This Agreement supplements the Company's Customer Agreement. In the event of a conflict concerning referral attribution, commission calculation, or payout conditions, this Agreement shall prevail solely with respect to the Referral Program. All other matters remain subject to the applicable Customer Agreement.

---

_Referral Program_

# Referral Program

Earn rewards by introducing new customers to API Bricks, CoinAPI, and FinFeedAPI.

Share the market data tools you trust and earn a percentage of subscription revenue from customers you refer.

The API Bricks Referral Program rewards individuals, developers, and organizations that introduce new customers to our products. You can refer customers through a simple referral link or by including your referral code in API requests.

- [Contact us](/contact-us)
- [Read more](/referral-program)

Standard reward: 10% of collected subscription revenue. Custom terms are available.

- **10%** — of collected subscription revenue
- **10 months** — from the first paid subscription
- **15 days** — to report, then 15 days to pay

_How it works_

## How the Referral Program Works

There are two ways to refer customers. Both let you earn from customers using eligible products across API Bricks, CoinAPI, and FinFeedAPI.

### 1. Share your referral link

Generate a unique referral link from the Referrals section of your API Bricks console. You can share links to API Bricks, CoinAPI, or FinFeedAPI, including specific product pages.

When someone visits your link and later creates an organization, the referral can be attributed to you.

### 2. Use API referral attribution

Developers and integration partners can include a referral code in API requests using the X-Referrer header.

When your referral code appears on more than 51% of an organization's successful API requests in a calendar month, that organization qualifies for usage-based referral attribution for that month.

_Rewards_

## Referral Rewards and Commission

Our standard referral program offers 10% of collected subscription revenue from qualifying referred customers.

| Feature | Referral Program Terms |
| --- | --- |
| Commission | 10% of collected subscription revenue |
| Eligible products | All products |
| Link referral duration | 10 months from the first paid subscription |
| API usage qualification | More than 51% of successful API requests in a month |
| Reporting | Within 15 days after the end of each month |
| Payment | Within 15 days after the monthly report |
| Payment methods | Organization balance or Stripe Connect |

Link-based referrals can generate commission for up to 10 months starting with the customer's first paid subscription. Usage-based referrals qualify on a monthly basis, provided the required API request threshold is met. Commissions are calculated from collected subscription revenue, not simply from visits, account registrations, or API request volume. Referrals to your own organization are not eligible.

_Get started_

## How to Get Started

Getting started takes just a few steps.

### 1. Access your console

Sign in to API Bricks and open the Referrals section.

[Open the API Bricks console](https://console.apibricks.io/)

### 2. Get your referral code

Use your organization ID or create a custom referral code containing 8–32 lowercase letters. A custom code can be set only once.

### 3. Share or integrate

Distribute referral links to our websites or include your code in supported API requests.

[Referral documentation](/platform/docs/general/referral)

### 4. Track your referrals

Monitor link visits, referred organizations, qualifying revenue, and earned commissions.

### 5. Receive your rewards

Choose between credits toward future invoices or cash payouts through Stripe Connect.

_Examples_

## Share a link or send a header

You can share a referral link to any page on our supported websites by adding the ref parameter.

For API-based referrals, include your code in the X-Referrer header. The alternative X-Referer header is also supported.

**referral**

```
https://www.apibricks.io/?ref=your-ref-code

X-Referrer: your-ref-code
```

_Tracking_

## Tracking Your Referrals and Earnings

Your API Bricks console provides visibility into referral activity and commissions through three dedicated views. Referral activity that does not meet the qualification threshold may still appear in your ledger but does not generate commission.

### Setup and Stats

Access your referral links and code, review program terms, and monitor referral performance, including visits, unique devices, IP addresses, registrations, paying organizations, and collected revenue.

### Referral Ledger

View referred organizations, attribution sources, monthly qualification status, applicable API usage percentages, revenue, and earned commission.

### Payouts

Manage your preferred payment method, review your available referral balance, and access payout history.

_Payouts_

## Referral Payout Options

You can choose how to receive your referral earnings. You can switch between the available payment methods in the console. When switching from Stripe Connect back to Organization Balance, your connected Stripe account is retained for 90 days.

### Organization Balance

Referral rewards are credited to your API Bricks organization balance and applied toward future invoices. This is useful for customers who want to offset their market data subscription costs.

### Stripe Connect

Receive eligible referral rewards as cash payouts through Stripe Connect. You can connect your Stripe account after referring at least one different organization and completing Stripe onboarding.

_Custom terms_

## Start Earning with Referrals

Already using CoinAPI, FinFeedAPI, or API Bricks?

Turn your recommendations, content, or integrations into referral earnings. Share your unique link, introduce new customers, and earn from qualifying subscriptions.

- [Contact us](/contact-us)
- [Read more](/referral-program)

Are you interested in custom terms?

---

# Authentication Process (https://www.apibricks.io/platform/docs/general/authentication)

---
title: Authentication Process
description: In this section, you will find comprehensive information about the process of authentication to CoinAPI API Produts. It covers the fundamental aspects and procedures involved in obtaining authentication for CoinAPI usage. Whether you are new to CoinAPI or seeking to enhance your understanding of the authentication process, this section will provide you with a valuable overview of the topic.
order: 2
---

# CoinAPI Authorization Process

## Overview

CoinAPI offers a range of products and services for cryptocurrency data and trading. Our sophisticated authorization process ensures secure and fair access across all CoinAPI products, including but not limited to market data, trading APIs, and analytics tools. This document outlines the key aspects of our authorization flow, focusing on quota management, pay-as-you-go functionality, and advanced authentication methods that apply uniformly across our product suite.

## Authorization Flow

1. **API Key Validation**
2. **Organization Validation**
3. **JWT Token Processing** (if applicable)
4. **Spend Management checks**
5. **Quota Checks and Pay-As-You-Go Handling**

### 1. API Key Validation

We verify the API key's validity and its association with the requested CoinAPI product (if specified).

### 2. Organization Validation

We ensure the API key is linked to an active organization.

### 3. JWT Token Processing

For API keys with JWT authentication enabled:

a. **Token Extraction and Validation**
   - We extract and decode the JWT from the Authorization header.
   - We verify the token's signature and expiration.

b. **Caching**
   - Valid tokens are cached to optimize performance on subsequent requests.

### 4. Spend Management checks

In this step, we perform crucial checks related to the organization's spending:

a. **Daily Threshold Check**
   - We verify if the organization has exceeded its daily spending threshold.
   - If the threshold has been exceeded, the request is rejected to prevent unexpected overspending.
   - This check applies to all requests, regardless of the organization's pay-as-you-go status.

### 5. Quota Checks and Pay-As-You-Go Handling

Our quota system is designed to provide flexible usage control at both the API key and organization levels, with special considerations for pay-as-you-go accounts.

a. **Organization-Wide Quotas**
   - These quotas apply across all API keys associated with an organization and are determined by the organization's subscriptions and committed-use plans.
   - They are independent of individual API keys and reflect the overall service level acquired by the organization.
   - Typical quota types include:
     - Total data volume limits
     - Aggregate request limits across all keys
     - Access to premium features or data sets

b. **Pay-As-You-Go and Quota Enforcement**
   - When pay-as-you-go is enabled for an organization:
     - The system attempts to enforce subscription limits, but due to the distributed nature of our infrastructure, strict enforcement is not guaranteed.
     - There may be small overages ("dust charges") if you rely solely on 429 responses to manage your usage.
     - To avoid unexpected charges, we recommend implementing your own usage tracking in addition to monitoring our 429 responses.
   - Account standing is determined by:
     - Current account balance
     - Available post-paid credit limit
   - This allows organizations to continue using CoinAPI services beyond their base subscription limits, providing flexibility for unexpected spikes in usage or growing needs.

c. **Billing and Credit Checks**
   - For organizations with pay-as-you-go enabled:
     - We check the organization's current account balance and available credit.
     - Usage is allowed to continue as long as the account remains in good standing.
   - If the account reaches its credit limit or has outstanding unpaid balances:
     - Further requests may be restricted until the account is brought back into good standing.
   - API access will be blocked if both conditions are met:
     - The oldest past due invoice is more than 31 days old
     - The total past due amount exceeds the organization's successful payments from the previous quarter

d. **Autocharge Feature**
   - Pay-as-you-go customers can enable the autocharge feature to maintain continuous good standing.
   - When enabled, this feature automatically charges the customer's payment method when their balance falls below a specified threshold.
   - Benefits of autocharge:
     - Ensures uninterrupted access to CoinAPI services
     - Prevents sudden service interruptions due to exceeding credit limits
     - Simplifies account management for high-volume users
   - Customers can set and adjust autocharge thresholds and limits through the Customer Portal.

## Special Cases

### Dynamic Quota Adjustment

Our system supports real-time quota adjustments:

- Organization quotas are automatically adjusted when subscription changes or committed-use plan modifications are processed.
- Pay-as-you-go status can be enabled or disabled, affecting how organization quotas are enforced across all services.

### Quota Overage Handling

Quota overage handling depends on the pay-as-you-go status:

1. For organization quotas:
   - With pay-as-you-go enabled:
     - The system attempts to enforce subscription limits, but small overages may occur.
     - Usage is monitored and billed according to the organization's plan rates, including any overages.
     - If autocharge is enabled, the account is automatically topped up to maintain good standing.
   - Without pay-as-you-go:
     - All API keys for the organization will be restricted when quotas are exceeded.
     - Service resumes when the quota resets (e.g., start of a new billing cycle) or the subscription is upgraded.

## Monitoring and Notifications

We maintain comprehensive monitoring of our authorization layer to ensure system health and optimal performance across all CoinAPI products. This includes tracking various aspects of the authorization process, quota utilization, and account status. Our monitoring system generates notifications for both internal teams and customers when certain thresholds are reached or unusual patterns are detected. This proactive approach allows us to address potential issues quickly and helps customers stay informed about their API usage and account status across all CoinAPI services.

## Conclusion

Our authorization process is designed to provide secure, flexible, and scalable access to all CoinAPI products. By implementing multi-layered validation, sophisticated quota management based on subscriptions and committed-use plans, and flexible pay-as-you-go options with autocharge capabilities, we ensure that our services remain protected while offering customers the ability to scale their usage according to their needs.

While we strive to enforce the limits, the distributed nature of our infrastructure means that small overages may occur. To avoid unexpected charges, we recommend implementing your own usage tracking in addition to monitoring our 429 responses. This approach ensures the most accurate usage management and helps prevent unintended overages.

The combination of API key-specific controls, organization-wide quotas, and pay-as-you-go flexibility provides a powerful toolset for managing API access and usage across diverse use cases and organizational structures, ensuring uninterrupted service for accounts in good standing across the entire CoinAPI product suite.

---

# CoinAPI (https://www.apibricks.io/platform/docs/general/changelogs/coinapi)

---
title: CoinAPI
description: Changelog for CoinAPI products, platform updates, and documentation changes.
---

This changelog covers updates for the `CoinAPI` product line, including changes to `Market Data API`, `Flat Files API`, `Exchange Rates API`, `Indexes API`, `Prediction Markets API`, shared platform services such as `Console` or `MCP API`, and related documentation.

It's a log of: `BREAKING CHANGES`, `FEATURES`, `IMPROVEMENTS`, `BUG FIXES`, `INTEGRATIONS`, or other `NOTES` per public version.

## 2026 October 14

##### NOTES
* __Flat Files API__: `LIMITBOOK_DEPTH_BANDS` is priced at $48.00 per GiB for the first 1 GiB per day per SKU, $24.00 for the next 9 GiB, and $12.00 above 10 GiB. Committed plan discounts still apply. Organizations that already used Flat Files keep $24.00, $12.00, and $6.00 until 2026-10-16 00:00 UTC, shown in Console under Billing > Pricing migrations.
* __Flat Files API__: `LIMITBOOK_DEPTH_BANDS` rows are one per minute. Files written at one-second intervals between 2026-03-24 and 2026-04-18 are being rewritten to one row per minute. Per-exchange Parquet files are kept for the most recent 90 days.

## 2026 October 7

##### IMPROVEMENTS
* __Console__: Improved past-due invoice handling. Automatic payment is retried daily, and service can be suspended after 14 days overdue.

## 2026 October 6

##### BUG FIXES
* __Market Data WebSocket DS API__: `HYPERLIQUIDL4` keeps immediate-or-cancel and market orders out of the book, so snapshots are no longer crossed. A rejected trigger no longer stalls the symbol, and a stream that cannot apply an update resyncs from a snapshot instead of freezing.

## 2026 October 5

##### IMPROVEMENTS
* __Market Data API__: `BITRUE` publishes trades as they stream, with the exchange timestamp, instead of polling every symbol once a second.

##### BUG FIXES
* __Market Data API__: `OKEX` quotes now follow the order book, including bid and ask size.

## 2026 October 2

##### IMPROVEMENTS
* __Market Data API__: `LUNO` applies order book changes level by level.

##### BUG FIXES
* __Flat Files API__: Downloads no longer fail when usage metering cannot match a priced product.
* __Market Data API__: `DERIBIT` keeps trades that follow a liquidation in the same batch. Option order books use the 100ms feed, and index symbols are no longer subscribed as markets.
* __Market Data API__: `BITKUB` symbols load again, repeated trades are published once, and broker markets keep an order book.

## 2026 October 1

##### BUG FIXES
* __Market Data API__: `BITRUE` order books stay subscribed and keep updating.
* __Market Data API__: `KRAKENFTS` symbols now include instrument type, inverse or linear, contract unit, tick size, size precision, and the exchange expiry time.
* __Market Data API__: `BINANCEFTSC` contract size follows the exchange specification, and `BINANCEFTS` linear contracts are no longer marked inverse.

## 2026 September 30

##### IMPROVEMENTS
* __Market Data WebSocket DS API__: Reduced `HYPERLIQUIDL4` delivery lag under peak load by publishing order book updates in batches instead of one message at a time.

##### BUG FIXES
* __Console__: Improved billing when a product price is retired so historical usage still reconciles.

##### NOTES
* __Documentation__: Added a guide for rebuilding a Hyperliquid L4 order book from `book_l4` snapshots and sequence-ordered updates.

## 2026 September 29

##### IMPROVEMENTS
* __Market Data API__: Finished the `REYA` live feed so the initial order book snapshot is applied on subscribe and reconnects do not republish historical fills.

## 2026 September 26

##### BUG FIXES
* __Flat Files API__: Parquet downloads are now metered against the priced exchange data-transfer rate.

## 2026 September 24

##### INTEGRATIONS
* __Market Data API__: Added `REYA` coverage for spot and perpetual markets.

##### BUG FIXES
* __Market Data API__: Restored `BINANCE` order book resync after WebSocket reconnects so major symbols no longer stay frozen under snapshot rate limits.
* __Market Data WebSocket DS API__: Fixed `HYPERLIQUIDL4` filled-order size reporting, skipped TWAP slice noise, and stopped delivering the same block twice after a node restart.

## 2026 September 23

##### INTEGRATIONS
* __Market Data API__: Added `RULE` (Rulematch) market data via FIX.

## 2026 September 21

##### IMPROVEMENTS
* __Market Data API__: Migrated `LUNO` order book and trades to WebSocket and expanded symbol coverage beyond the previous hardcoded pair list.

##### BUG FIXES
* __Market Data WebSocket DS API__: Fixed `HYPERLIQUIDL4` fill-before-open races and unmapped cancel statuses (including open-interest cap cancels) that could leave stale or crossed books.

## 2026 September 18

##### BUG FIXES
* __Market Data WebSocket DS API__: `book_l3` and `book_l4` snapshots now start at sequence `1` instead of skipping the first sequence number.
* __Market Data WebSocket DS API__: Stopped plain `HYPERLIQUIDL4` size updates from inheriting the order's `OPEN` status.

## 2026 September 17

##### BUG FIXES
* __Market Data WebSocket DS API__: Promoted triggered `HYPERLIQUIDL4` stop and take-profit orders into the live book instead of dropping them.

##### IMPROVEMENTS
* __Indexes API__: Improved historical VWAP index calculation from consolidated OHLCV input.

## 2026 September 16

##### IMPROVEMENTS
* __Market Data API__: Migrated `COINMATE` order book and trades to WebSocket.

##### BUG FIXES
* __Market Data WebSocket DS API__: `HYPERLIQUIDL4` `book_l4` now emits intermediate size updates on partial fills.

##### NOTES
* __Market Data API__: Discontinued `EXMO` and `TIMEX` coverage after both venues shut down.

## 2026 September 15

##### FEATURES
* __Flat Files API__: Added priced SKUs for `Metrics` and `Metrics V2` (open interest, funding rates, and related market metrics), billed at the same tiered rates as Quotes / BBO / Level 1.

##### IMPROVEMENTS
* __Market Data API__: Migrated `WEEX`, `LATOKEN`, and `COINONE` order book and trades to WebSocket.

##### BUG FIXES
* __MCP API__: Fixed the Flat Files MCP handshake so Streamable HTTP clients can connect.

## 2026 September 14

##### IMPROVEMENTS
* __Market Data API__: Migrated `COINW`, `BIGONE`, and `BITBANK` to WebSocket for live order book and trades, and `P2PB2B` for live order book. `BITBANK` now discovers pairs from the live market list instead of a stale hardcoded set.

##### BUG FIXES
* __Market Data API__: Corrected `BITHUMB` live trade timestamps from Korean time to UTC.

## 2026 September 11

##### IMPROVEMENTS
* __Market Data API__: Migrated `VALR`, `INDODAX`, `COINDCX`, and `WAZIRX` order book and trades to WebSocket.

## 2026 September 10

##### IMPROVEMENTS
* __Market Data API__: Migrated `BITFLYER`, `COINEX`, `KORBIT`, and `BITHUMB` order book and trades to WebSocket.

##### BUG FIXES
* __Market Data API__: Fixed Huobi-family (`HUOBIPRO`, `HUOBIFTS`, `HUOBIJP`, `HBDM`) WebSocket subscriptions, funding-rate parsing, and duplicate `HBDM` connections.
* __Market Data WebSocket DS API__: Stopped retired `add`/`sub` updates from leaking into `HYPERLIQUIDL4` `book_l4` during resyncs, and mapped additional submission-time rejection statuses.

## 2026 September 9

##### BUG FIXES
* __Market Data WebSocket DS API__: Fixed a `HYPERLIQUIDL4` snapshot race that could produce incomplete or crossed order book entries.

## 2026 September 8

##### FEATURES
* __Prediction Markets API__: Added billing for the OHLCV history endpoint.

##### IMPROVEMENTS
* __Flat Files API__: Hourly Metrics OHLCV Parquet now sources from `T-METRICS-V2`.

##### NOTES
* __Flat Files API__: Daily `T-METRICS-OHLCV` files are retired in favor of `T-METRICS-V2`.

## 2026 September 7

##### FEATURES
* __Prediction Markets API__: Added `/v1/activity/{exchange_id}/{market_id}/history/ohlcv` for historical bars (`1SEC`, `1MIN`, `1HRS`), also available as the `activity_get_ohlcv_history` MCP tool.
* __Flat Files API__: Added dedicated prediction-market trades, order book, quotes, and OHLCV datasets.

##### IMPROVEMENTS
* __Market Data API__: Faster OHLCV responses when a symbol is not already in cache.

##### BUG FIXES
* __Prediction Markets API__: History endpoints now accept either `date` or `time_start`/`time_end`, instead of requiring both at once.
* __Market Data API__: OHLCV queries return the nearest same-UTC-day bars when the requested window is empty.

## 2026 September 2

##### BUG FIXES
* __MCP API__: Fixed MCP tool calls failing when usage reporting tried to write response headers after the streamed response had already started.
* __Console__: Improved invoice handling.

## 2026 September 1

##### INTEGRATIONS
* __Market Data API__: Added `BITGETONCHAIN` for on-chain Bitget RWA and tokenized-stock trades (for example Ondo-issued tickers such as `NVDAon`), with a synthetic last-trade quote because these pools have no native order book.

##### BUG FIXES
* __Market Data API__: Migrated `BITGET` spot WebSocket to v3 and fixed mixed-case trade versus order book symbol keys that could split the same instrument into two identifiers.
* __Market Data WebSocket API__: Applied private data-source claims on WebSocket authentication so add-on venues such as `LMAXDIGITAL` are no longer rejected for entitled organizations.
* __Market Data WebSocket DS API__: Fixed `HYPERLIQUIDL4` parent/child metadata collision when Hyperliquid reuses the same order id, which could crash snapshot consumers.

##### NOTES
* __Market Data API__: `BITGETONCHAIN` recovers the underlying equity ticker by stripping Ondo's `on` suffix and quotes in `USD`.

## 2026 August 31

##### BUG FIXES
* __Market Data WebSocket DS API__: Mapped previously ignored `HYPERLIQUIDL4` order status strings, including `scheduledCancel`, so stale orders no longer remain in the book and produce crossed books.

## 2026 August 24

##### IMPROVEMENTS
* __Market Data API__: Switched `COINCHECK` from a stale hardcoded REST pair list to WebSocket with live pair discovery, covering newly listed and previously missing markets.

## 2026 August 22

##### BUG FIXES
* __Console__: Improved loading speed.

## 2026 August 21

##### IMPROVEMENTS
* __Market Data API__: Improved `KRAKEN` WebSocket throughput by decoupling receive from processing and parallelizing by symbol, reducing growing `time_exchange`/`time_coinapi` lag under load.

## 2026 August 20

##### INTEGRATIONS
* __Prediction Markets API__: Added `FORECASTEX` coverage, including symbol discovery plus trades and OHLCV from ForecastEx daily files.

##### FEATURES
* __Flat Files API__: Started serving the `coinapi-indexes` bucket so calculated index value files are available through Flat Files.

##### IMPROVEMENTS
* __Flat Files API__: Stopped escaping characters in index file object keys for cleaner, more predictable paths.

## 2026 August 19

##### INTEGRATIONS
* __Prediction Markets API__: Added `CRYPTOCOMPM` (Crypto.com prediction markets) for event and contract metadata, including per-contract prices carried on the periodic event poll.

##### IMPROVEMENTS
* __Prediction Markets API__: Faster `/v1/markets/{exchange_id}/history` pagination so deep pages no longer get progressively slower.

##### NOTES
* __Prediction Markets API__: `CRYPTOCOMPM` is metadata and price-only. The venue has no documented live book or trades feed, and expired contracts are removed instead of returning a settlement status.

## 2026 August 18

##### INTEGRATIONS
* __Prediction Markets API__: Added `PASCAL` with REST market discovery, resolution polling, and live WebSocket book and trades.
* __Prediction Markets API__: Added `GEMINIPM` (Gemini prediction markets) with REST discovery and live WebSocket market data.

## 2026 August 17

##### BUG FIXES
* __Market Data API__: Fixed `LIGHTER` symbol mapping so newly listed SPOT markets and FX or quote-suffixed perpetual symbols resolve with the correct base and quote assets.

## 2026 August 14

##### INTEGRATIONS
* __Market Data API__: Added `LIGHTERRH` integration for Lighter on Robinhood Chain, covering spot RWA tokens quoted in `USDG` and stock perpetuals quoted in `USD`.

##### BUG FIXES
* __Market Data API__: Migrated `GEMINI` to the current unified WebSocket stream API and fixed subscribe and gap-detection issues that could force unnecessary full order book resnapshots.

## 2026 August 13

##### BUG FIXES
* __Market Data API__: Restored `BINANCEOPT` trades and depth after the previous WebSocket host went offline, collapsed option-trade subscriptions per underlying, and fixed order book reconciliation so incremental updates no longer discard existing depth.
* __Market Data API__: Stopped tracking expired `BINANCEOPT` contracts so late settlement prints no longer mix into live option data.

## 2026 August 11

##### IMPROVEMENTS
* __Pricing__: Renamed billable display units from GB/MB to GiB/MiB so usage and Flat Files pricing match binary byte sizes.
* __Documentation__: Updated product documentation links to `www.coinapi.io/docs`.

## 2026 August 10

##### BUG FIXES
* __Market Data API__: Fixed `DEXTRADE` trade prices to use the exchange rate field instead of an incorrect price field.
* __Prediction Markets API__: Hardened `POLYMARKET` ingestion so CLOB archive walks no longer exhaust memory or block metadata writes.
* __Console__: Prevented organization creation when the authenticated email claim is missing.

## 2026 August 7

##### IMPROVEMENTS
* __MCP API__: Upgraded the shared MCP server stack so clients that send modern `server/discover` requests can connect successfully.
* __Prediction Markets API__: Improved historical flat-file read performance by filtering and parsing only the requested symbol rows.

##### BUG FIXES
* __Console__: Fixed auto-recharge retries so failed draft invoices are cleaned up instead of blocking later payment-method attempts.

## 2026 August 6

##### BUG FIXES
* __Prediction Markets API__: Detect `KALSHI` market settlement and finalization in real time, including `finalized` and `determined` statuses used by ranked-choice and multi-candidate markets.

## 2026 August 4

##### IMPROVEMENTS
* __Prediction Markets API__: Closed and resolved markets now receive metadata updates so status and settlement fields stay current after the market is first listed.

## 2026 July 31

##### IMPROVEMENTS
* __Market Data WebSocket DS API__: Split oversized `HYPERLIQUIDL4` funding misc events and improved file-tail stream health reporting so large Hyperliquid payloads are delivered more reliably.

## 2026 July 28

##### BUG FIXES
* __Prediction Markets API__: Fixed single-market lookups for `KALSHI`, `MYRIAD`, and `HYPERLIQUIDOUTCOME` that could return 404 because of key-casing mismatches.

## 2026 July 24

##### IMPROVEMENTS
* __Indexes API__: Improved persistence of calculated index values for more reliable historical access.
* __Market Data API__: Increased the `LBANK` REST backfill timeout to reduce missed historical trades.

## 2026 July 23

##### BUG FIXES
* __Market Data API__: Capped active `LBANK` symbols and rebalanced WebSocket connections to stop trade loss on that venue.

## 2026 July 16

##### BUG FIXES
* __Market Data API__: Fixed Metrics OHLCV export skipping historical rows that were already stored under CoinAPI metric names.

## 2026 July 15

##### FEATURES
* __Flat Files API__: Added a Metrics V2 hourly export pipeline that writes one consolidated file per exchange per hour, including DeFiLlama protocol metrics consolidated under `E-DEFILLAMA`.

## 2026 July 10

##### IMPROVEMENTS
* __Flat Files API__: Included prediction-market exchanges in the CoinAPI Flat Files pricing exchange list.
* __Prediction Markets API__: Faster `/v1/markets/{exchange_id}/history` pagination for venues with large market histories.

##### BUG FIXES
* __Prediction Markets API__: Fixed `POLYMARKET` crashing on a broken WebSocket during subscribe.

## 2026 July 8

##### FEATURES
* __Flat Files API__: Added priced SKUs for `METRICS-OHLCV` and DeFi protocol datasets, including Uniswap, SushiSwap, Curve, and DODO swaps, deposits, and withdrawals.
* __Flat Files API__: Added priced SKUs for Hyperliquid L4 datasets (`HLORACLEPRICES`, `HLTWAPSTATUSES`, `HLMISCEVENTS`, `HLSYSTEMEVENTS`).
* __Market Data API__: OHLCV aggregation now accepts index instruments that have no trade size, so `INDEX` symbols produce candles from price prints.

##### IMPROVEMENTS
* __Flat Files API__: Unified DEX swap, deposit, and withdrawal transfer prices by category so equivalent DeFi dataset types share the same tiered rates.
* __Market Data API__: Improved symbol mapping accuracy across multiple exchanges, including index identifiers, contract classification, and base/quote parsing for selected venues.

## 2026 July 7

##### FEATURES
* __Flat Files API__: Added two new derived order book dataset types: `T-LIMITBOOK_SNAPSHOT_50` and `T-LIMITBOOK_DEPTH_BANDS`.
* __Flat Files API__: `T-LIMITBOOK_SNAPSHOT_50` delivers fifty-level order book snapshots (top 50 bid and ask levels) at one-minute intervals, derived from the full limit order book. Available as per-symbol CSV and per-exchange Parquet files in the `coinapi` bucket.
* __Flat Files API__: `T-LIMITBOOK_DEPTH_BANDS` delivers depth-band liquidity summaries at one-second intervals, measuring cumulative resting order size around the midpoint across configurable basis-point bands (10–500 bps in the CSV; curated subset in Parquet and Snowflake). Derived from the full limit order book. Available as per-symbol CSV and per-exchange Parquet files in the `coinapi` bucket.
* __Market Data API__: Added optional `filter_exchange_id` on Quotes `/v1/quotes/latest` and `/v1/quotes/current` so quote snapshots can be limited to selected exchanges.

##### IMPROVEMENTS
* __Documentation__: Added dataset documentation for Limit Order Book Snapshot 50 and Limit Order Book Depth Bands, including schemas, field descriptions, and S3 path conventions.
* __Documentation__: Updated Flat Files datasets overview to include `T-LIMITBOOK_SNAPSHOT_50` and `T-LIMITBOOK_DEPTH_BANDS` in the available data types list, bucket table, and file structure tree.
* __Documentation__: Clarified the `filter_exchange_id` parameter description on Quotes endpoints.

##### BUG FIXES
* __Market Data API__: Set `IndexId` for BitMEX index symbols so index identifiers populate correctly in metadata.

##### NOTES
* __Flat Files API__: Both new dataset types are available only in the `coinapi` bucket and are not included in `coinapi-daily-tail`. They are priced under the existing Order Book (L2/L3/L4) data transfer tier.
* __Flat Files API__: Coverage is limited to exchanges where `T-LIMITBOOK_FULL` data is available.

## 2026 June 17

##### FEATURES
* __Market Data WebSocket DS API__: Expanded `HYPERLIQUIDL4` real-time coverage with four new feed families: `hl_oracle_prices`, `hl_twap_statuses`, `hl_misc_events`, and `hl_system_events`, complementing existing `book_l4` and `trade_l4` streams.
* __Market Data WebSocket DS API__: Added oracle enrichment streaming for Hyperliquid with per-coin mark/oracle/external-perp values, daily reference values, and raw input components to support advanced risk and reconciliation workflows.
* __Market Data WebSocket DS API__: Added TWAP lifecycle streaming with execution-progress fields (`sz`, `executed_sz`, `executed_ntl`, `minutes`) and execution attributes (`reduce_only`, `randomize`, `order_timestamp_ms`) for deeper execution monitoring.
* __Market Data WebSocket DS API__: Added normalized raw-event envelopes for Hyperliquid misc/system node streams (`exchange_id`, `block_number`, `event_type`, `json_payload`) to support low-level observability and audit-style downstream processing.
* __Flat Files API__: Added four new `HYPERLIQUIDL4` datasets to Flat Files delivery: `HLORACLEPRICES`, `HLTWAPSTATUSES`, `HLMISCEVENTS`, and `HLSYSTEMEVENTS`.
* __Flat Files API__: Added per-symbol file generation for `HLORACLEPRICES` and `HLTWAPSTATUSES`, aligned with existing `IDDI+SC+S` object key conventions.
* __Flat Files API__: Added exchange-consolidated stream delivery for `HLMISCEVENTS` and `HLSYSTEMEVENTS` to support exchange-wide raw event processing.

##### IMPROVEMENTS
* __Documentation__: Substantially expanded WebSocket DS Hyperliquid documentation to cover endpoint usage, subscription scope, and message schemas for all six `HYPERLIQUIDL4` feed types in one consistent integration model.
* __Documentation__: Added detailed field-by-field contracts and examples for new Hyperliquid DS messages, including enum/value guidance for `update_class`, TWAP `side`, and typical TWAP `status` states.
* __Documentation__: Clarified feed scope semantics by distinguishing symbol-scoped Hyperliquid streams (`book_l4`, `trade_l4`, `hl_oracle_prices`, `hl_twap_statuses`) from exchange-level event streams (`hl_misc_events`, `hl_system_events`).
* __Documentation__: Added Flat Files dataset documentation for Hyperliquid Oracle Prices, TWAP Statuses, Misc Events, and System Events, including schemas, examples, and path conventions.
* __Documentation__: Updated Flat Files datasets overview to include new Hyperliquid `T-HL*` prefixes and exchange-consolidated path guidance for raw event datasets.

##### NOTES
* __Market Data WebSocket DS API__: No migration is required for existing `book_l4` / `trade_l4` clients; integrations can opt in to the new Hyperliquid feeds by adding the new `subscribe_data_type` values in `hello`/`subscribe` messages.
* __Market Data WebSocket DS API__: For the full Hyperliquid DS surface area, use the dedicated `hyperliquidl4` data source endpoint family.
* __Flat Files API__: `HLMISCEVENTS` and `HLSYSTEMEVENTS` are exchange-consolidated datasets and do not use symbol-scoped object keys.

## 2026 June 12

##### IMPROVEMENTS
* __Platform__: Improved streaming and queue processing infrastructure to strengthen observability and operational control for data delivery workflows.

## 2026 June 11

##### FEATURES
* __Console__: Added organization-level billing mode management and improved billing usage reporting.

##### IMPROVEMENTS
* __Console__: Refined default date ranges and usage metrics in billing views for clearer reporting.

##### BUG FIXES
* __Market Data API__: Fixed market-data mapping and WebSocket startup issues that could lead to missing symbols, incorrect timestamps, or inaccurate reporting.

## 2026 June 10

##### IMPROVEMENTS
* __Console__: Improved onboarding communication workflows for more consistent customer follow-up.
* __MCP API__: Improved API key traceability and request logging for MCP-related actions.

##### BUG FIXES
* __Market Data API__: Fixed live data processing issues that could cause duplicate or delayed updates.

## 2026 June 9

##### FEATURES
* __Flat Files API__: Improved daily OHLCV file processing for more consistent historical data delivery.

##### IMPROVEMENTS
* __Documentation__: Added clearer pricing, API usage, pagination-limit, and lag-diagnostics guidance.

##### BUG FIXES
* __Market Data API__: Improved stability and correctness across selected market integrations, including filtering unsupported instruments and fixing connectivity or snapshot issues.

## 2026 June 8

##### FEATURES
* __Console__: Added more detailed free-credit eligibility checks with clearer qualification outcomes.

##### IMPROVEMENTS
* __Console__: Expanded usage reporting coverage and improved billing-related communication templates.

## 2026 June 5

##### FEATURES
* __Market Data API__: Enhanced the `HYPERLIQUIDL4` order book pipeline to capture more complete order lifecycle details across streaming, files, and APIs.

##### IMPROVEMENTS
* __Market Data API__: Added tooling and documentation to make `HYPERLIQUIDL4` order book outputs easier to inspect and validate.

##### BUG FIXES
* __Market Data API__: Fixed `HYPERLIQUIDL4` snapshot and lifecycle issues that could cause missing fields, duplicate rows, or inconsistent ordering.

## 2026 June 3

##### FEATURES
* __MCP API__: Expanded orchestration and response-quality safeguards for more reliable automated workflows.

##### IMPROVEMENTS
* __Console & API__: Expanded usage measurement coverage for more complete reporting.

## 2026 June 2

##### IMPROVEMENTS
* __Flat Files API__: Clarified full limit order book `update_type` values, including numeric mappings, to make order book reconstruction easier.
* __Platform__: Improved upload monitoring and scheduling controls to reduce processing at the wrong time.

## 2026 June 1

##### FEATURES
* __MCP API__: Improved sandboxed Python execution and API key handling for safer agent-driven workflows.

##### IMPROVEMENTS
* __Console__: Improved how usage credits are presented across pricing and billing surfaces.
* __Market Data API__: Added high availability guidance and regional endpoint documentation for REST, WebSocket V1, and WebSocket DS so customers can design more resilient failover setups.
* __Exchange Rates API__: Added high availability guidance and regional endpoint documentation for REST and WebSocket usage.

##### BUG FIXES
* __Documentation__: Corrected API base-URL guidance and related setup messaging.

## 2026 May 28

##### FEATURES
* __Market Data WebSocket DS API__: Added `HYPERLIQUIDL4` support documentation for `book_l4` and `trade_l4` streams, including order-level book data and transaction attribution.

## 2026 May 20

##### IMPROVEMENTS
* __Pricing__: Published clearer pricing pages for `Exchange Rates API`, `Flat Files API`, and `Indexes API`, including Pay As You Go usage, committed usage credits that can be spent across eligible products, plan comparisons, and FAQ guidance.

## 2026 April 29

##### FEATURES
* __Market Data WebSocket API__: Improved timeout diagnostics and connection phase tracking, making connection failures easier to understand and troubleshoot.
* __Console__: Enhanced invoice handling so invoices can be marked void or uncollectible more reliably during payment edge cases.

##### IMPROVEMENTS
* __Console__: Refined subscription notification handling so customers are notified only on real subscription state changes.
* __Documentation__: Fixed website documentation UI issues, including image rendering and code-block display problems.

##### BUG FIXES
* __Market Data WebSocket API__: Increased default WebSocket timeouts and improved close and error handling to prevent hanging connections and return clearer failure feedback.

## 2026 April 28

##### IMPROVEMENTS
* __Console__: Improved subscription-related UI and service handling to reduce failures when account or subscription data is incomplete.

## 2026 April 24

##### FEATURES
* __MCP API__: Added automatic conversation history compaction so long-running AI interactions can continue more reliably without hitting token limits.

##### IMPROVEMENTS
* __Market Data API__: Improved symbol ingestion so newly discovered assets are mapped and re-applied immediately instead of remaining unresolved.
* __MCP API__: Enhanced token usage tracking, including cached token accounting, for clearer observability and cost reporting.

##### BUG FIXES
* __Market Data API__: Reduced query complexity in DEX on-chain metrics processing to avoid database timeouts and improve reliability.

## 2026 April 23

##### FEATURES
* __Market Data API__: Added streaming page-by-page processing for paginated data sources, allowing results to become available sooner instead of waiting for full completion.

##### IMPROVEMENTS
* __Console__: Refined subscription state handling to avoid duplicate termination notifications and improve customer communication accuracy.
* __Flat Files API__: Unified Snowflake import behavior for more predictable data loading.

##### BUG FIXES
* __Market Data WebSocket API__: Fixed startup and subscription race conditions that could cause duplicate connections, duplicate subscriptions, or crash loops.
* __Market Data API__: Replaced rate-limited Ethereum RPC metadata lookups with more resilient DEX on-chain metadata queries to reduce startup failures and external dependency risk.

## 2026 April 22

##### FEATURES
* __MCP API__: Added persistent storage and retrieval of executed conversation messages to improve traceability of what happened during each run.
* __MCP API__: Improved conversation notifications and tracking so stalled conversations can be identified more accurately.

##### IMPROVEMENTS
* __MCP API__: Enhanced trace payloads with richer execution context, improving observability for long-running AI workflows.

##### BUG FIXES
* __Market Data WebSocket API__: Fixed WebSocket frame parsing, heartbeat, and null-handling issues to improve streaming stability.
* __Market Data API__: Corrected metrics behavior so symbol resolution happens per request instead of over-processing entire batches.

## 2026 April 21

##### FEATURES
* __MCP API__: Added model pricing details through a dedicated service and API endpoint so pricing information can be exposed more transparently.
* __MCP API__: Added token usage tracking in AI routing so usage metrics are consistently captured and returned.

##### BUG FIXES
* __Market Data API__: Improved symbol parsing and enforced minimum request intervals for selected exchange calls to reduce rate-limit errors.

## 2026 April 20

##### FEATURES
* __Market Data API__: Added an endpoint to reprocess stored symbol metadata for a selected exchange without pulling fresh external data, making mapping updates faster to apply.
* __Market Data API__: Added stronger deduplication so only the latest version of duplicate ingested records is processed.
* __Market Data API__: Expanded options and futures metadata support so derived fields are populated more consistently across data sources.

##### IMPROVEMENTS
* __Console__: Improved payment webhook reliability by replaying previously undelivered events when the service starts.

##### BUG FIXES
* __Market Data API__: Fixed DEX on-chain metrics ingestion issues, including error handling and destination routing problems, to stabilize daily processing.

## 2026 April 19

##### IMPROVEMENTS
* __Market Data API__: Improved symbol translation caching so missing lookups are remembered and not retried unnecessarily.
* __Market Data API__: Reworked metadata caching to make data retrieval more efficient and consistent.

##### BUG FIXES
* __Market Data API__: Updated metadata responses to return empty results instead of null values, reducing downstream processing failures.

## 2026 April 18

##### IMPROVEMENTS
* __Market Data API__: Improved symbol translation caching with safeguards to avoid repeated expensive lookups.
* __Market Data API__: Improved options metadata handling and made exchange-rate processing more resilient when source values are missing.
* __Market Data API__: Reduced system load by lowering the frequency of selected order book jobs where real-time updates were not required.

## 2026 April 17

##### IMPROVEMENTS
* __Market Data API__: Improved handling of exchange-specific symbol mapping quirks so affected assets can be normalized more accurately over time.
* __MCP API__: Refined conversation compression logic so summaries stay focused on the most relevant information.

##### BUG FIXES
* __Market Data WebSocket API__: Fixed a subscription timing issue that could cause some symbols to be missed during startup.
* __Market Data API__: Corrected exchange-specific symbol mapping to prevent assets from being labeled incorrectly.

## 2026 April 16

##### FEATURES
* __MCP API__: Added a safer cost guard unlock flow so limits can be increased without turning off cost monitoring entirely.
* __MCP API__: Introduced conversation continuation and compression support so longer AI interactions can keep going more smoothly.

##### IMPROVEMENTS
* __MCP API__: Improved input serialization and compression preparation so summaries and follow-up actions are more accurate and less error-prone.

## 2026 April 15

##### FEATURES
* __MCP API__: Added configurable cost guard thresholds in agent templates so spend limits can be managed and communicated more clearly.

##### IMPROVEMENTS
* __MCP API__: Improved conversation message ordering and processing so long-running AI conversations stay more coherent and preserve context better.
* __MCP API__: Updated compression defaults and sender labeling to make conversation histories easier to understand and reduce unnecessary processing.

## 2026 April 10

##### IMPROVEMENTS
* __Documentation__: Improved API documentation navigation with clearer grouping and tags, and added guidance for the WebSocket connectivity status feed.

##### BUG FIXES
* __Market Data API__: Fixed data sync behavior so future-dated records are ignored and not repeatedly reprocessed.
* __Market Data API__: Improved decentralized exchange metadata sync reliability by handling special-character asset names and overly long token names.
* __Market Data API__: Improved bulk metadata update stability with safer chunked processing and more reliable temporary-table handling.

## 2026 April 9

##### IMPROVEMENTS
* __Market Data API__: Improved KVP metadata freshness and availability by updating `raw_kvp` and `kvp_json` handling, reducing stale metadata windows.
* __Documentation__: Streamlined documentation navigation, removed outdated REST pages, and standardized links to key resources such as SDK and status information.
* __Documentation__: Improved OpenAPI documentation generation reliability by ensuring required metadata files are created and stale output is cleared before each build.

##### BUG FIXES
* __Market Data API__: Prevented unresolved or delisted symbols from appearing in exchange-level metrics responses when no valid identifier is available.
* __Market Data API__: Fixed historical metrics endpoints that could return blank OHLC results and improved request parameter handling for more consistent responses.
* __Market Data API__: Improved metadata service startup stability and prevented early requests from failing before background caches finish warming up.
* __Flat Files API__: Fixed missing `1SEC` coverage in Snowflake view generation filters.

## 2026 April 7

##### FEATURES
* __Market Data WebSocket API__: Added a connectivity status feed so clients can monitor exchange connectivity and heartbeat status in real time.

##### IMPROVEMENTS
* __Market Data API__: Hardened metadata and KVP synchronization to prevent stalled syncs and improve resilience when duplicate or oversized records are encountered.

##### BUG FIXES
* __Market Data API__: Fixed Bybit streaming edge cases related to missing symbols and invalid funding time values.

## 2026 April 2

##### IMPROVEMENTS
* __Market Data API__: Refined KVP mapper overwrite behavior and enforced data type consistency, improving metadata quality and symbol mapping reliability.

##### BUG FIXES
* __Market Data API__: Restored `WAZIRX` and `BLOCKCHAINEXCHANGE` integrations.
* __Exchange Rates API__: Fixed handling of empty FX volume values for `CENTRALBANKS` data.

## 2026 March 31

##### BUG FIXES
* __Market Data API__: Fixed missing asset metadata and KVP population for selected exchange integrations, improving symbol mapping completeness and consistency.

## 2026 March 27

##### IMPROVEMENTS
* __Market Data API__: Expanded `MarketAccess` KVP mapping coverage across exchanges, improving symbol classification, metadata normalization, and type derivation consistency.

##### BUG FIXES
* __Market Data API__: Fixed selected KVP mapping and `_type` injection issues, improving symbol mapping accuracy for affected exchanges.

## 2026 March 26

##### IMPROVEMENTS
* __Documentation__: Updated the website MCP integration used for blog post workflows and refreshed the MCP version used by the site.

## 2026 March 25

##### FEATURES
* __Flat Files API__: Added support for `1SEC` OHLCV Parquet generation, expanding sub-minute historical data availability.

##### IMPROVEMENTS
* __Flat Files API__: Improved file metadata extraction with cutoff-date handling for more consistent historical file processing.

## 2026 March 24

##### IMPROVEMENTS
* __Market Data API__: Improved symbol mapping reliability and KVP coverage across multiple exchange integrations, increasing metadata consistency and parser resilience.
* __Market Data API__: Refined orderbook snapshot and depth interval handling for more consistent depth emissions.

##### BUG FIXES
* __Market Data API__: Fixed multiple KVP parsing issues that could cause symbol loading or subscription failures for selected exchanges.

## 2026 March 23

##### FEATURES
* __MCP API__: Added glossary management support with the `glossary_unpublish_by_slug` tool.

##### IMPROVEMENTS
* __Market Data API__: Continued improvements to market access integrations and symbol mapping coverage, improving metadata quality and consistency across exchanges.

## 2026 March 20

##### IMPROVEMENTS
* __Market Data API__: Expanded symbol mapping and metadata normalization coverage across exchanges, including improved handling of precision and derivatives-related fields.

##### BUG FIXES
* __Market Data API__: Hardened the metadata processing pipeline against malformed numeric values and fixed KuCoin inverse contract multiplier handling, improving metadata consistency.

## 2026 March 16

##### FEATURES
* __Market Data API__: Added REST polling fallback for Binance Options (BINANCEOPT) when WebSocket is unavailable, with graceful shutdown and healthcheck support.
* __MCP API__: Released major upgrade for our MCP API which is no longer auto generated from our REST API, but instead is crafted in specific for AI Agents to perform as best as possible. This is change across all products: Market Data API, Flat Files API, Exchange Rates API, Indexes API.

##### BREAKING CHANGES
* __MCP API__: SSE MCP (Server Side Events) API is deprecated and will be removed at 2026-04-16. Please change endpoint to Stramable HTTP (/sse -> /mcp) to avoid disruptions.

##### IMPROVEMENTS
* __Market Data API__: Added symbol translation fallback cache for metrics older than 7 days, improving historical data availability.

## 2026 March 13

##### FEATURES
* __Market Data API__: Added Hyperliquid HIP-3 deployer perpetuals (DEPLOYER_PERPETUAL) support with spot metrics and quote asset fixes.

## 2026 March 3

##### FEATURES
* __Flat Files API__: Added MCP (Model Context Protocol) tools for Flat Files API, enabling AI-powered data access and exploration.

##### IMPROVEMENTS
* __Market Data API__: Enhanced OHLCV data quality by skipping trades with zero price or size from aggregation.

## 2026 February 17

##### FEATURES
* __Market Data API__: Added flat file support for 1SEC OHLCV data with intelligent routing between sub-minute and standard data sources.
* __Market Data API__: Added `QUOTES_ONLY` parameter support for BINANCE and COINBASE exchanges, enabling quote-only data subscriptions.

##### IMPROVEMENTS
* __Market Data API__: Added auto-fill for missing time boundaries in sub-minute OHLCV queries, improving query usability.

##### BUG FIXES
* __Market Data API__: Fixed OHLCV 1SEC data loss by replacing per-exchange cutoff with per-symbol last-write-wins buffer and time-delayed flush.
* __Market Data API__: Fixed OKEx empty fields handling in SPOT symbols API response.
* __Market Data API__: Fixed Coinbase scientific notation in decimal parsing.

## 2026 February 6

##### FEATURES
* __Prediction Markets API__: Added MCP (Model Context Protocol) support, enabling AI-powered access to prediction markets data.
* __Stock API__: Added MCP (Model Context Protocol) tools for Stock API.
* __Indexes API__: Enabled MCP (Model Context Protocol) support for Indexes REST API.
* __Exchange Rates API__: Added MCP (Model Context Protocol) tools for Exchange Rates API.

## 2026 February 4

##### INTEGRATIONS
* __Market Data API__: Added **ARKHAM** and **STANDX** exchange integrations with full market data support.

## 2026 February 2

##### FEATURES
* __Market Data API__: Added index price, mark price, and funding rate support for MEXC and GATEIO exchanges.
* __Market Data API__: Added perpetuals support to Bitstamp integration.
* __Market Data API__: Added market metrics support for BYBITINVERSE.

##### IMPROVEMENTS
* __Prediction Markets API__: Added proactive rate limiting to prevent ClickHouse overload during high-traffic periods.
* __Market Data API__: Improved BINANCEFTS rate limiting and contract type filtering.

##### BUG FIXES
* __Market Data API__: Fixed scientific notation handling in MEXC contractSize parsing.
* __Exchange Rates API__: Fixed inverted rates during extraction of AOA, BIF, TWD exchange rates.

## 2026 January 26

##### FEATURES
* __Market Data API__: Added hourly Parquet file generation for orderbooks and OHLCV metrics data, improving data granularity for historical access.

## 2026 January 19

##### FEATURES
* __Market Data API__: Added contract unit information (`future_contract_unit`, `future_contract_unit_asset`) for Gate.io perpetual contracts (GATEIOPERP), providing accurate contract size data for trading calculations.

##### IMPROVEMENTS
* __Market Data API__: Enhanced WebSocket connection stability for Gate.io exchanges (GATEIO, GATEIOPERP, GATEIOFTS, GATEIOOPT) and LIGHTER exchange:

## 2026 January 13

##### FEATURES
* __Market Data API__: Added hourly session support for historical data access:
  * REST API endpoints now support hourly granularity for orderbook, quotes, and trades
  * Automatic fallback to daily data when hourly data is unavailable

## 2026 January 1

##### FEATURES
* __Flat Files API__: Added DEX (Decentralized Exchange) on-chain data support with hourly and daily Parquet files:
  * Swaps, deposits, and withdrawals data now available for major DEX protocols
  * Supported protocols: Uniswap V2/V3, Curve Finance, SushiSwap V2, Dodo V2, Balancer V2
  * Both CSV and Parquet formats available with hourly granularity (post-Dec 23, 2025) and daily aggregations
  * Enhanced data processing pipeline for efficient on-chain data access

## 2025 November 27

##### FEATURES
* __Flat Files API__: Added support for multipart downloads, enabling efficient retrieval of large files.

##### IMPROVEMENTS
* __Flat Files API__: General response times improved across all endpoints.

## 2025 November 15

##### IMPROVEMENTS
* __Prediction Markets API__: Multiple stability, performance and quality improvements.

## 2025 November 25

##### FEATURES
* __Market Data API__: Added Open Interest metrics support:
  * **BINANCEFTS** (Binance USD-Margined Futures) - Open Interest data now available via Metrics API
  * **BINANCEFTSC** (Binance Coin-Margined Futures) - Open Interest data now available via Metrics API
  * **OKEX** - Open Interest data now available via Metrics API for futures and swap instruments
* __Market Data API__: Added support for Kraken tokenized assets:
  * Tokenized stock pairs (e.g., AAPLx/USD, TSLAx/USD) now available via REST and WebSocket APIs
  * Full market data support including orderbooks and trades for tokenized assets

##### INTEGRATIONS
* __Market Data API__:
  * **EXTENDED** integration migrated to WebSocket API for improved real-time data delivery
  * **MYRIAD** integration URL updated for scraping functionality

##### IMPROVEMENTS
* __Market Data API__: Enhanced system performance and reliability:
  * Increased WebSocket connection pool size for LIGHTER exchange to improve data throughput
  * Expanded subscription log queue capacity to handle higher message volumes
  * Optimized OHLCV snapshot processing with improved cutoff handling

##### BUG FIXES
* __Market Data API__: Resolved various integration issues:
  * Fixed KrakenFTS WebSocket trades snapshot handling
  * Corrected Bybit Options integration trade subscription logic
  * Resolved memory leak issues in subscription logging system
  * Fixed Polymarket symbol retrieval and pagination data source issues
  * Improved exception handling for external API responses
  * Fixed BTSE integration WebSocket subscription and endpoint configuration
  * Corrected COINEX symbols parsing
  * Enhanced PHEMEX integration to focus on most liquid assets
  * Improved LIGHTER integration stability

## 2025 November 14

##### INTEGRATIONS
* __Market Data API__: Added new exchange integrations:
  * **BTSEFTS** (BTSE Futures) - Full crypto futures support with WebSocket and REST API
    * Support for both perpetual and dated futures contracts
    * Automatic contract type detection with delivery time parsing
    * Contract size and unit asset tracking
  * **EDGEX** - New perpetual futures exchange integration
  * **PACIFICA** - New perpetual futures exchange integration

##### IMPROVEMENTS
* __Market Data API__: Enhanced ClickHouse metrics system:
  * Optimized embedded resources checking on initialization
  * Disabled redundant tables/view initialization for already initialized databases
  * Improved initialization performance and reduced startup overhead
* __Market Data API__: Fixed ExchangeMetricHistoryService asset_id_external handling

##### BUG FIXES
* __Market Data API__: Fixed critical data processing issues:
  * Resolved assembly version detection bug in DataInfoUpdateQueueService (build version now properly set from CI/CD pipeline)
  * Fixed BTSE integration WebSocket subscription and endpoint issues
  * Corrected COINEX symbols parsing
  * Fixed PHEMEX integration to track only most liquid assets, improving data quality
  * Resolved OHLCV Consolidated aggregator bug where only first trade of timeseries was stored
  * Fixed LIGHTER integration crossed orderbook issues
* __Market Data API__: OnChain exchanges improvements:
  * Updated Arbitrum and Ethereum RPC nodes for better reliability
  * Fixed swap query arguments for multiple DEX integrations (UNISWAP_V2, UNISWAP_V3, DODOEX_V2)

## 2025 November 4

##### BREAKING CHANGES
* __Market Data API__: Discontinued support for endpoint `/v1/orderbooks/{symbol}/latest`
  * This endpoint will remain available but is no longer actively supported
  * Please use `/v1/orderbooks/{symbol}/history` endpoint instead for accessing orderbook data

## 2025 October 30

##### FEATURES
* __Market Data API__: Introduced StringSanitizer utility for enhanced data integrity:
  * Automatically sanitizes asset names and exchange identifiers before storage
  * Includes comprehensive logging for Unicode detection and removal
  * Prevents Unicode character corruption issues in metadata

##### IMPROVEMENTS
* __Market Data API__: Significant database query performance optimizations:
  * Reduced query execution time by optimizing data retrieval patterns
* __Market Data API__: API response improvements:
  * Changed "You requested..." error responses from HTTP 550 to more standard HTTP 404
  * Fixed OHLCV controller Swagger documentation
* __Market Data API__: Performance optimizations:
  * Resolved DateTime overflow issues in data processing
  * Improved data consistency for latest available data points

##### BUG FIXES
* __Market Data API__: Fixed critical issues:
  * Resolved BITSO L3 orderbook data processing bug
  * Corrected symbol name case sensitivity issues in database operations
  * Fixed exception handling in assets and limit book endpoints

## 2025 October 21

##### FEATURES
* __Market Data API__: Launched exchange announcement monitoring system (Enterprise plan):
  * Automatic scraping and parsing of exchange announcements
  * Detection of new symbol listings from exchange websites
  * Real-time parsing of announcement content for market intelligence
  * Support for related symbols extraction from announcements

##### IMPROVEMENTS
* __Market Data API__: Enhanced symbol detection capabilities:
  * WebSocket DS API now broadcasts SymbolDetectionMessage for all exchanges
  * Real-time notification system for newly detected trading pairs
  * Integration with SymbolsLoadRequestController for comprehensive coverage
  * Improved market surveillance capabilities for automated systems

## 2025 October 16

##### FEATURES
* __Market Data API__: Launched high-frequency market changes detection (Enterprise plan):
  * Real-time detection of new trading pairs being listed on exchanges
  * Immediate notification of trading pairs being delisted
  * High-frequency monitoring (multiple checks per second) ensures minimal delay between exchange listing and detection
  * Comprehensive diagnostic metrics including API check rates, response times, and sampling intervals
  * Initial support for UPBIT exchange with more exchanges coming soon
  * Available via WebSocket DS API under `high_frequency_market_changes` data type
  * Ideal for trading bots, market surveillance, and automated data collection systems

## 2025 September 16

##### IMPROVEMENTS
* __Market Data API__: Enhanced metadata API and asset coverage:
  * Expanded asset coverage with additional chains and tokens
  * Improved accuracy of asset metadata and relationships
  * Enhanced cross-reference data between different asset identifiers
  * Optimized metadata endpoint response times
  * Added more detailed asset attributes and classifications

##### BUG FIXES
* __Market Data API__: Fixed various metadata API issues:
  * Resolved inconsistencies in asset identifier mappings
  * Fixed missing or incorrect chain information for some assets
  * Corrected asset relationship hierarchies
  * Addressed data synchronization issues in metadata updates

## 2025 September 15

##### FEATURES
* __Flat Files API__: Launched Flat Files API with OHLCV data support for multiple intervals:
  * 1SEC - One second intervals
  * 1MIN - One minute intervals
  * 1HRS - One hour intervals
  * 1DAY - One day intervals

## 2025 September 10

##### BUG FIXES
* __Market Data API__: Fixed exchange status reporting in metadata endpoints:
  * Corrected status field accuracy in exchange metadata
  * Resolved inconsistencies in exchange operational status
  * Improved real-time status updates for exchange availability
  * Enhanced synchronization between status indicators and actual exchange state

## 2025 September 05

##### IMPROVEMENTS
* __Market Data API__: Enhanced OHLCV data processing and delivery:
  * Improved data aggregation accuracy across all time intervals
  * Faster processing of high-frequency market data
  * Enhanced data quality validation for real-time updates
  * Optimized historical data retrieval performance
  * Reduced latency for period-end candle finalization

## 2025 August 27

##### IMPROVEMENTS
* __Market Data API__: Enhanced WebSocket OHLCV real-time feed:
  * Reduced latency for real-time candle updates
  * Improved data consistency across all time periods
  * Optimized message delivery for high-volume markets
  * Enhanced synchronization between REST and WebSocket OHLCV data
  * Better handling of market volatility periods

## 2025 August 21

##### IMPROVEMENTS
* __Market Data API__: Enhanced BACKPACK integration:
  * Improved data quality and reliability
  * Reduced latency for real-time data delivery
  * Optimized market data processing pipeline
  * Enhanced symbol mapping accuracy

## 2025 August 18

##### BUG FIXES
* __Flat Files API__: Resolved issue with COINBASE files showing zero size and download errors:
  * Fixed file size reporting for COINBASE market data files from August 1st to August 12th, 2025
  * Resolved download timeout errors for affected files
  * Restored proper access to historical COINBASE market data files

## 2025 August 14

##### INTEGRATIONS
* __Market Data API__: Added TOOTHEMON integration with full market data support.
* __Market Data API__: Added HASHKEY integration with comprehensive market data coverage.

## 2025 August 13

##### IMPROVEMENTS
* __Indexes API__: Enhanced performance and stability for historical data access:
  * Optimized query response times for historical index data retrieval
  * Improved data consistency and reliability across all historical endpoints
* __Market Data API__: Significant performance upgrades for historical exchange rates:
  * Reduced latency for historical exchange rate queries
  * Enhanced stability for high-volume historical data requests
  * Improved data consistency across all time ranges

## 2025 August 05

##### IMPROVEMENTS
* __Market Data API__: Significant improvements in exchange integrations:
  * BINGX integration enhanced with improved data quality and reduced latency
  * MEXC integration optimized for better performance and reliability
  * GATEIO integration upgraded with enhanced data accuracy and real-time updates

## 2025 July 30

##### IMPROVEMENTS
* __Market Data API__: Significantly reduced latency and improved real-time accuracy of OHLCV aggregated data.
  * Closed candles are now finalized within approximately 10 seconds of the period ending (down from up to 3 minutes).
  * In-progress candles refresh every 1-3 seconds on highly-liquid markets, providing fresher data for trading bots and back-testing.
  * Enhancement applies to all periods (1SEC-1Y) and major exchanges, e.g., Binance, Coinbase.
* __Market Data API__: Added POWERTRADE integration.

## 2025 June 29

##### FEATURES
* __Market Data API__: Our OHLCV Market Data now can include midpoint from best prices on the both sides of the book `midpoint = ((ask + bid) / 2)` this mean that there will be elements with `trades_count = 0 and volume_traded = 0` when in period there was no transactions, but there are changes in the order book resting best prices.

## 2025 June 26

##### BREAKING CHANGES
* __Market Data API REST API__: `/v1/symbols` now lists only active symbols for faster responses; all symbols, including inactive ones, are still accessible via `/v1/symbols/{exchange_id}/history`.

##### IMPROVEMENTS
* __Infrastructure__: Overall infrastructure stability and performance improvements.

## 2025 June 18

##### FEATURES
* __Market Data API__: Released version 2 API of the Metrics API. The V2 API contains all the metrics from the V1 API which is now in the deprecated state plus additional metrics like:
  * Minted stablecoins
  * Stablecoins circulating supply, unreleased supply, minted supply
  * Stablecoins bridged to other chains
  * Total Value Locked per protocol
  * Fees per protocol
  * Onchain trading volumes
* __Market Data API__: Extended our Market Data API by /v1/chains endpoint.

##### NOTES
* __Metrics API V1__: The V1 API is now in deprecated state. [Documentation for V2 API](https://www.coinapi.io/products/market-data-api/docs/rest-api/metricsv2/marketdata_list_metrics_v2_listing)

## 2025 June 17

##### FEATURES
* __Model Context Protocol (MCP)__: Officially launched MCP support across CoinAPI products:
  * Easy integration with AI chat models (LLMs) and autonomous agents
  * Single composite MCP endpoint at `https://mcp.api.apibricks.io/mcp` for all services
  * Machine-readable JSON-Schema format that describes API endpoints, parameters, and usage
  * Schema-level validation for more robust integrations
  * Auto-discovery of new API routes and services without requiring client-side updates
  * Unified authentication and consistent developer experience across all APIs
  * Future-proof architecture ensuring seamless integration with new services

## 2025 June 13

##### FEATURES
* __Console__: Added support for credits with expiration dates.

## 2025 May 30

##### IMPROVEMENTS
* __Console__: Expanded notification types to include:
  * Credits Added (free, auto recharged, or manually added)
  * Credits Auto Recharge Failed
  * Credits Low Balance
  * API Key First Authorization Failure

## 2025 May 29

##### FEATURES
* __Console__: Enhanced notification system:
  * Users can customize which notifications they want to receive
  * Support for additional email recipients for non-billing and action required notifications
  * Integration capabilities with PagerDuty and Slack channels
  * New notifications history view

## 2025 May 21

##### INTEGRATIONS
* __Market Data API__: Added ASTERFINANCE integration.
* __Market Data API__: Added EXTENDED integration.

## 2025 May 14

##### IMPROVEMENTS
* __Console__: Added Balance History view showing detailed historical balance changes and transactions.
* __SDK & OpenAPI__: Released new unified GitHub repository at [api-bricks/api-bricks-sdk](https://github.com/api-bricks/api-bricks-sdk) featuring:
  * Consolidated OpenAPI definitions for all product lines
  * Automated daily updates of OpenAPI definitions
  * Automatic SDK updates on OpenAPI changes
  * Automated package publishing to PyPI, NuGet, and other package managers
  * Legacy and manual SDK support maintained

## 2025 May 9

##### IMPROVEMENTS
* __Console & API__: Introduced Fractional Billing for Metered Usage.
* __Console & API__: Enhanced billing logic - customers are not invoiced until becoming Paying Customers after using free credits.
* __Console__: Added new Metered Usage views:
  * Daily History
  * Monthly Statement
  * Uninvoiced Currently
* __Console__: Replaced Tax Settings with Tax Registrations in the Invoice Address section.
* __Console__: Enhanced auto recharge feature:
  * Prioritizes last successful payment method
  * Added support for Direct Debits from bank accounts

## 2025 April 01

##### FEATURES
* __Console__: Migrated Traces for Requests, Traces for Connections, Usage metrics, Support tickets, and Quotas and Limits from the Customer Portal to the Console. The Console is now the default place for customers.

##### IMPROVEMENTS
* __Console__: Improved Request and Connection Traces to display information in a more user-friendly way.
* __Indexes API__: Shortened the number of PRIMKT indexes as they were too wide.
* __Market Data API__: Reduced latency for all exchanges.
* __Market Data API__: Made major improvements in historical data processing.
* __Market Data API__: Completed OHLCV and quotes backfill for multiple exchanges.
* __Exchange Rates API__: Stability improvements.

##### INTEGRATIONS
* __Market Data API__: Added VERTEX integration (as of 2025-04-08).
* __Market Data API__: Added PARADEX integration (as of 2025-04-09).
* __Market Data API__: Added ORDERLYNETWORK integration (as of 2025-04-23).
* __Market Data API__: Added TOOBIT integration (as of 2025-04-23).
* __Market Data API__: Added WEEX integration (as of 2025-04-23).
* __Market Data API__: Added FAMEEX (SPOT) integration (as of 2025-04-25).
* __Market Data API__: Added FAMEEXFTS integration (as of 2025-04-25).
* __Market Data API__: Added TAPBIT integration (as of 2025-04-25).
* __Market Data API__: Added TAPBITFTS integration (as of 2025-04-25).

##### NOTES
* __Console__: The old customer portal has been disabled. We are continuously working on improving the Console.

##### BUG FIXES
* __Exchange Rates API__: Resolved various issues.

## 2025 March 01

##### INTEGRATIONS
* __Market Data API__: Added BINANCEOPT integration.
* __Market Data API__: Added DRIFT integration.
* __Market Data API__: Added DEEPCOINFTS integration.
* __Market Data API__: Added ORANGEX integration.
* __Market Data API__: Added ORANGEXFTS integration.
* __Market Data API__: Added COINCALL SPOT integration.
* __Market Data API__: Added COINCALLFTS integration.
* __Market Data API__: Added COINCALLOPT integration.
* __Market Data API__: Added HOTCOIN integration.
* __Market Data API__: Added HOTCOINFTS integration.
* __Market Data API__: Added GRVT integration.

##### IMPROVEMENTS
* __Market Data API__: Reduced latency standard deviation and implemented general network improvements for the `WebSocket API` and `FIX API`.
* __Exchange Rates API__: Expanded asset coverage to include more fiat FX pairs and commodities such as gold (XAU) and silver (XAG).
* __Exchange Rates API__: Extended the historical data availability for high-frequency (100ms interval) FX data back to 2012.

## 2025 February 01

##### FEATURES
* __Indexes API__: Added possibility to preview changes to the Index Components.
* __Console__: We relesed new console that will in the future replace old customer portal.
* __Console__: In new Console there is possibility to generate API Keys that are not limited to single product.

##### INTEGRATIONS
* __Market Data API__ __Flat Files API__: Added LMAXDIGITAL Premium Data Source feed.
* __Market Data API__: DERIBIT integration improvements.
* __Market Data API__: DRIFT integrated using WebSocket API.
* __Market Data API__: BACKPACK integration PERPETUAL symbols covered.
* __Market Data API__: BITRUE rewrited on WebSocket API.
* __Market Data API__: UPBIT integration over WebSocket API.
* __Market Data API__: WHITEBIT integration over WebSocket API.
* __Market Data API__: BINANCE integration improvements.
* __Market Data API__: PHEMEX integration improvements.
* __Market Data API__: HUOBI related integrations improved.

##### IMPROVEMENTS
* __Indexes API__ __Market Data API__ __Exchange Rates API__: Data quality and coverage improvements.

##### BUG FIXES
* __Market Data WS DS API__: Some individual integrations were not available via the WS DS API.

## 2025 January 01

##### FEATURES
* __Exchange Rates API__: Released new Exchange Rates API as fork from the Market Data API. REST and WebSocket API protocols with real-time and historical data and assets.

##### INTEGRATIONS
* __Market Data API__ __Flat Files API__: Improved the BYBIT integrations. BYBITUSDC virtual exchange was discontinued, the symbols were moved to the BYBIT exchange to align the identifiers better with the exchange API.
* __Market Data API__ __Flat Files API__: Resolved the issue with the KUCOIN integration.

##### IMPROVEMENTS
* __Market Data API__: Various documentation improvements.
* __Flat Files API__: Added cost estimation source code for reference.
* __Market Data API__ __Indexes API__: Improved the performance and availability of the Exchange Rates and Indexes, deployed another location in the NCSA region for availability.
* __Documentation__: Migrated Metadata Explorer from the website to the documentation.
* __Market Data REST API__: Improved the response time performance of the Exchange Rate Historical endpoint for all assets at specific timestamp.
* __Market Data API__ __Indexes API__: Improved the stability and performance of the data calculation.

##### BUG FIXES
* __Market Data API__ __Flat Files API__: Limit parameter is correctly ignored when accesing historical quotes, trades and orderbooks while querying by the `date` parameter.
* __Market Data API__: Fixed the corner-case with the time value on the weekend and monday while querying for the real-time crosses using crypto and the fiat's for which markets are closed on the weekend.

##### BREAKING CHANGES
* __Indexes API__: WebSocket API do not provide the `sequence` field in the messages as data is delivered only via the TCP which guarantees the order of the messages and provides the sequence number (on the deeper level).

## 2024 December 01

##### FEATURES
* __Market Data API__: Options Market State endpoint providing now underlying_price field.
* __Index API__: Released IDX_VOL_CAPIVIX index family, our first volatility indexes measuring 30-day implied volatility based on options markets. Currently available for two pairs:
   - IDX_VOL_CAPIVIX_BTC_USD
   - IDX_VOL_CAPIVIX_ETH_USD

##### IMPROVEMENTS
* __Market Data API__ __Flat Files API__: Performance, lantecy and stability improvements.
* __Market Data API__ __Flat Files API__: Updated the symbol mapping procedures to resolve various corner-cases, improved the CoinAPI symbol identifiers. We are now using scientific notation for the OPTION symbols in the Strike Price field.
* __Flat Files API__: Improved prefix handling in the ListObjects response.

##### BUG FIXES
* __Flat Files API__: Fixed issues related to 'Last-Modified' error or BAD_REQUEST responses when using multipart downloads.

## 2024 November 01

##### FEATURES
* __Market Data API__: Added new Options Market State endpoint providing comprehensive options data:
  - Displays current option prices grouped by underlying asset and expiration dates
  - Shows strike prices with associated bid/ask prices and volumes
  - Includes last trade details (price, size, and aggressor direction)
  - Provides both exchange and CoinAPI timestamps
  - Designed for easy integration with dashboards and analytics applications

##### IMPROVEMENTS
* __Market Data API__: Added regional endpoints and unencrypted options for all API types:
  - REST API: Added NCSA, EMEA, and APAC regional endpoints, each available via HTTP and HTTPS
  - WebSocket API: Added NCSA, EMEA, and APAC regional endpoints, each available via WS and WSS
  - FIX API: Added NCSA, EMEA, and APAC regional endpoints, each available on ports 3302 (unencrypted) and 3303 (encrypted)
  - All endpoints maintain GeoDNS auto-routing option through the default domains
* __WebSocket API__: Performance enhancements:
  - Better stability during high market activity
  - Improved long-term connection reliability
* __Market Data API__: Platform improvements:
  - Faster response times across all endpoints
  - More reliable real-time data delivery
* __Service Level Agreement (SLA)__: SLA Target changed from 99% to 99.9%

##### INTEGRATIONS
* __Market Data API__: Integrated several new exchanges to expand our market coverage:
  - BACKPACK exchange integration completed
  - HYPERLIQUID exchange integration
  - COINW exchange integration
  - BITMARTFTS exchange integration

## 2024 October 01

##### FEATURES
* __Customer Portal__: Released a new Spend Management feature, giving users greater control over their credit usage:
  - Daily credit consumption tracking
  - Customizable daily credit usage budget
  - Email notifications for threshold alerts
  - Webhook integration for real-time usage updates
  - Automated enforcement of budget limits

##### IMPROVEMENTS
* __Market Data API__: Significant enhancements to our Exchange Rates service:
  - Increased frequency of exchange rate updates from 1 second to 100 milliseconds, providing more real-time data.
  - Extended coverage to include all FX rates, offering a comprehensive view of the forex market.
  - Improved quality of rates for corner-cases through algorithm adjustments, ensuring more accurate data in unusual market conditions.

##### INTEGRATIONS
* __Market Data API__: Integrated the Hyperliquid exchange, expanding our coverage of decentralized perpetual futures trading platforms.

##### FEATURES
* __Indexes API__: Introduced FX Reference Rates Index, published every 100 milliseconds, providing high-frequency benchmark data for forex markets.

##### BUG FIXES
* __Documentation__: Resolved an issue in the documentation UI where users occasionally couldn't set up an API key for requests.
* __Customer Portal__: Fixed a bug where users with free API keys were unable to use the "Manage Subscriptions" button.

## 2024 September 01

##### IMPROVEMENTS
* __Market Data API__: Improvements in the performance of the history endpoints OHLCV, Exchange Rates and Historical Metrics.
* __Documentation__: Added a new article explaining how usage credits work, providing clarity on our billing system.

##### FEATURES
* __Indexes API__: We have added the Indexes API to our product portfolio, providing comprehensive market data aggregation from multiple sources for a broad overview of market conditions.

## 2024 August 01

##### IMPROVEMENTS
* __Customer Portal__: We added the Traces for Connections in the customer portal. This will help us gather more information about the usage and enable identification of the possible issues faster. This is currently available for Market Data WS and FIX API in EMEA and APAC, and will be expanded.
* __Customer Portal__: We added an Audit Trial feature (you can find it in left-side menu) where any organization member can inspect what changes were applied by other user inside in the organization account.
* __Status Page__: We have a new status page released with many improvements and changes:
     * Updated with uptime percentages, full incident history, and new API
     * Added product-specific uptime displays
     * Enabled access to complete incident records
     * Launched API for automated status checks
* __Documentation__: We made a few important improvements and changes in our docs:
     * New welcome page added
     * Improved top navigation for better product accessibility
     * Enhanced mobile menu with a focus on product selection
     * Fixed all broken links for improved SEO
     * Added a new security section

##### NOTES
* __Customer Portal__: We removed possibility to set Market Data API REST Request Limits per specific API Key. Keys that had that enabled and set will work the same. The new keys do not have possibility to have that set.

## 2024 July 01

##### IMPROVEMENTS
* __Market Data API__: Effective immediately, we have increased the publishing frequency of our historical exchange rates from 1-second intervals to 100-millisecond intervals to enable more precise analysis and decision-making for our users who rely on historical exchange rate data.
     * Historical exchange rates are now updated every 100 milliseconds (previously every 1 second)
     * This change applies to all currency pairs in our historical data set
     * No action is required from customers to access this enhanced data
* __Customer Portal__: A new, more user-friendly way to log in. When you are logged in to the Customer or Support portal then you can switch between them without logging in again separately.

## 2024 June 01

##### FEATURES
 * __Customer Portal__: The release of an improved Usage Metrics view with new features.
     * **Extended Time Interval Querying:** Customers can now query usage metrics over a wider range of time intervals, including 1 hour, 6 hours, 1 day, 3 days, 1 week, 2 weeks, and 1 month. This enables better trend analysis and long-term tracking of data usage patterns.
     * **Advanced Filtering Options:** The updated view allows fine-grained filtering by several parameters: Data Center, API Key, Data Source, Operation Name, Protocol Name, and Service Name.
     * **More Metrics Available for Tracking:** Customers can track a variety of metrics using the new view, including Data Messages Received, Data Messages Sent, Data Bytes Received, Data Bytes Sent, Connection Time, API Calls, API Calls Received, API Calls Sent, Market Data API REST Credits

 * __WebSocket DS API__:
     * **Exchange-Specific Connections:** The new setup ensures that issues with one exchange do not affect other data streams.
     * **Direct Routing with Optimized DNS:** Connections are routed directly to the infrastructure closest to the exchange, reducing latency by eliminating unnecessary hops and aggregation points.
     * **Enhanced Authorization:** Authorization now supports query-string, URL path, header, or JWT (JSON Web Token), removing the need for the API key field in the hello message.
     * **Precise Symbol Filtering:** Requires exact symbol identifiers, with error messaging for invalid symbols while keeping the connection active. Supports both our format and the exchange format for symbol identifiers.
     * **Supported Data Types:** Includes quote, trade, and book data types for comprehensive data access.

##### INTEGRATIONS

 * __Market Data API__: We have integrated our Market Data API with the BITRUE exchange.
 * __EMS Trading API__: Integrated the Institutional API using FIX.
 * __EMS Trading API__: Refreshed our integration with Poloniex to utilize their newest API

##### IMPROVEMENTS

 * __API Limits:__ `X-CoinAPI-Limits: ForceInclude` header is no longer interpreted on our side and information about the Limits is provided in each API Call response header.
 * __Support:__ We have added support for the Coinbase Advanced API (WebSocket) to our EMS API.
 * __EMS Trading API__: We have also conducted various tests on our existing integrations and made a few improvements.
 * __WebSocket DS API__:
     * **Better Latency:** By routing connections directly to the nearest infrastructure to the exchange, one hop in the data transmission path is eliminated, resulting in faster data delivery.
     * **Optimized for High Volume:** Designed to handle high data volumes efficiently, addressing the limitations of the original WebSocket API under high traffic conditions.

##### ONGOING SUPPORT

* __WebSocket API V1:__ Continued support with no plans for deprecation. Users can continue using the V1 API as usual while benefiting from the new features of the WebSocket DS API.

## 2024 May 01

##### INTEGRATIONS

 * __Market Data API__: Integration of BitMEX Options - Users can now trade options for BTC, ETH, DOGE, SOL, BNB, and XRP with multiple expiration dates. The new multi-coin margining system supports BTC, USDT, and USDC.
 * __Market Data API__: Reintegration with LMAX Digital exchange

##### FEATURES

 * __Market Data API__: New feature to access on-chain addresses for each asset, including details such as chain ID, network ID, and specific addresses for networks like ARBITRUM and ETHEREUM.
 * __Customer Portal__: Introduced Traces View to provide detailed logs of all API calls, including filtering options for time ranges and HTTP status. This feature enhances transparency and allows real-time monitoring of API interactions.

## 2024 April 01

##### FEATURES

 * __Index API__: We've released the Alpha version of the feature with the IDX_REFRATE_VWAP indexes family. Values have been filled backward for almost 15 years. Current values are also available. Index endpoints have been refreshed to reflect available operations and fit usage scenarios. The documentation is updated.
 * __Index API__: The feature is designed to give a comprehensive view of the market by aggregating data from many sources. This can be particularly useful for traders and investors who want to get a broad overview of the market conditions. More information about the Index API can be found at https://www.coinapi.io/products/indexes-api/docs/rest-api/indexes/v1/indexes/get
 * __CoinAPI SDK__: .NET console application for SDK exchange data throughput/latency tests
 * __Market Data WebSocket API__: We added the possibility to subscribe to any asset pair in exchange rates (previously only USD or stablecoins were allowed on the quote).
 * __Market Data REST API__: In the metadata of assets, for each asset, we now provide the on-chain addresses per network chain.

##### IMPROVEMENTS

 * __Status Page__: We are now collecting new Prometheus metrics from the integrations that will be charted in Grafana. In the next step, we will provide dashboards with performance metrics for our API, so that customers have more insight into our statistics.
 * __Customer Portal__: A new, more transparent view of subscriptions is introduced: https://customerportal.coinapi.io/subscriptions
 * __Market Data API__:  Exchange Rates API – Historical Exchange Rates using now the same data source as Index API.
 * __Market Data API__: Multiple unrelated stability and latency improvements executed.

##### INTEGRATIONS

 * __Market Data API__: General stability and performance improvements for DERIBIT, POLONIEXFTS, CRYPTOCOM

##### NOTES

  * __Websocket API__: Changed book data type to require a defined filter in the hello or subscribe message

## 2024 March 01

##### FEATURES

  * __Market Data WebSocket API__: Added 2 new messages (subscribe and unsubscribe) to allow control of the state of the connection without repeating the complete state using a hello message at every change.

##### IMPROVEMENTS

  * __Market Data REST API__: Added example responses in the REST API in OpenAPI and the documentation.
  * __Market Data API__: Several improvements exeucted for the BEQUANT CRYPTOCOM HUOBIFTS~ BITKUB data sources.
  * __Market Data REST API__: OHLCV by Exchange endpoint can now be called while time_start and time_end crossing midnight UTC.
  * __Market Data API__: Multiple unrelated stability and latency improvements executed.
  * __Documentation__: Added the API limits and billing metrics page.
  * __Documentation__: Added the performance testing guide page.

##### BUG FIXES

  * __Market Data REST API__: Resolved issue causing the REST API Credits to be counted incorrectly while having multiple API Keys for some customers.

## 2024 February 01

##### FEATURES

  * __Market Data REST API__: Added Index API feature for the testing and early feedback in the alpha version.
  * __Market Data REST API__: Added OHLCV historical data by exchange.

##### IMPROVEMENTS

  * __Documentation__: Added the EMS Trading API QuickStart How-to Guide.
  * __Website__: Released Metadata Explorer covering the exchanges and symbols that we support.

## 2024 January 01

##### BREAKING CHANGES

  * __EMS API__: Public release of the product, promotion from the beta phase.

##### IMPROVEMENTS

  * __Market Data API__: Increased stability and reduced latency by 50% for the Exchange Rates and OHLCV endpoints.
  * __Support:__ Intoduced AI Bot that has the information about the product and answering questions on the support.
  * __Market Data API__: Increased the frequency and stability of the data feeds reducing the latencies and variance of latencies.
  * __Documentation__: Migrating the FAQ section to the documentation.
  * __Website__: Improved free plan subscription flow.

##### INTEGRATIONS

  * __Market Data API__: Added new integration `DYDX` to the DYDX v3.
  * __EMS API__: Added new integration `DYDX` to the DYDX v3.

##### FEATURES

  * __Market Data FIX API__: Improved feed L2 feed to make sure each L2 update is trackable to specific L3 updates if the data source distributing data in L3 format.

##### BUG FIXES

  * __EMS API__: Resolved issue related to the fact that we reported errors on invalid orders received from the customer side in non descriptive manner.

##### NOTES

  * We focused mostly on the stability of the platform and improvements that we can execute on multiple fronts.

---

# FinFeedAPI (https://www.apibricks.io/platform/docs/general/changelogs/finfeedapi)

---
title: FinFeedAPI
description: Changelog for FinFeedAPI products, platform updates, and documentation changes.
---

This changelog covers updates for the `FinFeedAPI` product line, including changes to `Currencies API`, `Stock API`, `Flat Files API`, `Prediction Markets API`, `SEC API`, shared platform services such as `Console` or `MCP API`, and related documentation.

It's a log of: `BREAKING CHANGES`, `FEATURES`, `IMPROVEMENTS`, `BUG FIXES`, `INTEGRATIONS`, or other `NOTES` per public version.

## 2026 October 7

##### IMPROVEMENTS
* __Console__: Improved past-due invoice handling. Automatic payment is retried daily, and service can be suspended after 14 days overdue.

## 2026 October 2

##### BUG FIXES
* __Flat Files API__: Downloads no longer fail when usage metering cannot match a priced product.

## 2026 September 30

##### IMPROVEMENTS
* __Stock API__: Native IEX streams can start from `time_start`. Omit `limit` to read from that instant through the end of the day.
* __MCP API__: Native IEX tools now return a download URL for the day's stream instead of the events themselves.

##### BUG FIXES
* __Stock API__ __SEC API__: Byte usage is billed as data transfer only, so large downloads no longer fail.
* __Console__: Improved billing when a product price is retired so historical usage still reconciles.

## 2026 September 15

##### BUG FIXES
* __MCP API__: Fixed the Flat Files MCP handshake so Streamable HTTP clients can connect.

## 2026 September 10

##### IMPROVEMENTS
* __Stock API__: End-of-day exchange syncs now run after each market close instead of all at once at midnight UTC, so Asian sessions are no longer delayed.
* __Stock API__: IEX data is ingested as next-day files appear, so morning coverage is no longer missed.

## 2026 September 8

##### FEATURES
* __Flat Files API__: Added a dedicated `predictionmarkets` bucket for prediction-market trades, quotes, order books, and OHLCV.
* __Prediction Markets API__: Added billing for the OHLCV history endpoint.
* __Stock API__: Added IEX 1-minute OHLCV coverage with daily rollups.

## 2026 September 7

##### FEATURES
* __Prediction Markets API__: Added `/v1/activity/{exchange_id}/{market_id}/history/ohlcv` for historical bars (`1SEC`, `1MIN`, `1HRS`), also available as the `activity_get_ohlcv_history` MCP tool.
* __Flat Files API__: Added dedicated prediction-market trades, order book, quotes, and OHLCV datasets.

##### BUG FIXES
* __Prediction Markets API__: History endpoints now accept either `date` or `time_start`/`time_end`, instead of requiring both at once.
* __Stock API__: OHLCV queries return the nearest same-UTC-day bars when the requested window is empty.

## 2026 September 4

##### FEATURES
* __Stock API__: Historical 1-second OHLCV is now available beyond the recent two-day window.
* __Flat Files API__: Added priced SKUs for prediction-market sub-daily OHLCV periods.

## 2026 September 2

##### BUG FIXES
* __MCP API__: Fixed MCP tool calls failing when usage reporting tried to write response headers after the streamed response had already started.
* __Console__: Improved invoice handling.

## 2026 August 22

##### BUG FIXES
* __Console__: Improved loading speed.

## 2026 August 20

##### INTEGRATIONS
* __Prediction Markets API__: Added `FORECASTEX` coverage, including symbol discovery plus trades and OHLCV from ForecastEx daily files.

## 2026 August 19

##### INTEGRATIONS
* __Prediction Markets API__: Added `CRYPTOCOMPM` (Crypto.com prediction markets) for event and contract metadata, including per-contract prices carried on the periodic event poll.

##### IMPROVEMENTS
* __Prediction Markets API__: Faster `/v1/markets/{exchange_id}/history` pagination so deep pages no longer get progressively slower.
* __Stock API__: Faster `/v1/symbols/{exchange_id}` pagination for large listings, including page jumps that previously got slower on later pages.

##### NOTES
* __Prediction Markets API__: `CRYPTOCOMPM` is metadata and price-only. The venue has no documented live book or trades feed, and expired contracts are removed instead of returning a settlement status.

## 2026 August 18

##### INTEGRATIONS
* __Prediction Markets API__: Added `PASCAL` with REST market discovery, resolution polling, and live WebSocket book and trades.
* __Prediction Markets API__: Added `GEMINIPM` (Gemini prediction markets) with REST discovery and live WebSocket market data.

## 2026 August 11

##### IMPROVEMENTS
* __Pricing__: Renamed billable display units from GB/MB to GiB/MiB so usage and Flat Files pricing match binary byte sizes.
* __Documentation__: Updated product documentation links to `www.finfeedapi.com/docs`.

## 2026 August 10

##### BUG FIXES
* __Prediction Markets API__: Hardened `POLYMARKET` ingestion so CLOB archive walks no longer exhaust memory or block metadata writes.
* __Console__: Prevented organization creation when the authenticated email claim is missing.

## 2026 August 7

##### IMPROVEMENTS
* __MCP API__: Upgraded the shared MCP server stack so clients that send modern `server/discover` requests can connect successfully.
* __Prediction Markets API__: Improved historical flat-file read performance by filtering and parsing only the requested symbol rows.

##### BUG FIXES
* __Console__: Fixed auto-recharge retries so failed draft invoices are cleaned up instead of blocking later payment-method attempts.

## 2026 August 6

##### BUG FIXES
* __Prediction Markets API__: Detect `KALSHI` market settlement and finalization in real time, including `finalized` and `determined` statuses used by ranked-choice and multi-candidate markets.

## 2026 August 4

##### IMPROVEMENTS
* __Prediction Markets API__: Closed and resolved markets now receive metadata updates so status and settlement fields stay current after the market is first listed.

## 2026 July 28

##### BUG FIXES
* __Prediction Markets API__: Fixed single-market lookups for `KALSHI`, `MYRIAD`, and `HYPERLIQUIDOUTCOME` that could return 404 because of key-casing mismatches.

## 2026 July 14

##### IMPROVEMENTS
* __Stock API__: Faster `/v1/symbols/{exchange_id}` pagination for exchanges with large symbol histories.

## 2026 July 13

##### BUG FIXES
* __Stock API__: Restored Euronext reference-data updates by switching instrument extraction to the public CSV export endpoints after the previous list API stopped returning rows.

## 2026 July 10

##### IMPROVEMENTS
* __Prediction Markets API__: Faster `/v1/markets/{exchange_id}/history` pagination for venues with large market histories.

##### BUG FIXES
* __Prediction Markets API__: Fixed `POLYMARKET` crashing on a broken WebSocket during subscribe.

## 2026 June 12

##### IMPROVEMENTS
* __Platform__: Improved streaming and queue processing infrastructure to strengthen observability and operational control for data delivery workflows.

## 2026 June 11

##### FEATURES
* __Console__: Added organization-level billing mode management and improved billing usage reporting.

##### IMPROVEMENTS
* __Console__: Refined default date ranges and usage metrics in billing views for clearer reporting.

## 2026 June 10

##### IMPROVEMENTS
* __Console__: Improved onboarding communication workflows for more consistent customer follow-up.
* __MCP API__: Improved API key traceability and request logging for MCP-related actions.

## 2026 June 9

##### IMPROVEMENTS
* __Documentation__: Added clearer pricing, API usage, pagination-limit, and lag-diagnostics guidance.

## 2026 June 8

##### FEATURES
* __Console__: Added more detailed free-credit eligibility checks with clearer qualification outcomes.

##### IMPROVEMENTS
* __Console__: Expanded usage reporting coverage and improved billing-related communication templates.

## 2026 June 3

##### FEATURES
* __MCP API__: Expanded orchestration and response-quality safeguards for more reliable automated workflows.

##### IMPROVEMENTS
* __Console & API__: Expanded usage measurement coverage for more complete reporting.

## 2026 June 2

##### IMPROVEMENTS
* __Platform__: Improved upload monitoring and scheduling controls to reduce processing at the wrong time.

## 2026 June 1

##### FEATURES
* __MCP API__: Improved sandboxed Python execution and API key handling for safer agent-driven workflows.

##### IMPROVEMENTS
* __Console__: Improved how usage credits are presented across pricing and billing surfaces.
* __Currencies API__: Added high availability guidance and regional endpoint documentation for REST and WebSocket usage so customers can design more resilient failover setups.

##### BUG FIXES
* __Documentation__: Corrected API base-URL guidance and related setup messaging.

## 2026 May 20

##### IMPROVEMENTS
* __Pricing__: Published clearer pricing pages for `Currencies API`, `Stock API`, `Flat Files API`, `Prediction Markets API`, and `SEC API`, including Pay As You Go usage, committed usage credits that can be spent across eligible products, plan comparisons, and FAQ guidance.

## 2026 April 29

##### FEATURES
* __Console__: Enhanced invoice handling so invoices can be marked void or uncollectible more reliably during payment edge cases.

##### IMPROVEMENTS
* __Console__: Refined subscription notification handling so customers are notified only on real subscription state changes.
* __Documentation__: Fixed website documentation UI issues, including image rendering and code-block display problems.

## 2026 April 28

##### IMPROVEMENTS
* __Console__: Improved subscription-related UI and service handling to reduce failures when account or subscription data is incomplete.

## 2026 April 24

##### FEATURES
* __MCP API__: Added automatic conversation history compaction so long-running AI interactions can continue more reliably without hitting token limits.

##### IMPROVEMENTS
* __MCP API__: Enhanced token usage tracking, including cached token accounting, for clearer observability and cost reporting.

## 2026 April 23

##### FEATURES
* __Prediction Markets API__: Added streaming page-by-page processing for paginated data sources, allowing results to become available sooner instead of waiting for full completion.

##### IMPROVEMENTS
* __Console__: Refined subscription state handling to avoid duplicate termination notifications and improve customer communication accuracy.
* __Flat Files API__: Unified Snowflake import behavior for more predictable data loading.

## 2026 April 22

##### FEATURES
* __MCP API__: Added persistent storage and retrieval of executed conversation messages to improve traceability of what happened during each run.
* __MCP API__: Improved conversation notifications and tracking so stalled conversations can be identified more accurately.

##### IMPROVEMENTS
* __MCP API__: Enhanced trace payloads with richer execution context, improving observability for long-running AI workflows.

## 2026 April 21

##### FEATURES
* __MCP API__: Added model pricing details through a dedicated service and API endpoint so pricing information can be exposed more transparently.
* __MCP API__: Added token usage tracking in AI routing so usage metrics are consistently captured and returned.

## 2026 April 20

##### IMPROVEMENTS
* __Console__: Improved payment webhook reliability by replaying previously undelivered events when the service starts.

## 2026 April 17

##### IMPROVEMENTS
* __MCP API__: Refined conversation compression logic so summaries stay focused on the most relevant information.

## 2026 April 16

##### FEATURES
* __MCP API__: Added a safer cost guard unlock flow so limits can be increased without turning off cost monitoring entirely.
* __MCP API__: Introduced conversation continuation and compression support so longer AI interactions can keep going more smoothly.

##### IMPROVEMENTS
* __MCP API__: Improved input serialization and compression preparation so summaries and follow-up actions are more accurate and less error-prone.

## 2026 April 15

##### FEATURES
* __MCP API__: Added configurable cost guard thresholds in agent templates so spend limits can be managed and communicated more clearly.

##### IMPROVEMENTS
* __MCP API__: Improved conversation message ordering and processing so long-running AI conversations stay more coherent and preserve context better.
* __MCP API__: Updated compression defaults and sender labeling to make conversation histories easier to understand and reduce unnecessary processing.

## 2026 April 10

##### IMPROVEMENTS
* __Documentation__: Refreshed `SEC API` documentation with new sections, cleaner organization, and improved navigation in the API docs.

## 2026 March 16

##### FEATURES
* __MCP API__: Released major upgrade for our MCP API which is no longer auto generated from our REST API, but instead is crafted in specific for AI Agents to perform as best as possible. This is change across all products: Currencies API, Stock API, Flat Files API, Prediction Markets API and SEC API.

##### BREAKING CHANGES
* __MCP API__: SSE MCP (Server Side Events) API is deprecated and will be removed at 2026-04-16. Please change endpoint to Stramable HTTP (/sse -> /mcp) to avoid disruptions.

## 2026 March 3

##### FEATURES
* __Flat Files API__: Added MCP (Model Context Protocol) tools for Flat Files API, enabling AI-powered data access and exploration.

## 2026 February 17

##### FEATURES
* __Market Data API__: Added flat file support for 1SEC OHLCV data with intelligent routing between sub-minute and standard data sources.

##### BUG FIXES
* __Market Data API__: Fixed OHLCV 1SEC data loss by replacing per-exchange cutoff with per-symbol last-write-wins buffer and time-delayed flush.

## 2026 February 6

##### FEATURES
* __Prediction Markets API__: Added MCP (Model Context Protocol) support, enabling AI-powered access to prediction markets data.
* __Stock API__: Added MCP (Model Context Protocol) tools for Stock API.
* __Indexes API__: Enabled MCP (Model Context Protocol) support for Indexes REST API.
* __Exchange Rates API__: Added MCP (Model Context Protocol) tools for Exchange Rates API.

##### IMPROVEMENTS
* __Prediction Markets API__: Added proactive rate limiting to prevent ClickHouse overload during high-traffic periods.

## 2026 February 2

##### FEATURES
* __Prediction Markets API__: Added historical data endpoints for trades, quotes, and orderbooks with time-range querying capabilities and S3 flat file integration.

##### IMPROVEMENTS
* __Prediction Markets API__: Enhanced time-based filtering to use `time_coinapi` field for more accurate time-range queries.
* __Prediction Markets API__: Aligned OHLCV endpoint limit validation with market data API standards.

## 2025 November 27

##### FEATURES
* __Flat Files API__: Added support for multipart downloads, enabling efficient retrieval of large files.

##### IMPROVEMENTS
* __Flat Files API__: General response times improved across all endpoints.

## 2025 November 15

##### IMPROVEMENTS
* __Prediction Markets API__: Multiple stability, performance and quality improvements.

## 2025 October 3

##### FEATURES
* __Prediction Markets__: Launched Prediction Markets.

## 2025 September 15

##### FEATURES
* __Flat Files API__: Launched Flat Files API with OHLCV 1DAY data support.

## 2025 September 9

##### INTEGRATIONS
* __Stock API__: Added PHILIPPINE STOCK EXCHANGE (XPHS) with supported market data (history since 2019).
* __Stock API__: Added MADRID STOCK EXCHANGE (XMAD) with supported market data.
* __Stock API__: Added JOHANNESBURG STOCK EXCHANGE (XJSE) with supported market data (history since 2020).
* __Stock API__: Added BUDAPEST STOCK EXCHANGE (XBUD) with supported market data.
* __Stock API__: Added BUCHAREST STOCK EXCHANGE (XBSE) with supported market data (history since 2009).
* __Stock API__: Added ATHENS STOCK EXCHANGE (ASEX) with supported market data (history since 2020).

## 2025 August 21

##### IMPROVEMENTS
* __Stock API__: Enhanced BACKPACK exchange integration:
  * Improved data quality and reliability
  * Reduced latency for real-time data delivery
  * Optimized market data processing pipeline
  * Enhanced symbol mapping accuracy

## 2025 August 18

##### BUG FIXES
* __Flat Files API__: Fixed issue with file size reporting and download errors:
  * Resolved zero size reporting for market data files from August 1st to August 12th, 2025
  * Fixed download timeout errors for affected files
  * Restored proper access to historical market data files

## 2025 August 14

##### INTEGRATIONS
* __Stock API__: Added TOOTHEMON exchange integration with full market data support.
* __Stock API__: Added HASHKEY exchange integration with comprehensive market data coverage.

## 2025 August 13

##### IMPROVEMENTS
* __Currencies API__: Enhanced performance and stability for historical data:
  * Optimized response times for historical currency rate queries
  * Improved data consistency and reliability across all time ranges
  * Enhanced stability for high-volume historical data requests
  * Streamlined data delivery for multi-currency historical comparisons

## 2025 August 4

##### INTEGRATIONS
* __Stock API__: Added STOCK EXCHANGE OF THAILAND (XBKK) with EOD OHLCV data availability.

## 2025 June 22

##### INTEGRATIONS
* __Stock API__: Added amaican Stock Exchange (XJAM) with supported market data.

## 2025 June 18

##### INTEGRATIONS
* __Stock API__: Added MOSCOW EXCHANGE - ALL MARKETS (MISX) with supported market data.
* __Stock API__: Added SIX SWISS EXCHANGE AG (XSWX) with supported market data.
* __Stock API__: Added HONG KONG EXCHANGES AND CLEARING LTD (XHKG) with supported market data.
* __Stock API__: Added TAIPEI EXCHANGE (ROCO) with supported market data.

## 2025 June 17

##### FEATURES
* __MCP__: Launched Model Context Protocol (MCP) support across all FinFeedAPI products:
  * Provides machine-readable JSON-Schema manifest describing every endpoint, parameters, and usage.
  * Enables out-of-the-box integration with AI chat models (LLMs) and autonomous agents.
  * Offers a single composite endpoint: `https://mcp.api.apibricks.io/mcp` for accessing all services.
  * Delivers schema-level validation, catching user errors early and improving reliability.
  * Auto-discovers new API routes and services, removing the need for client-side updates.
  * Maintains the existing authentication mechanism, ensuring a consistent developer experience.

## 2025 June 13

##### FEATURES
* __Console__: Added support for credits with expiration dates.

## 2025 June 10

##### IMPROVEMENTS
* __SEC API__: Added new tutorial "Tesla SEC XBRL Filing Data Analysis and Visualization" demonstrating the XBRL to JSON converter functionality. Available in our [GitHub repository](https://github.com/api-bricks/api-bricks-sdk/blob/master/finfeedapi/sec-api-rest/tutorials/Tesla_SEC_XBRL_Filing_Data_Analysis_and_Visualization.ipynb).

## 2025 June 6

##### FEATURES
* __SEC API__: Added WebSocket API with Real-time Fillings Feed
* __SEC API__: Completed XBRL to JSON converter endpoint

##### IMPROVEMENTS
* __Stock API__: Now interpreting CFI Codes of symbols in REST API
* __SEC API__: Renamed "Historical SEC REST API" to "SEC REST API" in documentation to reflect real-time filing updates

##### INTEGRATIONS
* __Stock API__: Added TAIWAN STOCK EXCHANGE (XTAI) with EOD OHLCV data availability T+1 since 2004

## 2025 June 5

##### IMPROVEMENTS
* __Console__: Added a new credits summary section in the billing overview for better financial tracking.

## 2025 May 30

##### IMPROVEMENTS
* __Console__: Expanded notification types to include:
  * Credits Added (free, auto recharged, or manually added)
  * Credits Auto Recharge Failed
  * Credits Low Balance
  * API Key First Authorization Failure

## 2025 May 29

##### FEATURES
* __Console__: Enhanced notification system:
  * Users can customize which notifications they want to receive
  * Support for additional email recipients for non-billing and action required notifications
  * Integration capabilities with PagerDuty and Slack channels
  * New notifications history view

## 2025 May 28

##### INTEGRATIONS
* __Stock API__: Added SIX SWISS EXCHANGE AG (XSWX) with EOD OHLCV data availability T+1 since 1997.

## 2025 May 22

##### INTEGRATIONS
* __Stock API__: Added HONG KONG EXCHANGES AND CLEARING LTD (XHKG) with EOD OHLCV data availability T+1 since 2015.

## 2025 May 20

##### INTEGRATIONS
* __Stock API__: Added WARSAW STOCK EXCHANGE/EQUITIES/MAIN MARKET (XWAR) with EOD OHLCV data availability T+1 since 1991.

## 2025 May 19

##### FEATURES
* __SEC API__: Launched new SEC API product with:
  * Initial set of basic tutorials demonstrating API functionality
  * Documentation available at [docs.finfeedapi.com/sec-api](https://docs.finfeedapi.com/sec-api/)
  * Example code and tutorials in [GitHub repository](https://github.com/api-bricks/api-bricks-sdk/tree/master/finfeedapi/sec-api-rest/tutorials)
  * More features and tutorial content planned for future releases

## 2025 May 15

##### INTEGRATIONS
* __Stock API__: Added TAIPEI EXCHANGE (TPEX/ROCO) with EOD OHLCV data availability T+1 since 2007.

## 2025 May 14

##### IMPROVEMENTS
* __Console__: Added Balance History view showing detailed historical balance changes and transactions.
* __SDK & OpenAPI__: Released new unified GitHub repository at [api-bricks/api-bricks-sdk](https://github.com/api-bricks/api-bricks-sdk) featuring:
  * Consolidated OpenAPI definitions for all product lines
  * Automated daily updates of OpenAPI definitions
  * Automatic SDK updates on OpenAPI changes
  * Automated package publishing to PyPI, NuGet, and other package managers
  * Legacy and manual SDK support maintained

## 2025 May 9

##### INTEGRATIONS
* __Stock API__: Added SHANGHAI STOCK EXCHANGE (XSHG) with EOD OHLCV data availability T+1 since 1990.
* __Stock API__: Added SHENZHEN STOCK EXCHANGE (XSHE) with EOD OHLCV data availability T+1 since 1999.

##### IMPROVEMENTS
* __Console & API__: Introduced Fractional Billing for Metered Usage.
* __Console & API__: Enhanced billing logic - customers are not invoiced until becoming Paying Customers after using free credits.
* __Console__: Added new Metered Usage views:
  * Daily History
  * Monthly Statement
  * Uninvoiced Currently
* __Console__: Replaced Tax Settings with Tax Registrations in the Invoice Address section.
* __Console__: Enhanced auto recharge feature:
  * Prioritizes last successful payment method
  * Added support for Direct Debits from bank accounts

## 2025 April 18

##### INTEGRATIONS
* __Stock API__: Expanded End-of-Day integrations by adding the following exchanges: EURONEXT BRUSSELS (ALXB, MLXB, VPXB, XBRU), EURONEXT LISBON – SOCIEDADE GESTORA DE MERCADOS REGULAMENTADOS S.A. (ALXL, ENXL, XLIS), EURONEXT GROUP (ALXP), BORSA ITALIANA S.P.A. (ATFX, BGEM, ETFP, ETLX, EXGM, MIVX, MTAA, MTAH), OSLO BØRS ASA (MERK, XOAS, XOSL), EURONEXT GROWTH DUBLIN (XESM), EURONEXT – EURONEXT AMSTERDAM (XAMS), EURONEXT DUBLIN (XMSM), and EURONEXT PARIS SA (XPAR, XMLI). Data is available for Stocks, Bonds, Funds, and ETFs via the Stock API using the `asset_class` and `symbol_category` fields.

##### FEATURES
* __Stock API__: Added time-aggregated OHLCV endpoints for historical data. See [Historical data](https://docs.finfeedapi.com/stock-api/rest-api-historical/historical-data).

## 2025 March 28

##### BREAKING CHANGES
* __Stock Histrical API__: Initial API product release. Endpoints: Metadata.
* __Stock Histrical API__: Added Native Exchange API for IEX Exchange covering Level 1 & 2 & 3, Trades, Admin and System Messages.

---

# Account (https://www.apibricks.io/platform/docs/general/customer-portal/account)

---
title: Account
description: Manage your team's profile, user access, and core administrative settings.
order: 19
---

# Account

This is your Account section, providing a central hub to manage your team's profile, user access, and core administrative settings.

## Settings

**Settings page**, is located within the "Account" section, where you can manage basic settings related to your team.

Here's a breakdown of the settings available:

- **Team Details**:
    - **Name**: You can see and update your team's name. The current name is shown in an input field, with an **"Update"** button next to it to save any changes.
    - **ID**: Your team's unique identifier is displayed here, along with a handy copy icon to easily copy it to your clipboard.
- **Leave Team**:
    - This section provides the option to leave the current team.
    - It includes a cautionary message: "This action is not reversible. Please continue with caution."
    - A red **"Leave Team"** button is available to initiate this action.
- **Delete Team**:
    - This section allows for the permanent removal of your team.
    - A strong warning accompanies this option: "Permanently remove your team and all of its contents from the CoinAPI platform. This action is not reversible. Please continue with caution."
    - A red **"Delete Team"** button is present to proceed with this irreversible action.

## Users

**Users page**, is located within the "Account" section. This page specifically allows you to handle user invitations and oversee current user access.

Here's a breakdown of what you can do on this page:

- **Invite Users**:
    - This section enables you to add new members to your team.
    - You'll find an **"Email"** input field to enter the email address of the person you want to invite.
    - A **"Role"** dropdown menu (showing "Select Role" by default) allows you to assign a role to the new user.
    - Once you've entered the details, you click the **"Invite User"** button.
- **User Management**:
    - This section lists all current users associated with your team, providing an overview of their details and activity.
    - The list is presented in a table with the following information for each user:
        - **Email**: The user's email address.
        - **Role**: The role assigned to the user, typically displayed as a badge ("admin" or "user").
        - **Last Sign**: This indicates the user's last sign-in time, shown with relative timestamps like "2 hours ago" (often in green for recent activity) or "never" (in gray).
        - An action icon (a **delete icon**) is present for each user, suggesting an option to remove them from the team.

---

# API Keys (https://www.apibricks.io/platform/docs/general/customer-portal/api-keys)

---
title: API Keys
description: Create and manage Standard API Keys and JWT Keys for accessing CoinAPI services.
order: 12
---

# API Keys

This is your **API Keys page**. It provides the explanation of the two types of API keys offered: **Standard API Keys**, which are static secrets you should keep secure, and **JWT API Keys**. The latter allows you to generate JWT tokens using a private or public key, suitable for scenarios like frontend applications due to their short-lived expiration times.

The page is divided into sections for managing these keys.

In the "**Standard API Keys**" section, you'll find a "**Create Standard API Key**" button. Below this is a table listing your existing standard keys. This table displays details for each key, including a Name (which is system-generated if not otherwise specified by you), the associated Product (e.g., "Market Data API," "Flat Files API"), a portion of the API Key itself, the Author, its last usage date (indicated in the "Used" column), and its current operational state (shown in the "Status" column, e.g., "Enabled"). Each key also has a delete icon for its removal.

The "**JWT Keys**" section appears below this. Similar to the Standard API Keys section, this area features a "**Create JWT Key**" button and a table listing your existing JWT keys. This table provides comparable information: Name, associated Product, a portion of the JWT Key, Author, its last usage date (under "Used"), and its current Status. Each JWT key can also be removed using its designated delete icon.

---

# Billing (https://www.apibricks.io/platform/docs/general/customer-portal/billing)

---
title: Billing
description: Manage your account finances, invoices, payment methods, spend management, and more.
order: 10
---

# Billing

## Overview

This is your **Overview page** within the Billing section. It gives you a snapshot of your organization's financial status and related settings.

The page is divided into several key areas:

- **Your Credit Balance**
    - **Total Credits** - This is the total number of usage credits (gross) you've purchased or have been granted.
    - **Usage This Period** - Credits used so far in the current billing cycle that will be on your next invoice (may include usage from previous periods that has not yet been invoiced).
    - **Remaining Credits** - This is your balance of purchased credits after accounting for your uninvoiced usage.

- **Your Available Usage**
    - **Remaining Credits** - The credits you currently have left on your account net of uninvoiced usage.
    - **Overage Protection** - Your allowance to continue using the service on negative balance. Any usage from this protection will be billed on your next invoice. This credit line is enabling possibility to overage subscriptions without having to pay for it upfront (post-paid).
    - **Spend Management Daily Hard Limit** - Credits used today against your daily hard limit. When the limit is reached, further usage is blocked until the next day.
    - **Available to Use** - This is the total number of credits available to you right now.

- **Invoice Address** section displays the company name for billing. You have a direct option to "Edit address" here.
- **Invoice Billing Email** section indicates the specific email address where invoices and billing correspondence should be sent. You can use the "Edit email" button to configure this and set a dedicated invoice notification.
- **The auto-recharge** section indicates if this feature is "Disabled" or "Enabled". There's a "Modify" button available to change this setting.
- **Spend Management** section shows whether this functionality is disabled or enabled for your team. There's a "Modify" button available to change this setting.

## Invoices

This is your **Invoices page,** located within the Billing section. It's designed to give you a clear overview of your payments and order history.

The page is organized into two main parts:

- **Payments Due:** This section is set up to list any outstanding payments. You will see columns for the Invoice Date, Invoice ID, Due Date, the Amount owed, and an Actions column for managing them.
- **Order and invoice history:** Below "Payments Due," this section is intended to display a record of your past orders and invoices. For each entry, you will find the Invoice Date, Invoice ID, Payment date, the Amount, and an Actions column.

## Payments Methods

This is your **Payment Methods page**, located within the Billing section. This is where you manage the payment options linked to your account.

The main part of the page is set up to display a list of your saved payment methods. For each card, you can see: **Credit Card** type and its last few digits, **Name on card, Expiring** date, **Status** column shows which card is the "Default Card." For other cards, a "Set as Default" button is available, allowing you to change your primary payment method.

Each listed card also has a delete icon (a trash can), giving you the option to remove a specific payment method.

To add a payment method, you have a clear call to action with the "**Add New Credit Card**" button on the right side of the screen.

## Spend Management

This is your **Spend Management page**, located within the Billing section. This page specifically allows you to control and monitor your organization's credit usage and expenses.

The page features several key components for managing your spending:

- A **Spend Management toggle switch** is at the top. When active, it allows you to set usage credit spend amounts, configure notifications, set up webhooks, and define budget limits.
- **Credits Consumed Today** and **Credits Consumed Yesterday** sections help you track your recent credit usage.
- **Set daily credit usage budget**. You can enter a dollar amount here. If your organization's usage exceeds this budget in a day (UTC), any new connections or API calls will be rejected until the end of that day.
- **Set a daily credit usage email notification threshold.** You can enter a dollar amount here. If your usage surpasses this threshold in a day (UTC), an email notification will be sent.
- **Set a webhook URL**. This allows you to provide a URL that will receive a POST request when a notification threshold or your budget amount is reached, enabling real-time alerts to your own systems or services.
- There's a "**Save Changes**" button at the bottom to apply any adjustments you make to these settings.

## Add Usage Credits

This is your **Add Usage Credits page**, located within the Billing section. This is where you can add funds to your account balance.

The page asks, "How much would you like to add to your balance?" and provides the following options to do so:

- **Payment amount:** You'll find an input field where you can enter the desired dollar amount. There's a note below it specifying that you should "Enter an amount between $5 and $5000."
- **Select a payment method:** There's a dropdown menu, currently showing "Select Method," which you can use to choose from your saved payment methods or via Cryptocurrency.
- **Add new payment method +:** Just below the dropdown, there's an option to "Add new payment method +" if you need to use a card not already on file.
- Finally, once you've entered the amount and selected a payment method, you can click the "**Add to my balance**" button to complete the transaction.

## Auto Recharge

This is your **Auto Recharge page**, located within the Billing section. Its purpose is to help you keep your service running without interruption by automatically adding funds to your account.

The page clearly explains the feature: "Keep your service running by setting up auto-recharge. When your balance reaches a certain threshold, we will automatically charge your card."

The main part of the page features:

- **Setting to Auto Recharge:** This includes a toggle switch. You can use this toggle to enable or disable the auto-recharge functionality.
- A "**Save changes**" button is present, which you can click to apply your choice regarding the auto-recharge setting.

## Invoice Address

This is your **Invoice Address page**, located within the Billing section. It's where you manage the address details used for your invoices. The page provides a form for your invoice address details:

- **Company Name:**
- **Address 1:**
- **Address 2:**
- **City:**
- **Postal code:**
- **Region/Province:**
- **Country:**
- **Purchase order (PO) number:**

After you've entered or updated your address information, you can click the "**Save changes**" button to apply them.

## Invoice Notifications

This is your **Invoice Notifications page**, located within the Billing section. Its purpose, as indicated by the "Billing email" heading and the accompanying note "Invoices and other billing notifications will be sent here," is to specify where your billing communications are directed. On this page, you'll find an "Email" input field, ready for you to enter or update the desired email address. Once you've provided the email, you click the "Updates" button to save this preference.

## Tax Settings

This is your **Tax Settings page**, located within the Billing section. It's designed to help you configure your tax information for accurate billing and compliance.

At the top right, you'll find an "**Add Tax Registration**" button, allowing you to include new tax details. Below this, the page displays a list of your current tax registrations in a table format. This table shows important details for each entry, including an Id, the Country, a Description (such as "European VAT number"), the specific tax Value or number, and its current Status: "unverified" with a red badge, or "verified" with a black badge.

## Balance History

This is your **Balance History page**, located within the Billing section.

The table below presents a detailed listing of all your balance transactions. Each row in this table provides an Id for the transaction, a Description (such as "Stripe Payment Intent... via Auto Recharge call.," "Applied credit balance to invoice," or "Free Trial Credits"), the Created Time showing the date and time of the transaction, and the Amount in USD. You'll notice that credits are shown as positive amounts, while debits are indicated with a negative value.

---

# Home (https://www.apibricks.io/platform/docs/general/customer-portal/home)

---
title: Home
description: Overview of the Customer Portal Home page, including quick actions and team management.
order: 9
---

# Home

This is your starting page when you log in. It gives you direct links to five common actions: You can generate an API key, invite team members, add a payment method, set up auto-recharge, and configure Spend Management.

Beneath these actions, the page displays a section titled "Your teams," where you can manage your current memberships. This area lists all the organizations you are a part of. Each organization is displayed with a button next to it. This button will either say "Select," allowing you to switch to that team, or "Current team," indicating the team you are actively using.

You also have the option to expand your collaborations by creating new teams. You'll find a "Create new team" link displayed directly under the "Your teams" heading. Additionally, at the very bottom of the list of your current organizations, there is a button also labeled "Create new team." The page also informs you of the total number of teams you are associated with.

---

# Customer Portal (https://www.apibricks.io/platform/docs/general/customer-portal)

---
title: Customer Portal
description: This section will cover the customer portal.
order: 8
---

## CoinAPI Customer Portal

### Overview

The API Management Console acts as a platform where you can manage all parts of your interaction with our API services. This platform offers useful tools and clear information to help you effectively use the service, manage costs and teams, handle payments, obtain API credentials, and request technical support.

### Navigation

To make it easy to find what you need, the Customer Portal is organized into these sections:

- **Home:** This is your starting page when you log in.
- **Billing:** Use this section to manage your account's finances.
- **Subscriptions:** Use this section to manage your subscription plans.
- **API Keys:** Use this section to manage your API keys.
- **Traces:** Use this section to monitor your API requests for troubleshooting and performance analysis.
- **Usage Metrics:** Use this section to view your API consumption.
- **Metered Usage:** Use this section to track specific billable actions.
- **Support tickets:** Use this section to submit questions and check the status of existing ones.
- **Quotas and Limits:** Use this section to understand your service limits.
- **Notifications:** Use this section to configure your notification preferences.
- **Account:** Use this section to manage your user profile, settings, and team members.

### Key Features

#### Subscription Management
- **View and Update Subscription Plans**: Easily view your current subscription details and upgrade or downgrade your plan as needed.
- **Billing Information**: Access and update your billing information, view invoices, and manage payment methods.

#### API Usage Monitoring
- **Real-Time Usage Stats**: Track your API calls in real-time to ensure you stay within your plan's limits.
- **Usage Reports**: Generate detailed reports on your API usage over specific periods to analyze and optimize your consumption.

#### API Key Management
- **Create and Manage API Keys**: Generate new API keys, deactivate old ones, and manage permissions to ensure your data is secure.
- **Key Usage Statistics**: Monitor the usage of individual API keys to identify any anomalies or optimize performance.

#### Support Resources
- **Knowledge Base**: Access a comprehensive knowledge base with detailed articles and guides to help you get the most out of CoinAPI.
- **Ticketing System**: Submit support tickets directly through the portal and track their status.
- **Contact Support**: Find various ways to contact our support team for personalized assistance.

### Benefits

- **Efficiency**: Centralized control over all account-related activities saves time and reduces administrative overhead.
- **Transparency**: Clear visibility into your API usage and billing helps you manage costs and prevent overages.
- **Security**: Advanced API key management features ensure your data and resources are protected.

### Getting Started

To access the CoinAPI Customer Portal, simply log in  at [Customer Portal Login](https://console.apibricks.io) and start managing your API services today.

---

# Metered Usage (https://www.apibricks.io/platform/docs/general/customer-portal/metered-usage)

---
title: Metered Usage
description: Track and understand your detailed service consumption with daily history, monthly statements, and uninvoiced usage views.
order: 15
---

# Metered Usage

This is your Metered Usage page, accessible through your console. It's designed to provide a transparent way for you to track and understand your detailed service consumption, which is particularly important as invoices offer a more summarized view due to fractional billing. This page also helps you monitor usage that, under the new billing rules, might not be invoiced immediately.

The page is organized into three main views:

- **Daily History:** This view is set up to provide a day-by-day breakdown of your service usage. Here, you can review your consumption patterns on a daily basis.
- **Monthly Statement:** This view offers a more detailed summary of your usage over an entire month, supplementing the summarized information on your main invoice. It provides a comprehensive record of your monthly consumption.
- **Uninvoiced Currently:** This section is designed to display any service usage that has accumulated but has not yet been formally invoiced. This is especially relevant as invoices are issued only after an actual payment (excluding free or promotional credits) is made. In this view, you can see all usage that is awaiting future invoicing, particularly if you are a new customer yet to make an initial payment.

## Daily History

**Daily History page is** located within the "Metered Usage" section. It provides a detailed breakdown of your daily usage for various services and any associated pay-as-you-go costs.

Here's what you'll find on this page:

- **Controls at the Top**:
    - **"Select range"**: A dropdown or button that allows you to choose the specific date for which you want to view the history.
    - **"Filter Product Name..."**: An input field where you can type to search for specific product names within the history list.
- **Usage Details Table**:
    - This table lists your metered usage with the following columns:
        - **Name**: The name of the service or product (e.g., "CoinAPI Market Data API").
        - **SKU Name**: The specific stock-keeping unit or item name (e.g., "Connections," "API Credits," "Data Transfer - Tier 1").
        - **Description**: Details about the item, often including the pricing structure (e.g., "$0.02 per Connection-Hour," "$5.26 / 1k for first 1,000 credits / day," or tiered pricing for credits).
        - **Total usage**: The total amount of the service used (e.g., "60.79 Hours," "1000 Credits," "32 GiB").
        - **Included usage**: The portion of the total usage that is covered by your plan's included allowances.
        - **PAYG usage**: The portion of the total usage that exceeds included allowances and falls under pay-as-you-go.
        - **PAYG Cost**: The cost associated with any pay-as-you-go usage
    - The table displays various entries, such as usage for API connections, different tiers of API credits, and data transfer.
- **Summary and Page Controls at the Bottom**:
    - **"Total pre-tax cost"**: Shows the sum of all pay-as-you-go costs for the selected period (e.g., "USD 0.00").

 ## Monthly Statement

**Monthly Statement page** is located within the "Metered Usage" section. This page provides a summary of your metered usage and any associated pay-as-you-go costs for a selected month.

Here's a breakdown of what you'll find on this page:

- **Controls at the Top**:
    - **"Year" dropdown**: Allows you to select the year for the statement.
    - **"Month" dropdown**: Allows you to select the month for the statement.
    - **"Filter Product Name..."**: An input field where you can type to search for specific product names within the statement.
- **Usage Details Table**:
    - This table lists your metered usage for the selected month with the following columns:
        - **Name**: The name of the service or product (e.g., "CoinAPI Market Data API").
        - **SKU Name**: The specific stock-keeping unit or item name (e.g., "Connections," "API Credits").
        - **Description**: Details about the item, often including the pricing structure (e.g., "$0.02 per Connection-Hour," or tiered rates like "$5.26 / 1k for first 1,000 credits / day").
        - **Total usage**: The total amount of the service used during the selected month (e.g., "3157.843 Hours," "27000 Credits").
        - **Included usage**: The portion of the monthly total usage covered by your plan's included allowances.
        - **PAYG usage**: The portion of the monthly total usage that exceeds the included allowances.
        - **PAYG Cost**: The cost associated with any pay-as-you-go usage for the month.
    - The table displays various entries, reflecting accumulated monthly usage for items like API connections and different tiers of API credits.
- **Summary and Page Controls at the Bottom**:
    - **"Total pre-tax cost"**: Shows the sum of all pay-as-you-go costs for the selected month.

## Uninvoiced Currently

**Uninvoiced Currently page** is located within the "Metered Usage" section. This page shows you a real-time or very recent overview of your metered usage that has accumulated since your last invoice and has not yet been billed.

Here's what you'll find on this page:

- **Controls at the Top**:
    - **"Filter Product Name..."**: An input field where you can type to search for specific product names within the list of uninvoiced items.
- **Usage Details Table**:
    - This table lists your current uninvoiced usage with the following columns:
        - **Name**: The name of the service or product (e.g., "CoinAPI Market Data API").
        - **SKU Name**: The specific stock-keeping unit or item name (e.g., "Connections," "API Credits").
        - **Description**: Details about the item, often including the pricing structure (e.g., "$0.02 per Connection-Hour," or tiered rates like "$5.26 / 1k for first 1,000 credits / day").
        - **Total usage**: The total amount of the service used so far in the current uninvoiced period (e.g., "29748.429 Hours," "250000 Credits").
        - **Included usage**: The portion of this current usage that is covered by your plan's included allowances.
        - **PAYG usage**: The portion of the current usage that exceeds included allowances and would be billable on a pay-as-you-go basis.
        - **PAYG Cost**: The potential cost associated with any current pay-as-you-go usage.
    - The table displays various entries, reflecting your accumulated usage for items like API connections and different tiers of API credits up to the current point in your billing cycle.
- **Summary and Page Controls at the Bottom**:
    - **"Total pre-tax cost"**: Shows the sum of all potential pay-as-you-go costs for the current uninvoiced period (e.g., "USD 0.00").

---

# Notifications (https://www.apibricks.io/platform/docs/general/customer-portal/notifications)

---
title: Notifications
description: Manage your notification preferences and view alerts related to your account activity and services.
order: 18
---

# Notifications

This is your Notifications page, where you can manage your preferences and view alerts related to your account activity and services.

## My Settings

This is your **Settings page**, located within the "Notifications" section. This page allows you to customize a wide array of notification preferences across different categories, each controlled by a simple toggle switch - ON and OFF.

Here are the available notification settings, organized by section:

- **Technical Issues**
    - **API Key Authorization Rejected**: "Notify me when authorization using API Key will be rejected."
- **Subscription Quota Usage**
    - **Subscription Quota Used 75% Threshold**: "Notify when any current quota from subscription will exceed 75% threshold, no more than once per calendar month per organization."
    - **Subscription Quota Exceeded 100% Threshold**: "Notify when any current quota from subscription will exceed 100% threshold, no more than once per calendar month per organization."
- **Spend Management**
    - **Spend Management Notify Limit**: "When Spend Management Notify Limit is enabled, then include me as user who should be notified when the limit is hit, no more than once per day."
    - **Spend Management Hard Limit**: "When Spend Management Hard Limit is enabled, then include me as user who should be notified when the limit is hit, no more than once per day."
- **Subscriptions**
    - **Subscription Created**: "Notify me when the subscription is created on my organization account."
    - **Subscription Updated**: "Notify me when the subscription is updated on my organization account."
    - **Subscription Cancelled**: "Notify me when the subscription is cancelled on my organization account."
    - **Subscription Terminated**: "Notify me when the subscription is terminated on my organization account."
    - **Subscription Reactivated**: "Notify me when the subscription is reactivated on my organization account."
- **Invoices**
    - **Invoice Created**: "Notify me when new invoice is created."
    - **Invoice Paid**: "Notify me when new invoice is paid."
    - **Invoice Payment Failed**: "Notify me when payment failed on the invoice."
    - **Invoice Voided**: "Notify me when the invoice was voided."
- **Notifications**
    - **Notification Settings**: "Notify me when organization notification email settings will change."
- **API Usage Credits**
    - **Credits Auto-recharge Failed**: "Notify me when auto-recharge of the credits is enabled and will fail."
    - **Credits Balance Low**: "Notify me when credits balance will fall below 10 USD."
    - **Credits Added**: "Notify me when credits were added on the organization account, either via the auto-recharge, manually or via other methods."

## Additional Emails

**Additional Emails page** is located within the "Notifications" section. This page allows you to specify additional email addresses that will receive various types of notifications, in addition to those sent to team members based on their individual preferences. You can provide multiple emails in each field, separated by commas (,) or semicolons (;).

Here are the different email notification categories you can configure:

- **Billing Notifications Email**:
    - This is where invoices and other billing-related notifications will be sent. It's useful for routing these communications to a specific department or an invoice management system.
- **All Non-Billing Notifications Email**:
    - All notifications that are not billing-related will be sent to the address(es) specified here. This can help consolidate non-billing alerts, for example, by sending them to a dedicated Slack channel that has a unique email address.
- **Action Required Notifications Email**:
    - Notifications that require your action will be sent to the email(s) listed in this field. This is beneficial for centralizing urgent alerts, potentially routing them to services like PagerDuty or a specific Slack channel.

After entering or updating the email addresses in the respective fields, you would click the **"Save changes"** button at the bottom of the page to apply your configurations.

## History page

**History page** is located within the "Notifications" section. This page provides a log of all the notifications that have been sent, allowing you to review past alerts and communications.

Here's what you'll find on this page:

- **Controls at the Top**:
    - **"Filter Subject..."**: An input field that lets you search through the notification history by the subject line.
- **Notification History List**:
    - A table displays the record of sent notifications with the following details for each entry:
        - **Timestamp**: The date and time when the notification was sent.
        - **Email ID**: A unique identifier for the specific email notification that was sent.
        - **Subject**: The subject line or a brief description of the notification's content (e.g., "Credits Added to your Org," "Invoice has been paid" or "Alert: Contact notification email changed").

---

# Quotas and Limits (https://www.apibricks.io/platform/docs/general/customer-portal/quotas-limits)

---
title: Quotas and Limits
description: View the various usage limits and quotas applied to different products and services.
order: 17
---

# Quotas and Limits

This is your **Limits page**, where you can view the various usage limits and quotas applied to different products and services.

At the top of the page, you'll find a "Filter Name..." input field, allowing you to search for specific limits. The main section displays a table that lists these limits in detail.

For each item, the table shows the **Product** it belongs to (such as "MarketData"), the **Name** of the specific limit (like "API Credits" or "Data Transfer - Tier 1"), and its **Type**. You'll also see a visual **Usage** indicator (a progress bar), the **Current Usage** amount, "Your Quota", and the "Default Quota."

---

# Subscriptions (https://www.apibricks.io/platform/docs/general/customer-portal/subscriptions)

---
title: Subscriptions
description: Manage your subscription plans, payment methods, and invoice history.
order: 11
---

# Subscriptions

This is your **Subscription Management Portal**. On the left side, a navigation pane displays the portal's name and a link allowing you to return to the main page.

The main content area on the right provides details about your subscription and billing. At the top, the "**Current Subscription**" section shows your current subscription plan and associated costs. It also informs you when your subscription will be renewed.

To change the subscription plan, you have an "Update subscription" button and an option to "Cancel subscription."

Below this primary section, you will find:

- **Payment Methods:** This area lists your registered payment options. A link to "+ Add payment method" is available for including new payment details.
- **Invoice History:** This section contains a chronological list of your past invoices. Each entry specifies the invoice date, total amount, and payment status.

---

# Support Tickets (https://www.apibricks.io/platform/docs/general/customer-portal/support-tickets)

---
title: Support Tickets
description: View, manage, and create support requests through the Customer Portal.
order: 16
---

# Support Tickets

This is your **Support tickets page**, the central place for viewing and managing all your support requests, as well as creating new ones.

At the top of the page, you'll find an input field labeled "Filter Subject..." which allows you to quickly search for specific tickets. Alongside this, there's an "Add New Ticket" button, enabling you to submit a new support request.

The main area of the page displays a comprehensive list of your support tickets. For each ticket, you can see:

- **ID**: A unique identification number for the ticket.
- **Subject**: A brief description of the issue or query.
- **Created**: The date and time when the ticket was originally submitted.
- **Last activity**: The date and time of the most recent update or communication.
- **Severity**: Indicates the impact level of the issue, with a numerical rating.
- **Status**: The current state of the ticket.

---

# Traces (https://www.apibricks.io/platform/docs/general/customer-portal/traces)

---
title: Traces
description: Monitor, analyze, and debug your API calls with detailed request and connection traces.
order: 13
---

# Traces

## Traces Requests

This is your **Traces Requests page**, located within the "Traces" section. It is a tool for monitoring, analyzing, and debugging your API calls. It provides a detailed overview of your API request and response activity.

On the left side of the page, you have filtering options to narrow down the traces.

You can filter by **Time**, with choices:

- "Last 5 minutes"
- "Last 15 minutes"
- "Last 1 hour"
- "Last 4 hours"
- "Last 24 hours"

You can filter by **HTTP Status**, including:

- "All"
- "Success"
- "Client Error"
- "Server Error"

The main area on the right, titled "Traces Requests," displays the list of API call traces. Here, you'll find an "**Export data**" button to download the trace information and a field to "Filter Method..." if you're looking for specific API methods.

The table itself shows key details for each API call: the **Timestamp (UTC)** when the call was made, the **Method** used, the **Product** accessed, the **HTTP** status code, and the **Response time**.

You can click on a specific trace entry to see a detailed JSON view with more granular information so so-called "**Request Trace".** It's the kind of in-depth view you'd access when investigating a particular trace from the main list.

### Request Trace

At the top, under "Connection Details," you get a quick summary with cards showing the **HTTP Route** (e.g., `v1/ohlcv/symbol_id/history`), the **HTTP Method** (e.g., `GET`), and the **HTTP Status Code** (e.g., `200`).

Below this summary, the page lists numerous specific details about the trace. This includes the **Timestamp** of the request, a unique **Trace ID**, the **Span Name**, and the **Service Name** like "MarketDataAPI/REST." A significant field is **Span Attributes**, which displays a JSON block containing many raw request and response parameters, including the API key used and target details. Further down, you'll find more parsed information such as the request **Duration**, the specific **HTTP Target** and full **HTTP URL**, the **HTTP Flavor**, the **API Key** involved, the **NET Host Name**, the **HTTPScheme**, and the **ID Organization**. Some details like the HTTP method, route, and status code are repeated here from the summary cards for comprehensive reference.

### Traces Connections

This is your **Traces Connections page**, located within the "Traces" section. This page provides an overview of service connections, detailing their activity and status.

At the top, you have a field to "Filter Service Name..." if you need to find connections related to a specific service.

The main part of the page displays a table listing these connections. Each entry in the table shows a unique **Connection ID**, the **Service Name** (e.g., "MarketData"), the **Protocol Name** (e.g., "WebSocket"), the **Start Time** and **End Time** of the connection, and the current **Status**. The status is clearly indicated, showing whether a connection is "Connected" or "Disconnected," highlighted with a badge.

---

# Usage Explorer (https://www.apibricks.io/platform/docs/general/customer-portal/usage-explorer)

---
title: Usage Explorer
description: Visualize and analyze operational data points with filtering and grouping capabilities.
order: 14
---

# Usage Explorer

This is your **Usage Explorer page**, a dashboard that helps you visualize and analyze various operational data points. The system uses parameters to identify where usage occurred, allowing you to break down metrics effectively.

On the left side, you'll find a panel with several filters to customize the data you see. Each metric can contain a single value. Parameters are used to identify where the usage occurred.

- **Metric Selection -** this dropdown allows you to choose the primary data point for analysis:
    - "Data Messages Received (count)"
    - "Data Messages Received (sent)"
    - "Data Bytes Received (bytes)"
    - "Data Bytes Sent (bytes)"
    - "Connection Time (connection-seconds)"
    - "API Calls (count)"
    - "API Calls Received (count)"
    - "API Calls Sent (count)"
    - "Market Data API REST Credits (credits)"
- **Group By -** this dropdown lets you categorize or group the selected metric for:
    - "DataCenter" - Location where the usage metric was created (e.g. `AWS-EU-EAST-1` etc)
    - "ProtocolName" - he name of the protocol that was used to generate the metric (e.g. `REST`, `WebSocket`, `FIX`, `S3`)
    - "ServiceName" - The name of the product (e.g. `MarketData`)
- **API Keys -** helps separate usage by the specific API Key that initiated the activity.
    - You can filter by "All API keys," or select specific keys
- **Data Center -** filters metrics by the location where the usage occurred (e.g., a specific server facility). Includes "All data centers" or specific locations like "HQ-5" and "DP-AP-NORTHEAST-TY." A search and "Select All" are also available.
- **Data Source -** isolates usage related to a particular data source (e.g., a specific exchange or blockchain).
- **Operation Name -** filters by the specific ID that identifies operations within a Service and Protocol (this is often a Data Type or a specific method call). Search and "Select All" functionalities are present.
- **Protocol Name -** allows you to select metrics based on the communication protocol used:
    - "REST"
    - "WebSocket"
    - "FIX"
- **Service Name -** Filters metrics by the specific product.
    - "Market Data"
    - "ExchangeRates"
    - "FinFeedStockAPI"
    - "NAAS"
    - "Indexes"
    - "EMS"

**The main area on the right displays the selected metrics:**

- **Time Range Selection**:
    - You can quickly select a time frame using buttons like **1H, 6H, 1D, 3D, 1W, 2W, 1M**.
    - A **"Select range"** field is also available for choosing a custom date and time period.
- **Metrics Chart**:
    - A bar chart visually represents the selected metric over the chosen time.
- **Summary Table**:
    - Below the chart, a table summarizes the data.

---

# Understanding Usage Credits, Committed Plans, and Overage Billing (https://www.apibricks.io/platform/docs/general/how-credits-work)

---
title: "Understanding Usage Credits, Committed Plans, and Overage Billing"
description: "Learn how Usage Credits work across API Bricks products, how committed plans apply discounts, and how usage over plan limits is billed."
order: 6
---

# Understanding Usage Credits, Committed Plans, and Overage Billing

API Bricks products use **Usage Credits (UC)** as the billing unit for API usage.

This guide explains how Usage Credits work, how committed plans apply discounts, and how overage billing works across API Bricks products.

:::note
This article explains the general Usage Credit model used across API Bricks products. Product-specific pricing, usage types, limits, and rates may differ by product.
:::

## What are Usage Credits?

**Usage Credits**, or **UC**, are the credits consumed when your organization uses API Bricks products.

Depending on the product, usage may be based on different units, such as:

- API calls
- Rates
- Data transfer
- REST Credits
- WebSocket data transfer
- Flat Files requests
- Flat Files data downloads
- Connection-Hours for certain protocols

The product pricing page defines how each type of usage is converted into Usage Credits.

## Pay As You Go credits

With **Pay As You Go**, credits are purchased at the standard rate:

| Plan | Price per Credit |
|---|---:|
| Pay As You Go | $1.00 / Credit |

This means that if your usage consumes **100 UC**, the Pay As You Go cost is **$100** before applicable taxes or fees.

Pay As You Go is usually best for:

- Testing
- Occasional usage
- Unpredictable usage
- One-time downloads or backfills
- Customers who are not ready to commit to a monthly plan

## How committed plans work

Committed plans allow you to purchase Usage Credits at a lower effective price per credit.

For example:

| Plan | Price per Credit | Monthly price | Approx. included credits |
|---|---:|---:|---:|
| Committed 64 | $0.85 / Credit | $64/month | ~75.29 UC |
| Committed 256 | $0.75 / Credit | $256/month | ~341.33 UC |
| Committed 512 | $0.70 / Credit | $512/month | ~731.43 UC |
| Committed 1024 | $0.65 / Credit | $1,024/month | ~1,575.38 UC |

The lower the **price per Credit**, the more Usage Credits you receive for the same dollar amount.

For example, with the **Committed 256** plan:

**$256 ÷ $0.75 per Credit = ~341.33 UC**

This means you pay **$256** and receive approximately **341.33 Usage Credits**.

## Why usage is shown in UC

The portal shows usage in **Usage Credits** because API usage is billed against the organization’s UC balance.

For example, a product may show usage such as:

| Usage type | Example metered usage |
|---|---:|
| Data transfer | 1 UC per GiB |
| API calls | 10 UC per 1,000 requests |
| Rates | Based on daily rate tiers |

This does not mean the committed discount was ignored.

The usage meter shows how many credits were consumed. The discount is applied when credits are purchased through a committed plan at a lower price per credit.

## Example: Usage within the plan limit

Assume you are on the **Committed 256** plan.

The plan costs:

**$256/month**

The price per Credit is:

**$0.75/Credit**

Included credits:

**$256 ÷ $0.75 = ~341.33 UC**

Now assume your usage for the month is:

**300 UC**

Since the plan includes approximately **341.33 UC**, the usage is fully covered:

**341.33 UC included - 300 UC used = 41.33 UC remaining**

There is no additional Pay As You Go usage in this example.

## Example: Usage above the plan limit

Assume you are on the same **Committed 256** plan.

Included credits:

**~341.33 UC**

Now assume your usage for the month is:

**500 UC**

The plan covers the first **341.33 UC**.

The remaining usage is:

**500 UC - 341.33 UC = 158.67 UC overage**

Usage above the included plan credits is billed as additional Pay As You Go usage at the standard rate of:

**$1.00/Credit**

So the estimated monthly cost is:

**$256 plan cost + $158.67 overage = $414.67**

## Why the portal may still show the full usage amount

The portal may show the full metered usage, such as:

**500 UC consumed**

This is expected.

It means your organization consumed **500 Usage Credits**. It does not mean the committed plan discount was ignored.

The plan discount is reflected in how much you paid for the included credits. For example, under the Committed 256 plan, you received approximately **341.33 UC** for **$256**, instead of buying those credits at the standard Pay As You Go rate.

## How overage works

Overage happens when your usage exceeds the credits included in your committed plan.

For example:

| Item | Value |
|---|---:|
| Included plan credits | 341.33 UC |
| Monthly usage | 500 UC |
| Overage | 158.67 UC |

The overage is billed as additional Pay As You Go usage at:

**$1.00/Credit**

If your usage regularly exceeds your committed plan, a larger committed plan or an Enterprise plan may be more cost-effective.

## Product-specific usage units

Usage Credits are used globally, but each product may measure usage differently.

Examples:

| Product type | Common usage units |
|---|---|
| Market Data API | REST Credits, WebSocket Tier 1 data, WebSocket Tier 2 data, FIX Connection-Hours |
| Exchange Rates API | Rates via REST or WebSocket |
| Currencies API | Rates via REST or WebSocket |
| Indexes API | API calls and WebSocket data transfer |
| Prediction Markets API | API calls |
| SEC API | Data transfer |
| Stock API | Data transfer |
| Flat Files | Data transfer and API requests such as GET, HEAD, and LIST |

Always check the product pricing page for the exact usage model and rates.

## Daily tiers and committed plans

Some products use daily pricing tiers.

This means the unit price may decrease as daily usage increases.

For example, a product may have pricing tiers such as:

- First usage tier
- Next usage tier
- Higher-volume usage tier

Usage paid with committed credits still counts toward daily pricing tiers.

This means committed plans and daily tiered pricing can work together:

1. Product usage is calculated according to the product’s pricing rules.
2. Daily tiers are applied where applicable.
3. Usage consumes credits from the organization’s balance.
4. If included committed credits are exhausted, remaining usage is billed as Pay As You Go.

## Choosing the right committed plan

A good rule of thumb is to choose the plan where your expected monthly usage is close to the included credits.

| Expected usage pattern | Suggested option |
|---|---|
| One-time or unpredictable usage | Pay As You Go |
| Low recurring usage | Committed 64 |
| Moderate recurring usage | Committed 256 |
| Higher recurring usage | Committed 512 or Committed 1024 |
| Very high or custom usage | Enterprise |

Committed plans are usually most useful when your usage is predictable and recurring.

## Before choosing a plan

Before subscribing to a committed plan, estimate:

1. Which product you plan to use
2. Which endpoints, datasets, or protocols you will use
3. Your expected daily or monthly usage
4. Whether usage is one-time or recurring
5. Whether the workload may produce overage
6. Whether your tools may generate additional requests or data transfer

For Flat Files or S3-compatible downloads, also consider whether your tool performs extra operations such as LIST, HEAD, retries, or multipart downloads.

## Common questions

### Why does usage show in UC instead of USD?

Usage is billed against your organization’s Usage Credit balance. The portal shows how many credits were consumed.

### Does a committed plan lower each usage line item?

Not always. The usage line item may still show the standard metered UC usage. The committed discount is applied through the lower price paid per Credit.

### What happens if I use more than my included credits?

Usage above the included plan credits is billed as Pay As You Go at **$1.00/Credit**.

### What happens if I use less than my included credits?

Committed plans are designed for predictable recurring usage. If your usage is much lower than the included credits, Pay As You Go or a smaller committed plan may be a better fit.

### Do committed credits apply across products?

Committed credits are applied according to the product and organization billing configuration. Check the applicable product pricing page or your organization billing settings for details.

### Are taxes or fees included in the examples?

No. Pricing examples usually show estimated usage before applicable taxes, fees, or other invoice-level adjustments.

## Summary

Usage Credits are the billing unit used across API Bricks products.

Key points:

- Usage is measured in **Usage Credits (UC)**.
- Pay As You Go credits are priced at **$1.00/Credit**.
- Committed plans let customers purchase credits at a lower price per Credit.
- The portal shows how many UC were consumed.
- The committed discount is applied through the lower price paid per Credit.
- Usage above included committed credits is billed as Pay As You Go.
- Product-specific usage rules still apply, such as API calls, rates, data transfer, or Connection-Hours.
- For best results, estimate expected usage before choosing a committed plan.

---

# Referral and request referer (https://www.apibricks.io/platform/docs/general/referral)

---
title: Referral and request referer
description: How a referral code on any site link is recorded, and how a product API request can send a custom referer.
order: 7
---

# Referral and request referer

A referral value is an organization id or a custom code. A custom code is 8 to 32 lowercase letters and can be set once.

## Referral link

Add the `ref` query parameter to any URL on [www.apibricks.io](https://www.apibricks.io), [www.coinapi.io](https://www.coinapi.io), or [www.finfeedapi.com](https://www.finfeedapi.com). It works on the site root and on any other path.

`https://www.apibricks.io/?ref=your-ref-code`

`https://www.coinapi.io/products/market-data-api?ref=your-ref-code`

`https://www.finfeedapi.com/?ref=your-ref-code`

Opening that URL records the visit with the browser device id. An organization created later from that browser, after the visit, is attributed to the code. The sites do not copy `ref` onto other links. Put it on the URL you share.

## API request

A product API request can send the same organization id or custom code in a referer header.

- Send `X-Referrer: your-ref-code`, or `X-Referer: your-ref-code`.
- If both headers are present, `X-Referrer` is the value that is stored.
- If neither custom header is present, the standard `Referer` header is used.
- Requests without a referral value are served as usual.
- Any other header value is stored the same way. `your-ref-code` is the example value.

A successful request is an HTTP 200 response, or HTTP 101 when the WebSocket upgrade completes. In a UTC month, usage attribution applies when the code is on more than 51% of that organization's successful API requests. Exactly 51% does not qualify.

Breaking changes are announced in the [CoinAPI changelog](./changelogs/coinapi) and the [FinFeedAPI changelog](./changelogs/finfeedapi) before they ship.

---

# Security and Compliance (https://www.apibricks.io/platform/docs/general/security)

---
title: Security and Compliance
description: Comprehensive overview of CoinAPI's security measures, compliance standards, and authentication methods.
order: 3
---

# Security and Compliance

CoinAPI prioritizes the security and compliance of its platform, implementing robust measures to protect user data and ensure seamless integration with various environments. This article provides an overview of our security mechanisms, access controls, and compliance standards.

## Application Layer Protection

CoinAPI employs multiple security mechanisms to protect the application layer exposed to the internet:

- **TLS Encryption**: All communications are encrypted using TLS 1.2 (AES-256) or higher, ensuring data confidentiality during transmission and preventing man-in-the-middle attacks.
- **API Key Authentication**: A fundamental method for authenticating and controlling access to CoinAPI services.
- **JWT Token Authentication**: An extended security measure combining API keys with JWT tokens for enhanced protection.
- **TLS Client Certificates**: Used for authenticating FIX sessions and Managed Cloud REST API access.

Rationale: These layered security measures provide robust protection against unauthorized access, data interception, and man-in-the-middle attacks. TLS encryption, in particular, ensures that data transmitted between the client and server remains confidential and tamper-proof, making it extremely difficult for malicious actors to intercept or modify the communication.

## Access Restriction Methods

CoinAPI supports various methods to restrict platform access by source IP for Enterprise plan customers:

1. **IP Whitelisting**: Configure your account to allow access only from specific IP addresses.
2. **Web Application Firewall (WAF)**: Filter and monitor HTTP requests based on IP addresses.
3. **Security Groups**: For cloud-hosted services, use security groups to restrict access to specific IP ranges.

Rationale: These methods provide flexible options for organizations to implement strict access controls based on their specific security requirements. By offering these features exclusively to Enterprise customers, CoinAPI ensures that high-security environments have access to advanced protection measures.

Note: Access restriction methods are currently available only for Enterprise plans. Please contact our sales team for more information on upgrading to an Enterprise plan to access these features.

## Role-Based Access Control

CoinAPI implements role-based access control within the Customer Portal:

1. **Admin Role**:
   - Same capabilities as the account owner
   - Can add subscriptions, edit billing information, and manage users
   - Full access to Customer Portal administrative functions

2. **User Role**:
   - Can log in to the Customer Portal
   - View account usage and track metrics
   - Limited capabilities compared to Admins

Rationale: This role-based system ensures that users have appropriate access levels based on their responsibilities, adhering to the principle of least privilege.

## Integration and Authentication

For integration with external environments:

- **Principle of Least Privilege**: CoinAPI provides various authentication methods that do not require administrative privileges.
- **Mutual TLS (mTLS) Support**: Available for secure, authenticated communication between clients and servers. This feature is exclusive to Enterprise plan customers.

Rationale: These practices ensure secure integration while minimizing potential security risks associated with over-privileged access. The availability of mTLS for Enterprise customers provides an additional layer of security for organizations with stringent authentication requirements.

Note: Mutual TLS (mTLS) support is currently available only for Enterprise plans. If you require this feature, please contact our sales team for information on upgrading to an Enterprise plan.

## Encryption and Key Management

CoinAPI utilizes robust encryption and key management practices:

- **Cryptographic Module**: Uses Google Cloud Platform (GCP) Cloud Key Management Service (KMS) for key management.
- **Secure Key Storage**: Encryption keys are not stored in clear text, and full keys are not accessible in the customer portal.

Rationale: These measures provide industry-standard protection for sensitive data and encryption keys.

## User Credential Security

CoinAPI employs robust security measures for user authentication and credential protection:

- **Password Hashing**: We use Firebase Authentication, which implements an internally modified version of scrypt to hash account secrets. This provides strong protection against password cracking attempts.
- **Automatic Rehashing**: Even if an account is initially uploaded with a password using a different algorithm, Firebase Auth automatically rehashes the password using its secure method upon the first successful login.
- **Passwordless Options**: CoinAPI supports various authentication methods that don't require storing passwords, including:
  - Magic link authentication
  - Google authentication
  - GitHub authentication
- **Channel Encryption**: TLS 1.2 (AES-256) or higher is used for all data transmission and system console access.

Rationale: By leveraging Firebase Authentication's secure hashing methods and offering passwordless authentication options, CoinAPI significantly reduces the risk of password-related vulnerabilities. The automatic rehashing feature ensures that all passwords are protected using the most secure method available, even if they were initially set using a different algorithm. Additionally, the support for passwordless authentication methods further enhances security by eliminating the need to store passwords for users who choose these options.

## Data Protection and Privacy

CoinAPI implements additional measures to protect sensitive data:

- **Data Obfuscation and Masking**: Sensitive data accessed via our API is obfuscated and masked to prevent unauthorized exposure.
- **Secure Data Handling**: We employ industry-standard practices to ensure that sensitive information is protected throughout its lifecycle.

Rationale: By obfuscating and masking sensitive data, CoinAPI adds an extra layer of protection against potential data breaches or unauthorized access. This practice helps maintain user privacy and complies with data protection regulations.

## Data Segregation and Audit Trails

- **Dedicated Infrastructure**: Available as part of the Enterprise solution or as an additional service.
- **Logical Segregation**: Implemented through unique identifiers and access controls.
- **Immutable Audit Trails**: CoinAPI does not allow modifications to audit trails.
- **Audit Trail Access**: Can be made available within 7 business days and exposed via API for integration with external systems.

Rationale: These features ensure data isolation between customers and maintain the integrity of audit logs for compliance and security purposes.

## Conclusion

CoinAPI's comprehensive security and compliance measures demonstrate our commitment to protecting user data and supporting seamless integration with various enterprise environments. By implementing industry-standard security practices and offering flexible configuration options, CoinAPI provides a secure and reliable platform for cryptocurrency data and trading services.

---

# Throttling requests (https://www.apibricks.io/platform/docs/general/throttling)

---
title: Throttling requests
description: This section provides comprehensive information about request throttling in CoinAPI products. It covers the fundamental aspects and procedures involved in managing request rates and quotas. Whether you're new to CoinAPI or seeking to enhance your understanding of throttling mechanisms, this section will provide you with a valuable overview of the topic.
order: 4
---

# CoinAPI Throttling Process

## Overview

CoinAPI implements a sophisticated throttling process to ensure fair usage and protect our services from being overwhelmed by too many requests. This document outlines the key aspects of our throttling mechanism, focusing on rate limiting, quota management, and how these apply across our product suite.

## Handling Throttling During Scaling

While CoinAPI is scaling to meet your higher request rate, you may encounter throttling. Here's how to handle it:

1. **Implement Exponential Backoff**: When receiving a 429 error, use an exponential backoff strategy to retry the request.
2. **Monitor Error Rates**: Keep track of the 429 errors you receive and adjust your request rate accordingly.
3. **Distribute Requests**: Spread your requests evenly over time to avoid sudden spikes that may trigger throttling.

It's important to note that in the case of a 429 error, we will initiate scaling to accommodate your increased request rate. However, this scaling process, for both read and write operations, occurs gradually and is not instantaneous. During this scaling period, you may encounter 429 (Too Many Requests) errors. These errors will dissipate once the scaling is complete.

When you receive a 429 error, we will provide a `Retry-After` header in the response. This header contains the number of seconds you should wait before making another request. It's crucial to respect this value to avoid further throttling and to allow the scaling process to complete effectively.

Some endpoints are being scaled aggressively, which may prevent them from encountering a 429 error entirely. The behavior can vary between endpoints due to differences in infrastructure, data types, and load distribution.

## Performance Considerations

### High-Volume Data Processing

Some applications using CoinAPI may need to process large volumes of data. These applications can achieve high transfer rates by:

- Utilizing powerful compute resources (e.g., high-performance cloud instances)
- Implementing efficient data processing algorithms
- Aggregating throughput across multiple instances for processing terabytes of data

### Latency-Sensitive Applications

For applications requiring low-latency responses, such as real-time trading platforms:

- CoinAPI aims to provide consistent latencies of approximately 100-200 milliseconds for small data requests
- Larger data requests may have slightly higher latencies, but with quick first-byte-out times

### Accelerating Performance

To further enhance performance for specific use cases:

1. **Content Delivery Networks (CDNs)**: Implement a CDN to cache frequently accessed data closer to your users.
2. **In-Memory Caching**: Use in-memory caching solutions to reduce latency for frequently accessed data.
3. **Optimized Network Routes**: Consider using services that optimize data transfer over long distances if your application is geographically distributed.

## Best Practices for Optimizing CoinAPI Performance

1. **Efficient Data Retrieval**: Request only the data you need by using appropriate API endpoints and query parameters.
3. **Compression**: Enable compression in your API requests to reduce data transfer sizes.
4. **Connection Reuse**: Implement connection pooling in your application to reuse HTTP connections.
5. **Asynchronous Processing**: Use asynchronous programming techniques to handle multiple API requests efficiently.
6. **Error Handling**: Implement robust error handling and retry mechanisms to manage temporary service disruptions.

By following these guidelines and best practices, you can optimize your application's performance when using CoinAPI, ensuring efficient data retrieval and processing even at high volumes.

---

# Usage Credits System (https://www.apibricks.io/platform/docs/general/usage-credits)

---
title: Usage Credits System
description: This section provides comprehensive information about the usage credits system in CoinAPI products. It covers the fundamental aspects of acquiring, managing, and utilizing usage credits across various scenarios. Whether you're new to CoinAPI or seeking to enhance your understanding of our billing and credit system, this section will provide you with a valuable overview of the topic.
order: 5
---

# CoinAPI Usage Credits System

## Overview

CoinAPI implements a flexible usage credits system to provide customers with various options for accessing and paying for our services. This document outlines the key aspects of our usage credits mechanism, focusing on acquisition methods, usage, and billing across our product suite.

## Acquiring Usage Credits

Usage credits can be obtained through several methods:

1. **Promotions and Free Trials**: CoinAPI occasionally offers promotional credits or free trial periods to new or existing customers. Every qualified organization receives $25 USD in credits. To be considered qualified, the organization must not be a duplicate of an existing organization.

2. **Manual Purchase**: Customers can buy credits directly through the Customer Portal using either cryptocurrency or fiat currency.

3. **Auto-Recharge Feature**: This automated system adds service credits using the account's payment methods when the balance falls below a certain threshold, bringing it back to a specified level.

4. **Sales Order Form**: Customers can request an order form from our sales team to acquire usage credits, which may include special pricing or terms.

It's important to note that usage credits are generally not limited to specific products unless they were acquired through a sales order form (method 4). In such cases, credits purchased at a discount may be restricted to use with specific products.

## Spend Management System

CoinAPI has implemented a comprehensive spend management system to replace the previous pay-as-you-go option. This system provides customers with greater control over their usage and expenses. Here are the key features:

1. **Credit Usage Tracking**:
   - View your daily credit consumption
   - See credits consumed today and yesterday

2. **Daily Credit Usage Budget**:
   - Set a daily budget limit for credit usage
   - If exceeded, new connections and API calls will be rejected until the end of the day (UTC)

3. **Notifications**:
   - Set a customizable daily credit usage threshold
   - Receive email notifications when the threshold is exceeded
   - Configure a webhook URL for real-time notifications:
     - Receive a POST request when a specified credit amount is reached
     - Set up separate webhooks for hard limits and notify limits
     - Integrate with services like PagerDuty to alert your organization's team
   - Webhook payload includes detailed information about the limit reached, current usage, and other relevant data

4. **Webhook Integration**:
   - Configure a webhook URL
   - Receive a POST request when a specified credit amount is reached

These features provide greater visibility and control over your credit usage, helping you manage your expenses more effectively.

## Usage Limit Enforcement

Due to the distributed nature of our system, there are some important considerations regarding usage limit enforcement:

- We check usage limits every 1 minute.
- It's possible that during this interval, usage may temporarily exceed the set limit.
- We strive to reject requests exceeding your plan limits or spend management thresholds as quickly as possible, typically within a short period after the limit is reached.
- Please note that there might be a brief period where usage above the limit is possible before restrictions are applied.
- This applies to both subscription plan limits and spend management features like daily credit usage budgets.

These characteristics are important to keep in mind when managing your usage and configuring spend controls.

## Subscription and Quota Interaction

Subscriptions typically grant certain features or usage quotas. Usage beyond these quotas is managed through the spend management system. For example:

- If an organization has a subscription quota of 50,000 credits
- The spend management system allows setting daily budgets and thresholds beyond this quota
- Usage above the quota will be deducted from the available credit balance, subject to the configured spend management settings

## Taxation and Expiration

- Tax is collected at the time usage credits are acquired
- Usage credits do not expire

## Monthly Invoicing

Usage is typically invoiced once per month for the previous month's activity. The invoice details the usage and deducts the usage credits, with the amount due being only for usage exceeding the credit balance.

For customers with existing subscriptions, we offer the option to align the usage credit billing period with their subscription billing cycle. This synchronization helps simplify accounting and provides a more comprehensive view of total service costs.

## Pre-paid vs Post-paid Usage

- **With Subscription**: Organizations with subscriptions are provided a certain level of usage credits that can be paid post-paid, as they have established regular payments.
- **Without Subscription**: Customers without subscriptions are allowed only pre-paid usage, meaning usage credits must be added to the account before usage occurs.

## Refund Policy

Usage credits, once acquired, are non-refundable.

## Best Practices for Managing Usage Credits

1. **Monitor Usage**: Regularly check your usage in the Customer Portal to avoid unexpected charges.
2. **Set Appropriate Budgets**: Utilize the daily credit usage budget feature to control your spending.
3. **Configure Notifications**: Set up email notifications to stay informed about your credit usage.
4. **Plan Ahead**: For large projects, consider purchasing credits in advance to ensure uninterrupted service.
5. **Review Invoices**: Carefully review monthly invoices to understand your usage patterns and optimize your credit purchases.
6. **Utilize Spend Management Features**: Take full advantage of the spend management tools in the Customer Portal to control and monitor your credit usage effectively.

## Conclusion

CoinAPI's usage credits system, combined with the new spend management features, is designed to provide flexibility, transparency, and control in how customers access and pay for our services. By offering multiple acquisition methods, clear usage policies, detailed invoicing, and robust spend management tools, we aim to accommodate diverse customer needs while maintaining a fair and understandable billing process. The replacement of the pay-as-you-go option with the spend management system ensures that customers have even greater control over their usage and expenses. Whether you're a small startup or a large enterprise, our usage credits system can be tailored to suit your specific requirements and usage patterns across the entire CoinAPI product suite.

---

# Create new API key (https://www.apibricks.io/platform/docs/console-rest-api/api-keys/console_create_api_key)

---
title: Create new API key
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Creates a new API key for accessing CoinAPI services
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Creates a new API key for accessing CoinAPI services

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/apikeys","method":"post"}]} />

---

# Delete API key (https://www.apibricks.io/platform/docs/console-rest-api/api-keys/console_delete_api_key_by_id)

---
title: Delete API key
full: true
_openapi:
  method: DELETE
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Permanently deletes an API key
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Permanently deletes an API key

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/apikeys/{id}","method":"delete"}]} />

---

# Get API keys (https://www.apibricks.io/platform/docs/console-rest-api/api-keys/console_list_api_key)

---
title: Get API keys
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves all API keys for the current organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all API keys for the current organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/apikeys","method":"get"}]} />

---

# Rename API key (https://www.apibricks.io/platform/docs/console-rest-api/api-keys/console_patch_api_key_rename)

---
title: Rename API key
full: true
_openapi:
  method: PATCH
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Updates the display name of an API key
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Updates the display name of an API key

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/apikeys/rename","method":"patch"}]} />

---

# Change API key status (https://www.apibricks.io/platform/docs/console-rest-api/api-keys/console_patch_api_key_status)

---
title: Change API key status
full: true
_openapi:
  method: PATCH
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Activates or deactivates an API key
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Activates or deactivates an API key

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/apikeys/status","method":"patch"}]} />

---

# Gets audit log events for the current organization with flexible filtering.
The effective time window is always at least 24 hours regardless of the parameters
supplied: if the resolved window is shorter it is automatically expanded by moving
the start time back while keeping the end time unchanged. (https://www.apibricks.io/platform/docs/console-rest-api/audit-log/console_list_audit_log_query)

---
title: >-
  Gets audit log events for the current organization with flexible filtering.

  The effective time window is always at least 24 hours regardless of the
  parameters

  supplied: if the resolved window is shorter it is automatically expanded by
  moving

  the start time back while keeping the end time unchanged.
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns audit log events for your organization with flexible filtering
          options. The effective time window is always at least 24 hours: if the
          resolved range is shorter it is automatically expanded by moving start
          back while keeping end fixed. Use for reviewing activity history and
          compliance auditing.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns audit log events for your organization with flexible filtering options. The effective time window is always at least 24 hours: if the resolved range is shorter it is automatically expanded by moving start back while keeping end fixed. Use for reviewing activity history and compliance auditing.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/audit-log/query","method":"get"}]} />

---

# Gets the latest audit log events for the current organization (no time filtering) (https://www.apibricks.io/platform/docs/console-rest-api/audit-log/console_list_audit_trail_latest)

---
title: >-
  Gets the latest audit log events for the current organization (no time
  filtering)
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns the most recent audit trail events for your organization,
          ordered by newest first. No time filtering applied - returns the
          latest events up to the specified limit.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns the most recent audit trail events for your organization, ordered by newest first. No time filtering applied - returns the latest events up to the specified limit.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/audit-trail/latest","method":"get"}]} />

---

# Gets connection event analytics grouped by service, protocol, data center, and event type for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/connection-analytics/console_list_connection_analytics_events_organization_summary)

---
title: >-
  Gets connection event analytics grouped by service, protocol, data center, and
  event type for the current organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns connection event analytics for your organization grouped by
          service, protocol, data center, and event type. Use for understanding
          your organization's connection patterns and troubleshooting.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns connection event analytics for your organization grouped by service, protocol, data center, and event type. Use for understanding your organization's connection patterns and troubleshooting.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connection-analytics/events/organization-summary","method":"get"}]} />

---

# Gets raw connection event records with flexible filtering for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/connection-analytics/console_list_connection_analytics_events_query)

---
title: >-
  Gets raw connection event records with flexible filtering for the current
  organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns raw connection event entries for your organization with
          flexible filtering options. Use for detailed event analysis,
          troubleshooting, and historical tracking. Includes all event types and
          descriptions.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns raw connection event entries for your organization with flexible filtering options. Use for detailed event analysis, troubleshooting, and historical tracking. Includes all event types and descriptions.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connection-analytics/events/query","method":"get"}]} />

---

# Gets time-series connection event analytics with flexible filtering for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/connection-analytics/console_list_connection_analytics_events_timeseries)

---
title: >-
  Gets time-series connection event analytics with flexible filtering for the
  current organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns connection event analytics for your organization aggregated by
          time intervals and event types. Use for trend analysis, monitoring
          dashboards, and event pattern recognition.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns connection event analytics for your organization aggregated by time intervals and event types. Use for trend analysis, monitoring dashboards, and event pattern recognition.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connection-analytics/events/timeseries","method":"get"}]} />

---

# Gets raw connection status records with flexible filtering for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/connection-analytics/console_list_connection_analytics_query)

---
title: >-
  Gets raw connection status records with flexible filtering for the current
  organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns raw connection status records for your organization with
          flexible filtering options. Use for detailed analysis, UI display, and
          export. Includes connection duration, active status, and heartbeat
          information.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns raw connection status records for your organization with flexible filtering options. Use for detailed analysis, UI display, and export. Includes connection duration, active status, and heartbeat information.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connection-analytics/query","method":"get"}]} />

---

# Gets connection analytics grouped by service, protocol, and data center for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/connection-analytics/console_list_connection_analytics_summary)

---
title: >-
  Gets connection analytics grouped by service, protocol, and data center for
  the current organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns connection analytics for your organization grouped by service,
          protocol, and data center. Shows total connections, active
          connections, unique API keys, connection duration metrics, and
          activity timestamps.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns connection analytics for your organization grouped by service, protocol, and data center. Shows total connections, active connections, unique API keys, connection duration metrics, and activity timestamps.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connection-analytics/summary","method":"get"}]} />

---

# Gets time-series connection analytics with flexible filtering for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/connection-analytics/console_list_connection_analytics_time_series)

---
title: >-
  Gets time-series connection analytics with flexible filtering for the current
  organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns connection analytics for your organization aggregated by time
          intervals. Shows connection counts, active connections, unique API
          keys, and connection duration metrics over time.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns connection analytics for your organization aggregated by time intervals. Shows connection counts, active connections, unique API keys, and connection duration metrics over time.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connection-analytics/time-series","method":"get"}]} />

---

# Get connection events (https://www.apibricks.io/platform/docs/console-rest-api/connection-logs/console_list_connection_events)

---
title: Get connection events
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves connection events for a specific connection ID within the
          organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves connection events for a specific connection ID within the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connectionlog/events","method":"get"}]} />

---

# Get connection status (https://www.apibricks.io/platform/docs/console-rest-api/connection-logs/console_list_connection_status)

---
title: Get connection status
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves connection status logs for the organization, optionally
          filtered by API key or connection ID
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves connection status logs for the organization, optionally filtered by API key or connection ID

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/connectionlog/status","method":"get"}]} />

---

# Request free trial credits for the authenticated organization (https://www.apibricks.io/platform/docs/console-rest-api/free-credits/console_RequestFreeCredits)

---
title: Request free trial credits for the authenticated organization
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Grants $25 USD (2500 cents) in free trial credits to the authenticated
          organization that meets eligibility criteria.

          The organization ID is read from the authenticated JWT claims — no
          orgId parameter is required.

          Eligibility criteria:

          - Organization has active payment methods or prior payment history.

          - Organization has API key activity since October 2024.

          - Organization has at least one verified payment method (with card
          fingerprint).

          - Organization's payment method fingerprint is not shared with another
          account (fraud guard).
                      
          Idempotent: calling this endpoint again for an organization that
          already received free credits

          returns HTTP 409 Conflict with alreadyGranted=true rather than
          granting again.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Grants $25 USD (2500 cents) in free trial credits to the authenticated organization that meets eligibility criteria.
The organization ID is read from the authenticated JWT claims — no orgId parameter is required.
Eligibility criteria:
- Organization has active payment methods or prior payment history.
- Organization has API key activity since October 2024.
- Organization has at least one verified payment method (with card fingerprint).
- Organization's payment method fingerprint is not shared with another account (fraud guard).
            
Idempotent: calling this endpoint again for an organization that already received free credits
returns HTTP 409 Conflict with alreadyGranted=true rather than granting again.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/console/free-credits/request","method":"post"}]} />

---

# 🔗 Console REST API (https://www.apibricks.io/platform/docs/console-rest-api)

---
title: 🔗 Console REST API
description: Complete reference for APIBricks Console REST API endpoints.
---

import { Card, Cards } from 'fumadocs-ui/components/card'

<Cards>
  <Card title="API Keys" href="/platform/docs/console-rest-api/api-keys/console_list_api_key" description="Create, list, rename, enable, and delete organization API keys." />
  <Card title="Audit Log" href="/platform/docs/console-rest-api/audit-log/console_list_audit_log_query" description="Organization audit trail entries and filtered activity history." />
  <Card title="Connection Analytics" href="/platform/docs/console-rest-api/connection-analytics/console_list_connection_analytics_query" description="Aggregated connection metrics, trends, and analytics views." />
  <Card title="Connection Logs" href="/platform/docs/console-rest-api/connection-logs/console_list_connection_status" description="Recent connection history and connection-event ingestion endpoints." />
  <Card title="Free Credits" href="/platform/docs/console-rest-api/free-credits/console_RequestFreeCredits" description="Trial-credit requests for organizations that meet eligibility checks." />
  <Card title="Invoices" href="/platform/docs/console-rest-api/invoices/console_list_invoices_paid" description="Invoice retrieval, payment flows, and public invoice access." />
  <Card title="Metrics Usage" href="/platform/docs/console-rest-api/metrics-usage/console_get_metrics_usage_conf" description="Usage metrics for metered products and quota consumption." />
  <Card title="Notifications" href="/platform/docs/console-rest-api/notifications/console_get_user_notifications" description="User and organization notifications plus read-state management." />
  <Card title="Organization" href="/platform/docs/console-rest-api/organization/console_list_organization_balance_history" description="Organization profile, balances, and usage information." />
  <Card title="Payment Cards" href="/platform/docs/console-rest-api/payment-cards/console_list_payment" description="Card-focused payment actions and saved payment card workflows." />
  <Card title="Payment Methods" href="/platform/docs/console-rest-api/payment-methods/console_list_payment_methods" description="Stored payment methods used for subscriptions and billing." />
  <Card title="Products" href="/platform/docs/console-rest-api/products/console_list_products" description="Available product catalog and product metadata for subscriptions." />
  <Card title="Quota" href="/platform/docs/console-rest-api/quota/console_list_quota" description="Current quota balances, limits, and quota-related account information." />
  <Card title="Request Logs" href="/platform/docs/console-rest-api/request-logs/console_list_request_log_query" description="HTTP/API request logs and related request-level analytics." />
  <Card title="Status Page" href="/platform/docs/console-rest-api/status-page/console_list_status_page" description="Service status and incident information exposed in the console." />
  <Card title="Subscription" href="/platform/docs/console-rest-api/subscription/console_get_subscription" description="Subscription state, plans, checkout links, and API key limits." />
  <Card title="Support" href="/platform/docs/console-rest-api/support/console_list_support_tickets" description="Support tickets, ticket details, and support interactions." />
  <Card title="Tax IDs" href="/platform/docs/console-rest-api/tax-ids/console_list_tax_ids" description="Manage tax identification details used for billing and invoices." />
  <Card title="Team" href="/platform/docs/console-rest-api/team/api/teams/get" description="Team membership, users, and organization collaboration management." />
  <Card title="Usage Management" href="/platform/docs/console-rest-api/usage-management/console_get_usage_management" description="Usage summaries, estimates, and billing-oriented consumption views." />
</Cards>

---

# Get paid invoices (https://www.apibricks.io/platform/docs/console-rest-api/invoices/console_list_invoices_paid)

---
title: Get paid invoices
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves all paid invoices for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all paid invoices for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/invoices/paid","method":"get"}]} />

---

# Get unpaid invoices (https://www.apibricks.io/platform/docs/console-rest-api/invoices/console_list_invoices_unpaid)

---
title: Get unpaid invoices
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves all unpaid invoices for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all unpaid invoices for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/invoices/nopaid","method":"get"}]} />

---

# Get grouped metric data (https://www.apibricks.io/platform/docs/console-rest-api/metrics-usage/console_create_metrics_usage_group)

---
title: Get grouped metric data
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves usage metrics grouped by specified dimensions with filtering
          options
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves usage metrics grouped by specified dimensions with filtering options

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/metrics/usage/group","method":"post"}]} />

---

# Get metrics configuration (https://www.apibricks.io/platform/docs/console-rest-api/metrics-usage/console_get_metrics_usage_conf)

---
title: Get metrics configuration
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves available metrics and their dimensions for usage analysis
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves available metrics and their dimensions for usage analysis

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/metrics/usage/conf","method":"get"}]} />

---

# Get metric filters (https://www.apibricks.io/platform/docs/console-rest-api/metrics-usage/console_list_metrics_usage_filters)

---
title: Get metric filters
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves available filters for a specific metric
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves available filters for a specific metric

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/metrics/usage/filters","method":"get"}]} />

---

# Update email notifications (https://www.apibricks.io/platform/docs/console-rest-api/notifications/console_create_notification_emails)

---
title: Update email notifications
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Updates email notification settings for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Updates email notification settings for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/notifications/emails","method":"post"}]} />

---

# Get email notifications (https://www.apibricks.io/platform/docs/console-rest-api/notifications/console_get_notification_emails)

---
title: Get email notifications
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves email notification settings for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves email notification settings for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/notifications/emails","method":"get"}]} />

---

# Get notification history (https://www.apibricks.io/platform/docs/console-rest-api/notifications/console_get_notification_history)

---
title: Get notification history
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves notification history for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves notification history for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/notifications/history","method":"get"}]} />

---

# Get user notification settings (https://www.apibricks.io/platform/docs/console-rest-api/notifications/console_get_user_notifications)

---
title: Get user notification settings
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves notification preferences for the current user
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves notification preferences for the current user

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/notifications","method":"get"}]} />

---

# Update user notification setting (https://www.apibricks.io/platform/docs/console-rest-api/notifications/console_update_user_notification)

---
title: Update user notification setting
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Updates notification preference for a specific notification type
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Updates notification preference for a specific notification type

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/notifications","method":"post"}]} />

---

# Update organization details (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_create_organization)

---
title: Update organization details
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Updates organization information (admin only)
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Updates organization information (admin only)

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization","method":"post"}]} />

---

# Request Slack channel (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_create_organization_slack_channel_request)

---
title: Request Slack channel
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Requests a Slack channel for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Requests a Slack channel for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization/slack-channel-request","method":"post"}]} />

---

# Get countries list (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_get_organization_countries)

---
title: Get countries list
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves list of available countries for organization setup
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves list of available countries for organization setup

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization/countries","method":"get"}]} />

---

# Get usage date range (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_get_organization_usage_daterange)

---
title: Get usage date range
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves the available date range for organization usage data
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves the available date range for organization usage data

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization/usage/daterange","method":"get"}]} />

---

# Get organization details (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_list_organization)

---
title: Get organization details
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves details of the current organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves details of the current organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization","method":"get"}]} />

---

# Get balance transaction history (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_list_organization_balance_history)

---
title: Get balance transaction history
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves organization balance transaction history, optionally
          filtered by date range
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves organization balance transaction history, optionally filtered by date range

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization/balance/history","method":"get"}]} />

---

# Get daily usage statistics (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_list_organization_usage_per_day)

---
title: Get daily usage statistics
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves organization usage statistics aggregated by day for the
          specified date range
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves organization usage statistics aggregated by day for the specified date range

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization/usage/per-day","method":"get"}]} />

---

# Get monthly usage statistics (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_list_organization_usage_per_month)

---
title: Get monthly usage statistics
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves organization usage statistics aggregated by month for the
          specified year and month
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves organization usage statistics aggregated by month for the specified year and month

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization/usage/per-month","method":"get"}]} />

---

# Get uninvoiced usage statistics (https://www.apibricks.io/platform/docs/console-rest-api/organization/console_list_organization_usage_uninvoiced)

---
title: Get uninvoiced usage statistics
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves organization usage statistics that have not yet been
          invoiced
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves organization usage statistics that have not yet been invoiced

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/organization/usage/uninvoiced","method":"get"}]} />

---

# Get payment cards (https://www.apibricks.io/platform/docs/console-rest-api/payment-cards/console_list_payment)

---
title: Get payment cards
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves all payment cards associated with the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all payment cards associated with the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payments","method":"get"}]} />

---

# Delete payment card (https://www.apibricks.io/platform/docs/console-rest-api/payment-cards/console_patch_payment_delete_card)

---
title: Delete payment card
full: true
_openapi:
  method: PATCH
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Removes a payment card from the organization (requires no unpaid
          invoices or active subscriptions)
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Removes a payment card from the organization (requires no unpaid invoices or active subscriptions)

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payments/deletecard","method":"patch"}]} />

---

# Set default payment card (https://www.apibricks.io/platform/docs/console-rest-api/payment-cards/console_patch_payment_set_default)

---
title: Set default payment card
full: true
_openapi:
  method: PATCH
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Sets a payment card as the default for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Sets a payment card as the default for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payments/setdefaultcard","method":"patch"}]} />

---

# Add new payment card (https://www.apibricks.io/platform/docs/console-rest-api/payment-cards/console_update_payment)

---
title: Add new payment card
full: true
_openapi:
  method: PUT
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Creates a checkout session to add a new payment card to the
          organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Creates a checkout session to add a new payment card to the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payments/addcard","method":"put"}]} />

---

# Delete payment method (https://www.apibricks.io/platform/docs/console-rest-api/payment-methods/console_delete_payment_methods)

---
title: Delete payment method
full: true
_openapi:
  method: DELETE
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Removes a payment method from the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Removes a payment method from the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payment-methods/{id}","method":"delete"}]} />

---

# Get payment methods (https://www.apibricks.io/platform/docs/console-rest-api/payment-methods/console_list_payment_methods)

---
title: Get payment methods
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves all payment methods for the organization with default method
          marked
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all payment methods for the organization with default method marked

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payment-methods","method":"get"}]} />

---

# Set default payment method (https://www.apibricks.io/platform/docs/console-rest-api/payment-methods/console_patch_payment_methods)

---
title: Set default payment method
full: true
_openapi:
  method: PATCH
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Sets a payment method as the default for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Sets a payment method as the default for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payment-methods/{id}/set-default","method":"patch"}]} />

---

# Add payment method (https://www.apibricks.io/platform/docs/console-rest-api/payment-methods/console_update_payment_methods)

---
title: Add payment method
full: true
_openapi:
  method: PUT
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Creates a checkout session for adding a new payment method
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Creates a checkout session for adding a new payment method

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/payment-methods","method":"put"}]} />

---

# Get all products (https://www.apibricks.io/platform/docs/console-rest-api/products/console_list_products)

---
title: Get all products
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves all available API products with pricing information. Use
          productName to limit the response to a single product by name or ID.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all available API products with pricing information. Use productName to limit the response to a single product by name or ID.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/products","method":"get"}]} />

---

# Get quota information (https://www.apibricks.io/platform/docs/console-rest-api/quota/console_list_quota)

---
title: Get quota information
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves current quota limits and usage for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves current quota limits and usage for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/quota","method":"get"}]} />

---

# Gets raw request logs with flexible filtering for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/request-logs/console_list_request_log_query)

---
title: Gets raw request logs with flexible filtering for the current organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns raw request log entries for your organization with flexible
          filtering options. Use for detailed analysis, UI display, and export.
          Status code filtering: 1-digit (e.g., '4') for 4xx range, 2-digit
          (e.g., '40') for 40x range, 3-digit (e.g., '404') for exact match.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns raw request log entries for your organization with flexible filtering options. Use for detailed analysis, UI display, and export. Status code filtering: 1-digit (e.g., '4') for 4xx range, 2-digit (e.g., '40') for 40x range, 3-digit (e.g., '404') for exact match.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/request-logs/query","method":"get"}]} />

---

# Gets summary analytics for the current organization grouped by service, route, and status code (https://www.apibricks.io/platform/docs/console-rest-api/request-logs/console_list_request_log_summary)

---
title: >-
  Gets summary analytics for the current organization grouped by service, route,
  and status code
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns summary statistics for your organization grouped by service,
          route, and status code. Use to identify issues with specific services
          and compare performance across endpoints.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns summary statistics for your organization grouped by service, route, and status code. Use to identify issues with specific services and compare performance across endpoints.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/request-logs/summary","method":"get"}]} />

---

# Gets time-series analytics with flexible filtering for the current organization (https://www.apibricks.io/platform/docs/console-rest-api/request-logs/console_list_request_log_time_series)

---
title: >-
  Gets time-series analytics with flexible filtering for the current
  organization
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Returns time-series analytics for your organization grouped by time
          intervals. Use for charts, trend analysis, and comparing changes over
          time periods.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns time-series analytics for your organization grouped by time intervals. Use for charts, trend analysis, and comparing changes over time periods.

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/request-logs/time-series","method":"get"}]} />

---

# Get service status (https://www.apibricks.io/platform/docs/console-rest-api/status-page/console_list_status_page)

---
title: Get service status
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves current service status and health information
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves current service status and health information

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/statuspage","method":"get"}]} />

---

# Get subscription data (https://www.apibricks.io/platform/docs/console-rest-api/subscription/console_get_subscription)

---
title: Get subscription data
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves current subscription information for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves current subscription information for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/subscription","method":"get"}]} />

---

# Get subscription state (https://www.apibricks.io/platform/docs/console-rest-api/subscription/console_list_subscription_current)

---
title: Get subscription state
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Retrieves the current subscription state and status for the
          organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves the current subscription state and status for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/subscription/state","method":"get"}]} />

---

# Get subscription products (https://www.apibricks.io/platform/docs/console-rest-api/subscription/console_list_subscription_products)

---
title: Get subscription products
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves all available subscription products and billing plans
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all available subscription products and billing plans

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/subscription/products","method":"get"}]} />

---

# Create subscription checkout link (https://www.apibricks.io/platform/docs/console-rest-api/subscription/console_update_subscription_create_checkout)

---
title: Create subscription checkout link
full: true
_openapi:
  method: PUT
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Creates a checkout link for a new subscription plan
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Creates a checkout link for a new subscription plan

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/subscription/create-stripe/{id_stripe_plan}","method":"put"}]} />

---

# Get billing portal link (https://www.apibricks.io/platform/docs/console-rest-api/subscription/console_update_subscription_manage_portal)

---
title: Get billing portal link
full: true
_openapi:
  method: PUT
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Creates a link to Stripe billing portal for subscription management
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Creates a link to Stripe billing portal for subscription management

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/subscription/manage-stripe","method":"put"}]} />

---

# Add comment to ticket (https://www.apibricks.io/platform/docs/console-rest-api/support/console_add_support_ticket_comment)

---
title: Add comment to ticket
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Adds a comment to an existing support ticket
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Adds a comment to an existing support ticket

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/support/ticket/comment","method":"post"}]} />

---

# Get specific ticket (https://www.apibricks.io/platform/docs/console-rest-api/support/console_get_support_ticket_by_id)

---
title: Get specific ticket
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves details of a specific support ticket
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves details of a specific support ticket

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/support/ticket/{ticketId}","method":"get"}]} />

---

# Get all tickets (https://www.apibricks.io/platform/docs/console-rest-api/support/console_list_support_tickets)

---
title: Get all tickets
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves all support tickets for the current user and organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all support tickets for the current user and organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/support/tickets","method":"get"}]} />

---

# Add tax ID (https://www.apibricks.io/platform/docs/console-rest-api/tax-ids/console_create_tax_ids)

---
title: Add tax ID
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Adds a new tax identification number to the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Adds a new tax identification number to the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/tax-ids","method":"post"}]} />

---

# Get tax ID types (https://www.apibricks.io/platform/docs/console-rest-api/tax-ids/console_get_tax_ids_types)

---
title: Get tax ID types
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves list of available tax ID types
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves list of available tax ID types

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/tax-ids/types","method":"get"}]} />

---

# Get tax IDs (https://www.apibricks.io/platform/docs/console-rest-api/tax-ids/console_list_tax_ids)

---
title: Get tax IDs
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves all tax identification numbers for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves all tax identification numbers for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/tax-ids","method":"get"}]} />

---

# /api/teams (https://www.apibricks.io/platform/docs/console-rest-api/team/api/teams/delete)

---
title: /api/teams
full: true
_openapi:
  method: DELETE
  toc: []
  structuredData:
    headings: []
    contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/teams","method":"delete"}]} />

---

# Get team data (https://www.apibricks.io/platform/docs/console-rest-api/team/api/teams/get)

---
title: Get team data
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves team membership and context information for the current user
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves team membership and context information for the current user

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/teams","method":"get"}]} />

---

# /api/teams/leave (https://www.apibricks.io/platform/docs/console-rest-api/team/api/teams/leave/put)

---
title: /api/teams/leave
full: true
_openapi:
  method: PUT
  toc: []
  structuredData:
    headings: []
    contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/teams/leave","method":"put"}]} />

---

# /api/teams (https://www.apibricks.io/platform/docs/console-rest-api/team/api/teams/post)

---
title: /api/teams
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/teams","method":"post"}]} />

---

# /api/users/delete (https://www.apibricks.io/platform/docs/console-rest-api/team/api/users/delete/delete)

---
title: /api/users/delete
full: true
_openapi:
  method: DELETE
  toc: []
  structuredData:
    headings: []
    contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/users/delete","method":"delete"}]} />

---

# /api/users/invite (https://www.apibricks.io/platform/docs/console-rest-api/team/api/users/invite/post)

---
title: /api/users/invite
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents: []
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/users/invite","method":"post"}]} />

---

# Get user contacts (https://www.apibricks.io/platform/docs/console-rest-api/team/console_list_users)

---
title: Get user contacts
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves additional email contacts for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves additional email contacts for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/users","method":"get"}]} />

---

# Add credits (https://www.apibricks.io/platform/docs/console-rest-api/usage-management/console_create_usage_management_add_credits)

---
title: Add credits
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >-
          Adds credits to the organization account using the specified payment
          method
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Adds credits to the organization account using the specified payment method

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/billing/add-credits","method":"post"}]} />

---

# Update auto-recharge settings (https://www.apibricks.io/platform/docs/console-rest-api/usage-management/console_create_usage_management_auto_recharge)

---
title: Update auto-recharge settings
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Updates auto-recharge configuration for automatic credit top-ups
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Updates auto-recharge configuration for automatic credit top-ups

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/billing/auto-recharge","method":"post"}]} />

---

# Update usage settings (https://www.apibricks.io/platform/docs/console-rest-api/usage-management/console_create_usage_management_update_usage)

---
title: Update usage settings
full: true
_openapi:
  method: POST
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Updates usage management settings and limits
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Updates usage management settings and limits

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/billing/update-usage","method":"post"}]} />

---

# Get current usage (https://www.apibricks.io/platform/docs/console-rest-api/usage-management/console_get_usage_management)

---
title: Get current usage
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves current usage statistics and limits for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves current usage statistics and limits for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/billing/usage","method":"get"}]} />

---

# Get credit payment methods (https://www.apibricks.io/platform/docs/console-rest-api/usage-management/console_get_usage_management_add_credits_methods)

---
title: Get credit payment methods
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves available payment methods for adding credits
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves available payment methods for adding credits

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/billing/add-credits/methods","method":"get"}]} />

---

# Get auto-recharge settings (https://www.apibricks.io/platform/docs/console-rest-api/usage-management/console_get_usage_management_auto_recharge)

---
title: Get auto-recharge settings
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves current auto-recharge configuration
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves current auto-recharge configuration

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/billing/auto-recharge","method":"get"}]} />

---

# Get credit balance (https://www.apibricks.io/platform/docs/console-rest-api/usage-management/console_get_usage_management_credits)

---
title: Get credit balance
full: true
_openapi:
  method: GET
  toc: []
  structuredData:
    headings: []
    contents:
      - content: Retrieves current credit balance for the organization
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Retrieves current credit balance for the organization

<APIPage document={"https://api-console.apibricks.io/swagger/v1/swagger.json"} operations={[{"path":"/api/billing/credits","method":"get"}]} />