برای اتصال به وبسرویس سرویکس، کاتالوگ 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 را منبع حقیقت بداند.
الگوی پیشنهادی در محصول
- کاتالوگ را در بک اند دریافت و برای مدت منطقی cache کنید؛
- فقط نمادهای دارای providerSupported و latestValueAvailable را برای انتخاب عادی نمایش دهید؛
- code را شناسه داخلی و labelFa را متن رابط فارسی قرار دهید؛
- وقتی stale درست است، زمان داده و هشدار قابل فهم نمایش دهید؛
- برای دریافت مقدار تازه، از 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"eUnit=RLS
فیلترهای category و quoteUnit اختیاریاند و در صورت استفاده همزمان بهصورت اشتراکی اعمال میشوند. فهرست پاسخ کاتالوگ منبع حقیقت کدهاست؛ مستندات یک enum دستی و ثابت از نمادها نگهداری نمیکنند.
نرخ ارزهای جهان در برابر دلار آمریکا
کاتالوگ احرازشده ۳۱ نماد FX تازه با واحد مظنه USD دارد. در این نمادها، مقدار midPrice نرمالشدهٔ RateSurf تعداد دلار آمریکا برای یک واحد ارز پایه است؛ آن را معکوس نکنید و جهت خام منبع بالادستی را به آن نسبت ندهید.
نمادهای تازه افزودهشده:
EUR_USD, AED_USD, GBP_USD, CAD_USD, CHF_USD, TRY_USD, AUD_USD, JPY_USD, CNY_USD, RUB_USD, AFN_USD, AMD_USD, AZN_USD, BHD_USD, BRL_USD, DKK_USD, GEL_USD, HKD_USD, INR_USD, IQD_USD, KWD_USD, MYR_USD, NOK_USD, NZD_USD, OMR_USD, PKR_USD, QAR_USD, SAR_USD, SEK_USD, SGD_USD, THB_USD
GET /api/v1/assets/supported?category=FX"eUnit=USD
برای تشخیص جهت مظنه از baseCode و quoteUnit پاسخ استفاده کنید. زمان مشاهدهٔ بازار در businessTime باقی میماند و دادهٔ عددی فقط از اندپوینتهای دارای کلید API در دسترس است.
کار تعاملی در پنل: برای انتخاب چند دارایی، دیدن جدول بعد از تأیید سهمیه و دریافت Excel یا JSON، معرفی کاوشگر داده بازار را بخوانید.
لیره جدید سوریه در برابر ریال ایران
نماد SYP_RLS لیره جدید سوریه را با واحد مظنهٔ ریال ایران به فهرست داراییهای پشتیبانیشده اضافه میکند و آن را بهروشنی از لیره قدیم سوریه متمایز میکند. مقدار عددی و تاریخچه فقط از مسیرهای احرازشده در دسترس است؛ نمایش عمومی قیمت همچنان فقط در تصویر تولیدشده روی سرور انجام میشود.
لیره جدید سوریه در برابر دلار آمریکا
نماد SYP_USD مظنهٔ مستقیم دلار آمریکا برای یک لیره جدید سوریه را ارائه میکند. این مقدار معکوس یا از SYP_RLS مشتق نمیشود. مقدار عددی، زمان مشاهده و جزئیات کیفیت فقط از مسیرهای احرازشده در دسترس است و کاتالوگ عمومی فقط کد و نامهای امن را نمایش میدهد.