Hugging Face's logo

Spaces:
Really-amin
/
Datasourceforcryptocurrency
Paused

App Files Community
Really-amin commited on
Commit
5293cdd
·
verified ·
1 Parent(s): a78e2d1

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +137 -19
README.md CHANGED
@@ -1,31 +1,149 @@
1
  ---
 
 
 
 
2
  sdk: docker
3
- emoji: 📚
4
- colorFrom: red
5
- colorTo: red
6
  ---
7
- # Crypto Data Source (HF Space)
8
 
9
- این پروژه یک **API + داشبورد** برای داده‌های رمزارز است و برای اجرا روی **Hugging Face Spaces (Docker)** آماده شده.
10
 
11
- ## اجرا روی Hugging Face Space
12
 
13
- - **Entry-point (Docker)**: `hf_unified_server:app`
14
- - **Port**: `7860`
15
- - **Health**: `GET /api/health`
16
 
17
- ## Endpointهای مهم برای UI
 
 
 
 
18
 
19
- - `GET /api/ai/signals` (سیگنال‌ها)
20
- - `POST /api/ai/decision` (تصمیم AI Analyst)
21
- - `POST /api/sentiment/analyze` (تحلیل احساسات متن)
22
 
23
- ## نکته مهم درباره “مدل‌ها”
24
 
25
- Endpointهای AI در `hf_unified_server.py` از این ماژول استفاده می‌کنند:
26
- - `backend/services/real_ai_models.py` → اجرای **واقعی** مدل‌ها از طریق HuggingFace Inference (با fallback امن)
 
27
 
28
- ## مستندات قدیمی (مرتب‌شده)
 
29
 
30
- فایل‌های توضیحی/گزارش‌های قبلی به این مسیر منتقل شدند:
31
- - `docs/legacy/`
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Crypto Resources API
3
+ emoji: 🚀
4
+ colorFrom: purple
5
+ colorTo: blue
6
  sdk: docker
7
+ pinned: false
8
+ license: mit
 
9
  ---
 
10
 
11
+ # 🚀 Crypto Resources API
12
 
13
+ یک API جامع برای دسترسی به **281+ منبع داده کریپتوکارنسی** با رابط کاربری زیبا و WebSocket support.
14
 
15
+ ## ✨ ویژگی‌ها
 
 
16
 
17
+ - 📊 **281+ منبع داده**: RPC Nodes, Block Explorers, Market Data, News, Sentiment, Analytics
18
+ - 🎨 **رابط کاربری زیبا**: داشبورد تعاملی با نمایش آمار لحظه‌ای
19
+ - 🔌 **WebSocket**: بروزرسانی خودکار و real-time
20
+ - 📚 **API کامل**: RESTful API با OpenAPI/Swagger docs
21
+ - 🆓 **رایگان**: بدون نیاز به API key
22
 
23
+ ## 🚀 استفاده سریع
 
 
24
 
25
+ ### API Endpoints
26
 
27
+ ```bash
28
+ # Health Check
29
+ GET /health
30
 
31
+ # آمار کلی منابع
32
+ GET /api/resources/stats
33
 
34
+ # لیست تمام منابع
35
+ GET /api/resources/list
36
+
37
+ # لیست دسته‌بندی‌ها
38
+ GET /api/categories
39
+
40
+ # منابع یک دسته خاص
41
+ GET /api/resources/category/{category}
42
+ ```
43
+
44
+ ### مثال با cURL
45
+
46
+ ```bash
47
+ # دریافت آمار
48
+ curl https://YOUR_USERNAME-crypto-resources-api.hf.space/api/resources/stats
49
+
50
+ # دریافت RPC Nodes
51
+ curl https://YOUR_USERNAME-crypto-resources-api.hf.space/api/resources/category/rpc_nodes
52
+ ```
53
+
54
+ ### مثال با Python
55
+
56
+ ```python
57
+ import requests
58
+
59
+ # دریافت آمار
60
+ response = requests.get("https://YOUR_USERNAME-crypto-resources-api.hf.space/api/resources/stats")
61
+ stats = response.json()
62
+ print(f"Total resources: {stats['total_resources']}")
63
+
64
+ # دریافت منابع یک دسته
65
+ response = requests.get("https://YOUR_USERNAME-crypto-resources-api.hf.space/api/resources/category/market_data")
66
+ resources = response.json()
67
+ print(f"Market data sources: {len(resources['resources'])}")
68
+ ```
69
+
70
+ ### WebSocket
71
+
72
+ ```javascript
73
+ const ws = new WebSocket('wss://YOUR_USERNAME-crypto-resources-api.hf.space/ws');
74
+
75
+ ws.onopen = () => {
76
+ console.log('Connected to WebSocket');
77
+ };
78
+
79
+ ws.onmessage = (event) => {
80
+ const data = JSON.parse(event.data);
81
+ console.log('Update:', data);
82
+ };
83
+ ```
84
+
85
+ ## 📦 دسته‌بندی منابع
86
+
87
+ - **RPC Nodes** (24): Ethereum, BSC, Polygon, Arbitrum, Optimism, ...
88
+ - **Block Explorers** (9): Etherscan, BscScan, Polygonscan, ...
89
+ - **Market Data** (15): CoinGecko, CoinMarketCap, Binance, ...
90
+ - **News** (10): CoinDesk, CoinTelegraph, Decrypt, ...
91
+ - **Sentiment** (7): LunarCrush, Santiment, ...
92
+ - **Analytics** (17): Glassnode, Nansen, Dune Analytics, ...
93
+ - **Hugging Face** (7): Datasets & Models
94
+ - و بیشتر...
95
+
96
+ ## 🛠️ نصب لوکال
97
+
98
+ ```bash
99
+ # Clone repository
100
+ git clone https://huggingface.co/spaces/YOUR_USERNAME/crypto-resources-api
101
+ cd crypto-resources-api
102
+
103
+ # نصب dependencies
104
+ pip install -r requirements.txt
105
+
106
+ # اجرای سرور
107
+ python -m uvicorn app:app --host 0.0.0.0 --port 7860
108
+
109
+ # یا با Docker
110
+ docker build -t crypto-api .
111
+ docker run -p 7860:7860 crypto-api
112
+ ```
113
+
114
+ سرور در `http://localhost:7860` در دسترس خواهد بود.
115
+
116
+ ## 📚 مستندات
117
+
118
+ - **API Docs**: `/docs` - Swagger UI
119
+ - **ReDoc**: `/redoc` - Alternative documentation
120
+ - **OpenAPI**: `/openapi.json` - OpenAPI specification
121
+
122
+ ## 🔧 تنظیمات
123
+
124
+ ### متغیرهای محیطی (اختیاری)
125
+
126
+ ```bash
127
+ # برای آپلود داده به Hugging Face Datasets
128
+ HF_TOKEN=your_token_here
129
+
130
+ # برای استفاده از API های خارجی
131
+ COINGECKO_API_KEY=your_key_here
132
+ BINANCE_API_KEY=your_key_here
133
+ ```
134
+
135
+ ## 🤝 مشارکت
136
+
137
+ این پروژه open-source است و از مشارکت شما استقبال می‌کنیم!
138
+
139
+ ## 📄 لایسنس
140
+
141
+ MIT License - استفاده آزاد در پروژه‌های شخصی و تجاری
142
+
143
+ ## 🙏 تشکر
144
+
145
+ از تمام منابع داده و API هایی که این پروژه را ممکن کرده‌اند، تشکر می‌کنیم.
146
+
147
+ ---
148
+
149
+ 💜 ساخته شده با عشق برای جامعه کریپتو