رفتن به محتوای اصلی
سرویکس وب‌سرویس و API داده‌های بازار ایران
فهرست مستندات

نمادهای پشتیبانی شده

نمادهای پشتیبانی‌شده وب‌سرویس و API سرویکس

با وب‌سرویس و API سرویکس، کد نمادها، پوشش منبع داده، businessTime و وضعیت تازگی را از کاتالوگ پویای supported دریافت کنید.

برای اتصال به وب‌سرویس سرویکس، کاتالوگ supported را با کلید API دریافت کنید و کد نمادها را در برنامه حدس نزنید. پاسخ فعلی این اندپوینت منبع حقیقت انتخاب نماد، پوشش منبع داده، businessTime و هشدار تازگی است.

درخواست کاتالوگ

GET /api/v1/assets/supported
curl -sS https://servix.cc/api/v1/assets/supported \
  -H "X-API-Key: <your-api-key>"

این مسیر مانند دیگر endpointهای assets به API Key و دسترسی فعال نیاز دارد و یک درخواست از سهمیه روزانه مصرف می کند.

ساختار سطح کاتالوگ

  • updatedAt زمان ساخته شدن پاسخ کاتالوگ است؛
  • staleThresholdMinutes آستانه فعلی سرویس برای قدیمی تشخیص دادن داده است؛ این عدد را در کلاینت ثابت نکنید؛
  • assets آرایه وضعیت همه کدهای شناخته شده است.

فیلدهای هر نماد

فیلدکاربرد
codeشناسه ای که در {assetName} endpointهای قیمت قرار می گیرد.
labelFa و labelEnبرچسب نمایشی فارسی و انگلیسی.
providersمنابعی که پوشش فنی نماد را اعلام کرده اند؛ تضمین دائمی دسترسی نیست.
providerSupportedوجود پوشش اعلام شده در تنظیمات تامین کننده.
latestValueAvailableآیا آخرین مقدار قابل نمایش وجود دارد.
latestValueآخرین مقدار در صورت وجود.
businessTimeزمان مربوط به خود قیمت.
sourceTime و insertTimeزمان منبع و زمان ثبت داخلی برای عیب یابی تاخیر.
qualityStatus و qualityMessageنتیجه کنترل کیفیت و توضیح مرتبط.
availabilityStatusوضعیت دسترس پذیری آخرین مقدار.
staleقدیمی بودن داده نسبت به staleThresholdMinutes.

گروه های رایج نماد

  • ارزهای ریالی مانند USD_RLS، EUR_RLS، AED_RLS و GBP_RLS؛
  • طلا و فلزات مانند GOLD_18_RLS، GOLD_24_RLS، GOLD_OUNCE_USD و SILVER_OUNCE_USD؛
  • سکه مانند SEKKEH_RLS، NIM_SEKKEH_RLS و ROB_SEKKEH_RLS؛
  • شاخص بازار ایران با STOCK_IR؛
  • رمزارزهای دلاری مانند BTC_USD، ETH_USD و USDT_USD.

این مثال ها جای کاتالوگ زنده را نمی گیرند. تعداد و وضعیت نمادها می تواند تغییر کند؛ برنامه باید پاسخ endpoint را منبع حقیقت بداند.

الگوی پیشنهادی در محصول

  1. کاتالوگ را در بک اند دریافت و برای مدت منطقی cache کنید؛
  2. فقط نمادهای دارای providerSupported و latestValueAvailable را برای انتخاب عادی نمایش دهید؛
  3. code را شناسه داخلی و labelFa را متن رابط فارسی قرار دهید؛
  4. وقتی stale درست است، زمان داده و هشدار قابل فهم نمایش دهید؛
  5. برای دریافت مقدار تازه، از endpointهای قیمت جاری استفاده کنید.

نمای عمومی اخیر ارز، طلا، سکه و رمزارز در صفحه اصلی برای آشنایی با پوشش داده موجود است. برای قرارداد کامل پاسخ، OpenAPI عمومی را ببینید و برای توضیح واحدها و تازگی به روش شناسی مراجعه کنید.

صفحه های عمومی قیمت طلا و سکه

برای مشاهده قرارداد واحد، تصویر آخرین قیمت، زمان تجاری، وضعیت تازگی و مسیر دریافت تاریخچه با API Key، مرکز API قیمت طلا و صفحه قیمت طلای ۱۸ عیار را ببینید. برای داده سکه نیز مرکز API قیمت سکه و صفحه قیمت سکه امامی در دسترس است.

مرور پوشش بازار

برای نمای انسانی مسیرهای نگهداری شده ارز، طلا، سکه و رمزارز، صفحه بازارهای پشتیبانی شده سرویکس را ببینید.

استفاده از allowlist در Vue

راهنمای تست‌شده سرویکس برای Vue 3 و Pinia این کاتالوگ را به allowlist مشخص برنامه محدود می‌کند، واحد و businessTime هر قیمت را نگه می‌دارد و نماد ناشناخته یا response نامعتبر را پیش از رسیدن به رابط کاربری رد می‌کند.

کاتالوگ جفت‌ارزهای رمزارز

کاتالوگ احرازشده شامل ۴۸ دارایی پایه رمزارز با دو واحد مستقل USD و RLS است. برای کشف کدهای جاری و گروه‌بندی دو واحد یک دارایی، از فیلدهای baseCode، category و quoteUnit استفاده کنید.

GET /api/v1/assets/supported?category=CRYPTO&quoteUnit=RLS

فیلترهای category و quoteUnit اختیاری‌اند و در صورت استفاده هم‌زمان به‌صورت اشتراکی اعمال می‌شوند. فهرست پاسخ کاتالوگ منبع حقیقت کدهاست؛ مستندات یک enum دستی و ثابت از نمادها نگهداری نمی‌کنند.