نمادهای پشتیبانی شده
کاتالوگ نمادها، تامین کننده و تازگی داده Servix
endpoint نمادهای پشتیبانی شده Servix را برای کشف code، برچسب فارسی، تامین کننده، آخرین مقدار، زمان داده و وضعیت stale مصرف کنید.
کد نمادها را در برنامه خود حدس نزنید. endpoint کاتالوگ فهرست قابل استفاده و وضعیت عملیاتی هر دارایی را در یک پاسخ برمی گرداند. با این مسیر می توانید انتخاب نماد، نمایش برچسب فارسی و هشدار تازگی داده را از وضعیت واقعی سرویس بسازید.
درخواست کاتالوگ
GET /api/v1/assets/supportedcurl -sS https://servix.cc/api/v1/assets/supported \
-H "X-API-Key: pk_live_your_key_here"این مسیر مانند دیگر 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 را منبع حقیقت بداند.
الگوی پیشنهادی در محصول
- کاتالوگ را در بک اند دریافت و برای مدت منطقی cache کنید؛
- فقط نمادهای دارای providerSupported و latestValueAvailable را برای انتخاب عادی نمایش دهید؛
- code را شناسه داخلی و labelFa را متن رابط فارسی قرار دهید؛
- وقتی stale درست است، زمان داده و هشدار قابل فهم نمایش دهید؛
- برای دریافت مقدار تازه، از endpointهای قیمت جاری استفاده کنید.
نمای عمومی اخیر ارز، طلا، سکه و رمزارز در صفحه اصلی برای آشنایی با پوشش داده موجود است. برای قرارداد کامل پاسخ، OpenAPI عمومی را ببینید و برای توضیح واحدها و تازگی به روش شناسی مراجعه کنید.
صفحه های عمومی قیمت طلا و سکه
برای مشاهده قرارداد واحد، تصویر آخرین قیمت، زمان تجاری، وضعیت تازگی و مسیر دریافت تاریخچه با API Key، مرکز API قیمت طلا و صفحه قیمت طلای ۱۸ عیار را ببینید. برای داده سکه نیز مرکز API قیمت سکه و صفحه قیمت سکه امامی در دسترس است.