OMCHOKSI108 commited on
Commit
02870df
·
1 Parent(s): aac542c

fix: add HuggingFace Spaces README config

Browse files

- Add YAML frontmatter with sdk: docker
- Add API documentation

Files changed (1) hide show
  1. README.md +42 -0
README.md ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: ForexDataLake
3
+ emoji: 📈
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: docker
7
+ pinned: false
8
+ ---
9
+
10
+ # ForexDataLake API
11
+
12
+ High-performance market data API serving OHLCV data from a HuggingFace-hosted parquet data lake.
13
+
14
+ ## Features
15
+
16
+ - **111 instruments** across forex, crypto, commodities, and stocks
17
+ - **7 timeframes** from 1-minute to daily
18
+ - **276M+ rows** of historical price data
19
+ - Technical indicators (SMA, EMA, RSI, MACD, ATR, VWAP, BBands)
20
+ - Equity curve and trade reports
21
+ - WebSocket streaming
22
+ - Zero local storage — reads directly from HuggingFace
23
+
24
+ ## Endpoints
25
+
26
+ | Method | Path | Description |
27
+ |--------|------|-------------|
28
+ | GET | `/api/v1/health` | Health check |
29
+ | GET | `/api/v1/symbols` | List all symbols |
30
+ | GET | `/api/v1/symbols/search?q=EUR` | Search symbols |
31
+ | GET | `/api/v1/symbols/{symbol}` | Symbol detail |
32
+ | GET | `/api/v1/data?symbol=EURUSD&timeframe=1hr` | OHLCV data |
33
+ | GET | `/api/v1/data/range` | Date range info |
34
+ | GET | `/api/v1/data/latest` | Latest bars |
35
+ | GET | `/api/v1/indicators/{symbol}` | Technical indicators |
36
+ | GET | `/api/v1/reports/equity` | Equity curve |
37
+ | GET | `/api/v1/reports/trades` | Trade records |
38
+ | WS | `/api/v1/ws/stream` | WebSocket streaming |
39
+
40
+ ## Authentication
41
+
42
+ All endpoints (except `/health`) require an API key via `X-API-Key` header.