File size: 10,861 Bytes
426ef14
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# πŸ€– Prompt for AI Developer

Copy and paste this entire prompt to your AI coding assistant:

---

## YOUR TASK

You are tasked with **UPDATING an existing HuggingFace Space** to implement a comprehensive cryptocurrency data API with 30+ endpoints.

**⚠️ CRITICAL: THIS IS AN UPDATE REQUEST, NOT A NEW PROJECT!**

You are NOT creating a new HuggingFace Space. You are UPDATING and ENHANCING an existing one.

---

## MANDATORY READING ORDER

You MUST read the following files in this EXACT order before starting implementation:

### Step 1: Read `HF_DEPLOYMENT_SUMMARY.md` (5 minutes)
- Get quick overview of the project
- Understand what we're building and why

### Step 2: Read `SEND_TO_HF_TEAM.md` (10 minutes)

- Understand the official scope and priorities

- Review success criteria



### Step 3: Read `DATA_ARCHITECTURE_ANALYSIS_REPORT.md` (30 minutes)
- Understand current architecture
- Identify problems we're solving
- Review proposed solution

### Step 4: Read `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` (2-3 hours) ⭐ **THIS IS YOUR MAIN REFERENCE**

- Complete specifications for ALL 30+ API endpoints

- Request/Response formats with examples

- Complete Python/FastAPI implementation code

- Data source integration (CoinGecko, Binance, NewsAPI, etc.)

- Caching strategy with Redis

- Rate limiting implementation

- AI/ML model integration (BERT, LSTM)

- WebSocket real-time implementation

- Dockerfile and requirements.txt

- Environment variables

- Testing procedures

- Deployment steps



**This file contains EVERYTHING you need. Read it thoroughly.**



### Step 5 (Optional): Read `ENGINEERING_GUIDE.md` (1 hour)
- Coding standards and best practices for this project

---

## WHAT TO IMPLEMENT

You need to implement a FastAPI backend with:

### REST API Endpoints (25+ endpoints):

**Market Data:**
- GET `/api/market` - List of cryptocurrencies
- GET `/api/price/{symbol}` - Current price
- GET `/api/ohlcv` - Chart data (OHLCV/candlestick)
- GET `/api/ticker/{symbol}` - Real-time ticker

**News & Sentiment:**
- GET `/api/news/latest` - Latest crypto news
- GET `/api/sentiment/global` - Global market sentiment (Fear & Greed)
- GET `/api/sentiment/symbol/{symbol}` - Symbol-specific sentiment

**Trading:**
- GET `/api/exchange-info` - Trading pairs and exchange info
- GET `/api/orderbook/{symbol}` - Order book depth
- GET `/api/trades/{symbol}` - Recent trades

**AI & Predictions:**
- GET `/api/ai/signals` - AI trading signals
- POST `/api/ai/predict` - Price predictions
- GET `/api/ai/analysis/{symbol}` - Comprehensive AI analysis

**Blockchain:**
- GET `/api/blockchain/transactions/{address}` - Transaction history
- GET `/api/blockchain/whale-alerts` - Large transaction alerts

**Statistics:**
- GET `/api/stats` - Global market statistics
- GET `/api/stats/dominance` - Market dominance breakdown
- GET `/api/history/price/{symbol}` - Historical price data

### WebSocket Endpoints (2 channels):
- WS `/ws/ticker` - Real-time price updates
- WS `/ws/trades` - Real-time trade stream

### Special Endpoints:
- GET `/health` - Health check
- GET `/docs` - API documentation (auto-generated by FastAPI)

---

## TECHNICAL REQUIREMENTS

### Tech Stack:
```

- Python 3.9+

- FastAPI framework

- Redis for caching

- aiohttp for async HTTP requests

- PyTorch + Transformers for AI models

- ccxt for exchange integration

- WebSockets for real-time updates

```

### Data Sources to Integrate:
1. **CoinGecko API** - Market data (primary)
2. **Binance API** - OHLCV and trades (primary)
3. **NewsAPI / CryptoPanic** - News feeds
4. **Alternative.me** - Fear & Greed Index
5. **AI Models** - ElKulako/cryptobert for sentiment, custom LSTM for predictions

### Key Features:
- βœ… **Automatic Fallback** - If CoinGecko fails, try Binance, then CMC
- βœ… **Smart Caching** - Different TTL for different data (5s-10min)
- βœ… **Rate Limiting** - Respect external API limits
- βœ… **Error Handling** - Consistent JSON error format
- βœ… **CORS Enabled** - Allow all origins
- βœ… **Async/Await** - All endpoints must be async

---

## IMPLEMENTATION STEPS

### Phase 1: Setup
1. Access the existing HuggingFace Space repository
2. Set up Python 3.9+ environment
3. Install Redis (local or cloud)
4. Create virtual environment
5. Install dependencies from requirements.txt (provided in specs)

### Phase 2: Core Framework
1. Create FastAPI application
2. Configure CORS middleware
3. Set up Redis connection
4. Create health check endpoint
5. Test basic server startup

### Phase 3-9: Implement All Endpoints
Follow the detailed specifications in `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` for each endpoint.

**Priority order:**
1. **MUST HAVE (implement first):**
   - GET /api/market
   - GET /api/ohlcv
   - GET /api/news/latest
   - GET /api/sentiment/global
   - GET /api/ai/signals

2. **SHOULD HAVE (implement second):**
   - All other REST endpoints
   - WebSocket /ws/ticker

3. **NICE TO HAVE (if time permits):**
   - Advanced AI features
   - Blockchain endpoints

