June 13, 2023

CoinAPI Updates: Authentication, Flat Files S3 API and Customer Portal

featured image

CoinAPI continues to evolve its infrastructure, authentication options, data delivery methods, and customer tools. From expanded authentication support to the Flat Files S3 API and improvements across the APIBricks Console, these capabilities give users more ways to securely access and manage cryptocurrency data.

Let’s take a closer look at what is currently available.

Security and accessibility are critical when working with financial and cryptocurrency data. CoinAPI supports several authentication methods, but the available options depend on the product, API, and protocol being used.

The API key remains one of the primary authentication methods across CoinAPI services. Depending on the API, keys can be supplied through methods such as a custom API key header, query parameter, URL path, or authorization mechanism.

CoinAPI also supports using API keys together with JWT authentication for supported APIs. JWT can provide additional control over how access is authorized, but API keys should still be handled carefully and should not be treated as credentials that can be freely exposed.

When JWT authentication is enabled, the Authorization header cannot also be used to pass the API key. Instead, the API key should be supplied through another supported method, such as the custom API key header, query string, or URL path.

Authentication methods are not identical across all CoinAPI products.

For example, the Market Data API supports several API key authentication methods as well as JWT for REST and WebSocket connections. FIX connections use SenderCompID.

The Flat Files S3 API follows an S3-compatible authentication model and supports AWS Signature Version 2 or 4.

Other products, including EMS Trading API, have their own authentication options depending on the API, protocol, and deployment model. EMS can also support TLS Client Certificates in applicable configurations.

For this reason, users should refer to the authentication documentation for the specific CoinAPI product they are integrating rather than assuming that every authentication method is available across every service.

JWT authentication provides an additional way to control access to supported CoinAPI APIs. It can be used alongside an API key where supported, allowing organizations to implement more controlled authentication flows.

Because JWT configuration, supported algorithms, and requirements can vary, users should follow the current authentication documentation for the relevant CoinAPI product when configuring JWT-based access.

The CoinAPI Flat Files S3 API provides an efficient way to retrieve large-scale historical cryptocurrency market datasets through an S3-compatible interface.

Flat Files are designed specifically for bulk historical data delivery. This makes the service particularly useful for organizations working with large datasets for quantitative research, backtesting, machine learning, market analysis, and historical replay.

Flat Files can include datasets such as trades, quotes, OHLCV, and order book data, depending on availability and the selected dataset.

For applications requiring live market information, CoinAPI provides separate real-time Market Data API interfaces, including WebSocket access.

Users need a CoinAPI account, a Flat Files API key, and sufficient Usage Credits to access Flat Files.

The S3-compatible endpoint is:

https://s3.flatfiles.coinapi.io

For compatible S3 clients, the Flat Files API key is used as the Access Key ID, while coinapi is used as the Secret Access Key. When a region is required by the client, us-east-1 should be used.

The service supports AWS Signature Version 2 or 4.

Flat Files usage is metered through the APIBricks Usage Credits model. Depending on the account setup, customers can use prepaid Usage Credits or committed plans, with additional usage billed according to the applicable overage model.

This gives researchers, trading firms, and other data-intensive users a practical way to retrieve large historical datasets without processing the same volume of information through individual REST requests.

The customer portal has evolved into the APIBricks Console, providing a central location for managing CoinAPI services and account usage.

Customers can use the Console to manage API keys and subscriptions, review billing information, add Usage Credits, inspect usage metrics and metered usage, monitor quotas and limits, review traces, manage notifications, and work with support tickets.

These tools make it easier to understand both technical activity and billing from the same environment.

The current APIBricks billing model is based on Usage Credits (UC). Customers can add prepaid credits or use committed plans where applicable. New accounts can also receive $25 in credits for testing, subject to the current signup and account requirements.

For services such as Flat Files, usage consumes the organization’s available Usage Credits according to the applicable product pricing rules. Customers on committed plans receive credits at the rate associated with their plan, while applicable usage beyond the included balance is billed according to the current overage model.

Ready to work with CoinAPI?

Create your account and get $25 in credits to start testing CoinAPI products. Explore real-time Market Data APIs, access bulk historical datasets through Flat Files, or manage your API keys, Usage Credits, and subscriptions directly from the APIBricks Console.

→ Create Your Account

→ Explore the Documentation

Recent Articles

Crypto API made simple: Try now or speak to our sales team

CoinAPI.io Blog - CoinAPI Updates: Authentication, Flat Files S3 API and Customer Portal