S3 API
Flat Files S3 API - Comprehensive Documentation
Introduction
The Flat Files S3 API is a powerful and flexible solution for accessing historical cryptocurrency market data. This document provides in-depth information about the API's features, usage, and integration capabilities.
General Overview
What is Flat Files S3 API?
Flat Files S3 API is a RESTful API designed to provide efficient access to cryptocurrency market data stored in flat files. The API is built to be compatible with Amazon S3, allowing users to leverage existing S3-compatible tools and infrastructure. While it doesn't support all Amazon S3 features, it focuses on core functionality for listing and downloading files, making it ideal for retrieving historical market data.
Key Features
- S3 Compatibility: Seamless integration with existing S3 tools and libraries.
- Efficient Data Retrieval: Optimized for listing and downloading large datasets.
- Flexible Authentication: Supports multiple authentication methods for secure access.
- Comprehensive Market Data: Access to various data types including trades, quotes, order books, and more.
API Specifications
Implemented Standards
The Flat Files S3 API adheres to the following HTTP standards:
This ensures broad compatibility and reliable performance across various client implementations.
Endpoints
The API is accessible through the following endpoints:
Environment | Encryption | Endpoint URL |
---|---|---|
Production | Yes | https://s3.flatfiles.coinapi.io/ |
Production | No | http://s3.flatfiles.coinapi.io/ |
We strongly recommend using the HTTPS endpoint for production environments to ensure data security.
HTTP Requests
For all requests to the Flat Files S3 API, you must include the following header:
Accept: application/xml
This header indicates that the client expects XML-formatted responses, which is the standard output format for this API.
Authentication
Secure access to the Flat Files S3 API is crucial. For detailed instructions on authentication methods, please refer to the authentication section of our documentation. This section covers various authentication techniques compatible with S3 clients, including:
- API Key usage
- AWS Signature Version 2 and 4
- Configuration examples for popular S3 clients and SDKs