### Phase 10: WebSocket
1. Implement connection manager
2. Create ticker channel
3. Create trades channel
4. Test real-time updates

### Phase 11: Performance
1. Implement caching layer (Redis)
2. Add rate limiting
3. Optimize queries

### Phase 12: Testing
1. Test all endpoints individually
2. Test error scenarios
3. Test fallback mechanisms
4. Load test with concurrent users

### Phase 13: Deployment
1. Create Dockerfile (example provided in specs)
2. Configure environment variables in HF Space
3. Push to HuggingFace Space
4. Verify all endpoints in production
5. Monitor for 24 hours

---

## CRITICAL REMINDERS

### ⚠️ THIS IS AN UPDATE!
```

βœ… You are UPDATING an existing HuggingFace Space

βœ… DO NOT create a new space

βœ… ADD new endpoints to existing deployment

βœ… ENHANCE existing functionality

βœ… Keep existing features working

```

### ⚠️ QUALITY STANDARDS
```

βœ… All endpoints MUST return valid JSON

βœ… All errors MUST follow standard format (see specs)

βœ… All endpoints MUST have caching

βœ… All responses MUST include timestamp

βœ… All code MUST use async/await

βœ… All data sources MUST have fallback mechanisms

```

### ⚠️ PERFORMANCE REQUIREMENTS
```

Response Times:

- Price endpoints: < 100ms

- Market data: < 500ms

- News/Sentiment: < 1s

- AI predictions: < 2s



Caching TTL:

- Prices: 5 seconds

- OHLCV: 60 seconds

- News: 5 minutes

- AI signals: 2 minutes

```

### ⚠️ ERROR FORMAT (use this for ALL errors)
```json

{

  "success": false,

  "error": {

    "code": "ERROR_CODE",

    "message": "Human readable message",

    "details": {}

  },

  "timestamp": 1733432100000

}

```

---

## SUCCESS CRITERIA

You are DONE when:

βœ… All 30+ endpoints return valid responses  
βœ… WebSocket connections are stable  
βœ… Caching improves response times  
βœ… Fallback mechanisms work when primary source fails  
βœ… AI models generate predictions  
βœ… `/docs` endpoint shows interactive API documentation  
βœ… `/health` endpoint returns service status  
βœ… All endpoints tested in production  
βœ… No errors in logs for 24 hours  
βœ… Response times meet requirements above  

---

## WHERE TO FIND INFORMATION

While implementing, refer to these files:

| Need | Check File | Section |
|------|-----------|---------|
| Endpoint specs | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "DETAILED API SPECIFICATIONS" |
| Request/Response formats | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | Each endpoint section |
| Backend code | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "TECHNICAL REQUIREMENTS" |
| Data sources | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "Data Sources Integration" |
| Caching code | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "Caching Strategy" |
| AI models | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "AI/ML Models Integration" |
| WebSocket code | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "WebSocket Implementation" |
| Dockerfile | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "DEPLOYMENT CONFIGURATION" |
| Testing | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` | "VERIFICATION CHECKLIST" |

---

## COMMON MISTAKES TO AVOID

### ❌ DON'T DO THESE:
- ❌ Create a new HuggingFace Space (it exists! UPDATE it!)
- ❌ Remove or break existing functionality
- ❌ Hard-code API keys in code (use environment variables)
- ❌ Skip error handling
- ❌ Ignore caching requirements
- ❌ Use synchronous code (must be async)
- ❌ Return inconsistent response formats
- ❌ Deploy without testing locally first

### βœ… DO THESE:
- βœ… Update the existing Space
- βœ… Use environment variables for all secrets
- βœ… Implement proper error handling everywhere
- βœ… Add caching to every endpoint
- βœ… Test locally before deploying
- βœ… Use async/await throughout
- βœ… Follow the standard response format
- βœ… Implement fallback mechanisms
- βœ… Log all errors properly

---

## YOUR STARTING POINT

### First Actions:
1. Read `HF_DEPLOYMENT_SUMMARY.md`
2. Read `SEND_TO_HF_TEAM.md`
3. Read `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` carefully (your main reference)

### Then:
4. Set up your local development environment
5. Access the existing HuggingFace Space repository
6. Start implementing Phase 1 (Setup)
7. Follow the implementation steps above
8. Test thoroughly
9. Deploy

---

## FINAL CHECKLIST

Before you start coding, confirm:

- [ ] I understand this is an UPDATE, not a new project
- [ ] I have read all required documentation
- [ ] I understand the priority order (MUST/SHOULD/NICE TO HAVE)
- [ ] I have access to the existing HuggingFace Space
- [ ] I have Python 3.9+ installed
- [ ] I have Redis installed or know how to use cloud Redis
- [ ] I understand the success criteria
- [ ] I know where to find specifications (main file: `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md`)

---

## ESTIMATED TIME

- **Reading documentation:** 3-4 hours
- **Setup:** 1-2 hours
- **Implementation:** 3-5 days (full-time work)
- **Testing:** 1-2 days
- **Deployment:** 1 day

**Total: 5-8 days for complete implementation**

---

## πŸš€ BEGIN NOW

**Start by reading:** `HF_DEPLOYMENT_SUMMARY.md`

**Your main reference:** `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` (contains ALL specifications and code)

**Remember:** This is an UPDATE REQUEST. You are enhancing an existing HuggingFace Space, not creating a new one.

**Good luck with the implementation!** 🎯

---

**Version:** 1.0  
**Date:** December 5, 2025  
**Project:** Dreammaker Crypto Trading Platform  
**Type:** HuggingFace Space Update Request  
**Priority:** HIGH