مستندات API

همه‌ی اندپوینت‌ها، پارامترها و نمونه‌ی پاسخ‌ها.

احراز هویت

کلید API را در هدر «x-api-key» بفرست. کلید را از پنل کاربری می‌گیری.

curl -H "x-api-key: YOUR_API_KEY" \
  https://giti-git-main-n-stealth-s-projects.vercel.app/api/v1/assets/tdt-per-shakhs/latest

محدودیت نرخ

سقف ریکوئست بر اساس پلن شماست؛ در صورت عبور، پاسخ ۴۲۹ برمی‌گردد.

• X-RateLimit-Limit
• X-RateLimit-Remaining
• X-RateLimit-Used
• X-RateLimit-Reset

فرمت‌های خروجی

با پارامتر ?format= شکل خروجی را انتخاب کن.

verbose compact ohlc mobile ai

پارامترها

GET /api/v1/assets

فهرست دارایی‌های در دسترس

پارامترها

category string query اختیاری

فیلتر بر اساس شناسه‌ی کتگوری

وضعیت

200 فهرست دارایی‌ها
401 کلید API نامعتبر یا ارسال‌نشده
429 عبور از سقف مصرف پلن

GET /api/v1/assets/{assetId}/latest

قیمت لحظه‌ای یک دارایی

پارامترها

assetId string path الزامی

شناسه‌ی دارایی، مثلاً «tdt-per-shakhs»
format string query اختیاری

فرمت خروجی. مقادیر موجود: verbose, compact, ohlc, mobile, ai

verbose | compact | ohlc | mobile | ai

وضعیت

200 قیمت لحظه‌ای
401 کلید API نامعتبر یا ارسال‌نشده
403 پلن به این اندپوینت دسترسی ندارد
404 دارایی پیدا نشد
429 عبور از سقف مصرف پلن
503 هیچ منبع سالمی در دسترس نیست

نمونه پاسخ

{
  "asset": {
    "id": "tdt-per-shakhs",
    "symbol": "TDT-PER-SHAKHS",
    "name": "نمونه",
    "currency": "IRT"
  },
  "price": 1234567.89,
  "change24h": 1.42,
  "high24h": 1250000,
  "low24h": 1210000,
  "volume24h": 8123.5,
  "quotedAt": "2026-01-01T10:00:00.000Z",
  "servedAt": "2026-01-01T10:00:05.000Z",
  "cached": true,
  "meta": {
    "sourceId": "src_x",
    "sourceName": "منبع نمونه",
    "ageSeconds": 5
  }
}

GET /api/v1/assets/{assetId}/historical

کندل‌های تاریخی (OHLC)

پارامترها

assetId string path الزامی

شناسه‌ی دارایی، مثلاً «tdt-per-shakhs»
timeframe string query اختیاری

تایم‌فریم کندل‌ها (پیش‌فرض 1d)

1m | 5m | 15m | 1h | 4h | 1d | 1w
from string query اختیاری

تاریخ شروع (ISO یا timestamp ثانیه‌ای)
to string query اختیاری

تاریخ پایان (ISO یا timestamp ثانیه‌ای)
limit integer query اختیاری

حداکثر تعداد کندل (پیش‌فرض ۱۰۰۰، سقف ۵۰۰۰)
format string query اختیاری

فرمت خروجی. مقادیر موجود: verbose, compact, ohlc, mobile, ai

verbose | compact | ohlc | mobile | ai

وضعیت

200 سری زمانی کندل‌ها
400 پارامتر نامعتبر
403 عبور از عمق مجاز تاریخی پلن
429 عبور از سقف مصرف پلن

GET /api/v1/search

جست‌وجو در دارایی‌ها

پارامترها

q string query الزامی

عبارت جست‌وجو
limit integer query اختیاری

وضعیت

200 نتایج جست‌وجو
400 پارامتر q ارسال نشده

برای دریافت کلید، تعرفه‌ها را ببین.