Flat Files S3 API ā Complete Guide: Authentication, Discovery, Download & Extraction
This guide walks through the full workflow for accessing FinFeedAPI Flat Files via S3 API, covering:
- Authentication
- File discovery (listing)
- Downloading data
- Extracting
.csv.gzfiles
Each step provides two options:
- Option A: cURL / Postman
- Option B: AWS CLI
š Step 1: Authentication
FinFeedAPI uses a simplified S3-compatible authentication model:
Key Notes
- Your API key acts as the Access Key
- Secret is always: finfeedapi
- No token/session exchange required
- Works across all supported tools
š Option A ā cURL / Postman
Authentication is passed via headers:
Postman Setup
- Method:
GET - Add headers:
Authorization: YOUR_FINFEEDAPI_KEYAccept: application/xml
š ļø Option B ā AWS CLI
Configure credentials:
š Step 2: Discover Files (Listing)
You must first list files using prefixes to identify available datasets.
Flat Files are organized using a structured naming convention:
Structure Breakdown
E-ā Exchange (e.g.,E-IEXG)T-ā Data type + time interval- Always
OHLCV+TP - Example:
T-OHLCV+TP-1DAY
- Always
D-ā Date + file name- Example:
D-20240118.csv.gz
- Example:
š§ Example Path
š Option A ā cURL / Postman
List available files for an exchange and interval
š Sample Response
š ļø Option B ā AWS CLI
š Sample Response
š§ Discovery Tips
- Start from exchange level:
- Then drill down:
- Dates are encoded directly in file names (
D-YYYYMMDD.csv.gz)
š„ Step 3: Download Files
Once you identify the Key, download the file.
š Option A ā cURL / Postman
š ļø Option B ā AWS CLI
š§ Step 4: Extract .csv.gz Files
Flat Files are delivered as compressed .csv.gz.
š Option A ā Terminal (Mac / Linux)
Keep original file
š ļø Option B ā Python
šŖ (Optional) Windows
Use 7-Zip:
- Right-click ā Extract
- Extract again if needed
š Resulting CSV
After extraction:
Typical contents:
š Workflow Summary
- Authenticate using API key
- List files using:
- Identify file: D-YYYYMMDD.csv.gz
- Download file
- Extract
.csv.gz
ā Congratulations!
š You now know how to authenticate, discover, download, and extract Flat Files using the S3 API.
With the consistent structure:
E-{EXCHANGE}/T-OHLCV+TP-{INTERVAL}/D-{YYYYMMDD}.csv.gz
You can easily locate and retrieve OHLCV data for use in your workflows or pipelines.
