اندپوینت‌ها

مسیرهای API مشتری و نمونه‌های کامل

برای هر مسیر، روش احراز هویت، ورودی‌ها، نحوهٔ محاسبهٔ سهمیه، خطاهای مهم، درخواست آمادهٔ cURL و یک پاسخ نمونهٔ امن را می‌بینید. نام فیلدها با پاسخ واقعی یکسان است و مقدارهای بازار عمداً پنهان شده‌اند.

GET /api/v1/assets/USD_RLS

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

احراز هویت

کلید صادرشده را با هر درخواست دارایی ارسال کنید.

API امن دو روش برای ارسال کلید می‌پذیرد. یکی را انتخاب کنید و در کلاینت یا پردازش سمت سرور همیشه از همان روش استفاده کنید.

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

کلید صادرشده را با هر درخواست دارایی ارسال کنید.

X-API-Key: <your-api-key>
Authorization: ApiKey <your-api-key>

امنیت کلید API

کلید API را داخل URL نفرستید.

آدرس‌ها به‌سادگی کپی، ذخیره، ثبت و ناخواسته به اشتراک گذاشته می‌شوند. اطلاعات محرمانه را در هدر درخواست نگه دارید.

تاریخچه مرورگر، لاگ پراکسی و سرور، ابزارهای پایش و تحلیل، هدر referrer، اسکرین‌شات و پیام‌های پشتیبانی همگی ممکن است URL کامل را نگه دارند.
اگر کلید API داخل URL باشد، هر کسی که آن URL را ببیند ممکن است بتواند از کلید استفاده کند.

سرویکس چطور این موضوع را مدیریت می‌کند

اندپوینت‌های امن دارایی‌ها کلید API را از هدر X-API-Key یا Authorization: ApiKey می‌خوانند.
اگر دو هدر کلید API با مقدار متفاوت ارسال شود، یا توکن Bearer با کلید API ترکیب شود، درخواست رد می‌شود.
فیلترهای غیرمحرمانه مانند تاریخ‌های from و to می‌توانند در URL بمانند، اما کلید API باید در هدر بماند.

استفاده نکنید: کلید API داخل URL

https://servix.cc/api/v1/assets/USD_RLS?api_key=<your-api-key>

به جای آن از هدر استفاده کنید

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

curl -sS https://servix.cc/api/v1/assets/USD_RLS \
  -H "Authorization: ApiKey <your-api-key>"

فیلترهای کوئری امن همراه با احراز هویت هدر

curl -sS "https://servix.cc/api/v1/assets/USD_RLS/history?from=2026-04-01&to=2026-04-13" \
  -H "X-API-Key: <your-api-key>"

اندپوینت‌ها

GET `/api/v1/assets`

فهرست کامل آخرین قیمت دارایی‌های پشتیبانی‌شده را برمی گرداند. فیلدهای قیمت فعلی در v1: مقدار value تغییر نکرده و midPrice برابر آن است. buyPrice قیمت خرید فروشنده از مشتری است؛ یعنی مبلغی که مشتری هنگام فروش دریافت می‌کند. sellPrice قیمت فروش فروشنده به مشتری است؛ یعنی مبلغی که مشتری هنگام خرید می‌پردازد. این قیمت‌ها با همان quoteUnit و businessTime و به صورت عدد JSON ارائه می‌شوند. سمت ناموجود صریحاً null است و قیمت قبلی به مشاهده جدید منتقل نمی‌شود. برابری سه قیمت ممکن است حاصل یکسان‌سازی داده با قیمت میانی باشد و تضمین نقدشوندگی مستقل یا امکان معامله نیست. پاسخ فعلی midPrice دارد. پاسخ تاریخ‌دار و تاریخچه، buyPrice و sellPrice ذخیره‌شدهٔ مشاهدهٔ value را دارند و هر سمت ناموجود صریحاً null است؛ کندل OHLC فقط قیمت میانی دارد. طبق /docs/api-lifecycle کلاینت باید فیلد اختیاری ناشناخته را نادیده بگیرد؛ سازگاری کلاینت‌های سخت‌گیر تضمین نمی‌شود. احراز هویت و هزینه سهمیه تغییر نکرده است.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامتر اختیاری codes؛ برای گرفتن فهرست کامل آن را نفرستید.
سهمیه: پس از احراز هویت معتبر، یک واحد از سهمیه کم می‌شود؛ حتی اگر اعتبارسنجی یا پردازش بعدی با خطا تمام شود.
خطاهای مهم: 400 کدهای نامعتبر؛ 401 کلید نامعتبر یا ارسال‌نشده؛ 403 دسترسی غیرفعال؛ 404 نبود آخرین رکورد؛ 429 پایان سهمیهٔ روزانه.

درخواست cURL

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

پاسخ نمونهٔ امن

[
  {
    "code": "USD_RLS",
    "name": "USD_RLS",
    "slug": "usd_rls",
    "labelEn": "US Dollar / Iranian Rial",
    "labelFa": "دلار آمریکا / ریال ایران",
    "quoteUnit": "RLS",
    "value": "<protected-market-value>",
    "businessTime": "<source-timestamp>",
    "buyPrice": "<protected-market-value>",
    "sellPrice": "<protected-market-value>",
    "midPrice": "<protected-market-value>"
  }
]

GET `/api/v1/assets/supported`

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

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامترهای اختیاری category و quoteUnit؛ اگر هر دو را بفرستید، هر دو فیلتر هم‌زمان اعمال می‌شوند.
سهمیه: یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 فیلتر نامعتبر؛ 401 کلید نامعتبر یا ارسال‌نشده؛ 403 دسترسی غیرفعال؛ 429 پایان سهمیهٔ روزانه.

درخواست cURL

curl -sS "https://servix.cc/api/v1/assets/supported?category=CRYPTO&quoteUnit=RLS" \
  -H "X-API-Key: <your-api-key>"

پاسخ نمونهٔ امن

{
  "updatedAt": "<response-timestamp>",
  "staleThresholdMinutes": 60,
  "assets": [
    {
      "code": "BTC_RLS",
      "baseCode": "BTC",
      "category": "CRYPTO",
      "labelEn": "Bitcoin / Iranian Rial",
      "labelFa": "بیت‌کوین / ریال ایران",
      "quoteUnit": "RLS",
      "providers": ["SERVIX"],
      "providerSupported": true,
      "latestValueAvailable": true,
      "latestValue": "<protected-market-value>",
      "businessTime": "<source-timestamp>",
      "sourceTime": "<source-timestamp>",
      "insertTime": "<response-timestamp>",
      "qualityStatus": "ACCEPTED",
      "qualityMessage": "",
      "availabilityStatus": "AVAILABLE",
      "stale": false,
      "ohlcAvailable": true,
      "ohlcAvailableFrom": "<source-timestamp>"
    }
  ]
}

GET `/api/v1/assets/USD_RLS`

آخرین قیمت یک کد دارایی را برمی گرداند. فیلدهای قیمت فعلی در v1: مقدار value تغییر نکرده و midPrice برابر آن است. buyPrice قیمت خرید فروشنده از مشتری است؛ یعنی مبلغی که مشتری هنگام فروش دریافت می‌کند. sellPrice قیمت فروش فروشنده به مشتری است؛ یعنی مبلغی که مشتری هنگام خرید می‌پردازد. این قیمت‌ها با همان quoteUnit و businessTime و به صورت عدد JSON ارائه می‌شوند. سمت ناموجود صریحاً null است و قیمت قبلی به مشاهده جدید منتقل نمی‌شود. برابری سه قیمت ممکن است حاصل یکسان‌سازی داده با قیمت میانی باشد و تضمین نقدشوندگی مستقل یا امکان معامله نیست. پاسخ فعلی midPrice دارد. پاسخ تاریخ‌دار و تاریخچه، buyPrice و sellPrice ذخیره‌شدهٔ مشاهدهٔ value را دارند و هر سمت ناموجود صریحاً null است؛ کندل OHLC فقط قیمت میانی دارد. طبق /docs/api-lifecycle کلاینت باید فیلد اختیاری ناشناخته را نادیده بگیرد؛ سازگاری کلاینت‌های سخت‌گیر تضمین نمی‌شود. احراز هویت و هزینه سهمیه تغییر نکرده است.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامتر مسیر assetName؛ یکی از کدهای فهرست supported.
سهمیه: یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 401 کلید نامعتبر یا ارسال‌نشده؛ 403 دسترسی غیرفعال؛ 404 نماد ناشناخته یا نبود آخرین رکورد؛ 429.

درخواست cURL

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

پاسخ نمونهٔ امن

{
  "code": "USD_RLS",
  "name": "USD_RLS",
  "slug": "usd_rls",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "value": "<protected-market-value>",
  "businessTime": "<source-timestamp>",
  "buyPrice": "<protected-market-value>",
  "sellPrice": "<protected-market-value>",
  "midPrice": "<protected-market-value>"
}

GET `/api/v1/assets/USD_RLS/2026-04-13`

درخواست میلادی قدیمی: مشاهدهٔ انتخاب‌شده و همان فیلدهای قبلی پاسخ را برمی‌گرداند؛ value میانگین روزانه نیست. قیمت سمت‌های مشاهدهٔ ذخیره‌شده: buyPrice قیمت خرید فروشنده از مشتری و sellPrice قیمت فروش به مشتری است. هر سمت متعلق به همان مشاهدهٔ value با همان quoteUnit و businessTime است و به صورت عدد دقیق JSON یا، در صورت ذخیره‌نشدن، صریحاً null برمی‌گردد. در مشاهده‌های قدیمی ممکن است یک یا هر دو سمت ناموجود باشند. قیمت میانی، قیمت قبلی یا قیمت فعلی جایگزین نمی‌شود. calendar=persian فقط تاریخ مسیر را به همان روز میلادی تبدیل می‌کند؛ include=ohlc کندل قیمت میانی را اضافه می‌کند و مشاهدهٔ انتخاب‌شده را تغییر نمی‌دهد. مسیر GET تاریخچه و بازهٔ POST معادل، آخرین مشاهدهٔ انتخاب‌شدهٔ هر روز موجود در نتیجهٔ جست‌وجوی قبلی را برمی‌گردانند؛ روز ناموجود پر نمی‌شود. این تغییر دادهٔ تاریخی تامین‌کننده را دریافت یا بازسازی نمی‌کند.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامترهای مسیر assetName و تاریخ میلادی با قالب YYYY-MM-DD هستند. برای حفظ پاسخ قبلی، calendar و include را نفرستید.
سهمیه: یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 با کد INVALID_REQUEST_PARAMETER برای تاریخ بدقالب؛ 401 کلید نامعتبر یا ارسال‌نشده؛ 403 دسترسی غیرفعال؛ 404 با کد ASSET_NOT_FOUND؛ 429 پایان سهمیهٔ روزانه.

درخواست cURL

curl -sS https://servix.cc/api/v1/assets/USD_RLS/2026-04-13 \
  -H "X-API-Key: <your-api-key>"

پاسخ نمونهٔ امن

{
  "code": "USD_RLS",
  "name": "USD_RLS",
  "slug": "usd_rls",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "value": "<protected-market-value>",
  "businessTime": "<source-timestamp>",
  "buyPrice": "<protected-market-value>",
  "sellPrice": "<protected-market-value>"
}

GET `/api/v1/assets/USD_RLS/2026-04-13?calendar=gregorian&include=ohlc`

درخواست میلادی همراه OHLC روزانه: مقدار value در پاسخ قدیمی حفظ می‌شود و پنجرهٔ روز محلی و خلاصهٔ قابل اتکای باز، بیشینه، کمینه و پایانی اضافه می‌شود. قیمت سمت‌های مشاهدهٔ ذخیره‌شده: buyPrice قیمت خرید فروشنده از مشتری و sellPrice قیمت فروش به مشتری است. هر سمت متعلق به همان مشاهدهٔ value با همان quoteUnit و businessTime است و به صورت عدد دقیق JSON یا، در صورت ذخیره‌نشدن، صریحاً null برمی‌گردد. در مشاهده‌های قدیمی ممکن است یک یا هر دو سمت ناموجود باشند. قیمت میانی، قیمت قبلی یا قیمت فعلی جایگزین نمی‌شود. calendar=persian فقط تاریخ مسیر را به همان روز میلادی تبدیل می‌کند؛ include=ohlc کندل قیمت میانی را اضافه می‌کند و مشاهدهٔ انتخاب‌شده را تغییر نمی‌دهد. مسیر GET تاریخچه و بازهٔ POST معادل، آخرین مشاهدهٔ انتخاب‌شدهٔ هر روز موجود در نتیجهٔ جست‌وجوی قبلی را برمی‌گردانند؛ روز ناموجود پر نمی‌شود. این تغییر دادهٔ تاریخی تامین‌کننده را دریافت یا بازسازی نمی‌کند.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامترهای مسیر assetName و تاریخ میلادی YYYY-MM-DD هستند؛ calendar=gregorian تقویم را صریح می‌کند و include=ohlc فیلدهای روزانه را می‌افزاید. value مشاهدهٔ انتخاب‌شده است، نه میانگین روزانه، و ممکن است با close فرق کند.
سهمیه: یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 تاریخ نامعتبر یا مقدار نامعتبر calendar/include؛ 401 کلید نامعتبر یا ارسال‌نشده؛ 403 دسترسی غیرفعال؛ 404 ASSET_NOT_FOUND؛ 429 پایان سهمیهٔ روزانه.

درخواست cURL

curl -sS "https://servix.cc/api/v1/assets/USD_RLS/2026-04-13?calendar=gregorian&include=ohlc" \
  -H "X-API-Key: <your-api-key>"

پاسخ نمونهٔ امن

{
  "code": "USD_RLS",
  "name": "USD_RLS",
  "slug": "usd_rls",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "value": "<protected-market-value>",
  "businessTime": "<source-timestamp>",
  "buyPrice": "<protected-market-value>",
  "sellPrice": "<protected-market-value>",
  "day": {
    "date": "2026-04-13",
    "timeZone": "<database-session-time-zone>",
    "start": "<inclusive-day-start-utc>",
    "end": "<exclusive-day-end-utc>"
  },
  "ohlc": {
    "start": "<inclusive-day-start-utc>",
    "end": "<exclusive-day-end-utc>",
    "open": "<protected-market-value>",
    "high": "<protected-market-value>",
    "low": "<protected-market-value>",
    "close": "<protected-market-value>",
    "observationCount": 12,
    "complete": true
  },
  "ohlcAvailableFrom": "<first-trusted-observation-time>",
  "ohlcStatus": "AVAILABLE"
}

GET `/api/v1/assets/USD_RLS/1405-01-24?calendar=persian`

درخواست تاریخ شمسی با پاسخ قدیمی: تاریخ مسیر به روز میلادی متناظر تبدیل می‌شود و مشاهدهٔ انتخاب‌شدهٔ قبلی برمی‌گردد. قیمت سمت‌های مشاهدهٔ ذخیره‌شده: buyPrice قیمت خرید فروشنده از مشتری و sellPrice قیمت فروش به مشتری است. هر سمت متعلق به همان مشاهدهٔ value با همان quoteUnit و businessTime است و به صورت عدد دقیق JSON یا، در صورت ذخیره‌نشدن، صریحاً null برمی‌گردد. در مشاهده‌های قدیمی ممکن است یک یا هر دو سمت ناموجود باشند. قیمت میانی، قیمت قبلی یا قیمت فعلی جایگزین نمی‌شود. calendar=persian فقط تاریخ مسیر را به همان روز میلادی تبدیل می‌کند؛ include=ohlc کندل قیمت میانی را اضافه می‌کند و مشاهدهٔ انتخاب‌شده را تغییر نمی‌دهد. مسیر GET تاریخچه و بازهٔ POST معادل، آخرین مشاهدهٔ انتخاب‌شدهٔ هر روز موجود در نتیجهٔ جست‌وجوی قبلی را برمی‌گردانند؛ روز ناموجود پر نمی‌شود. این تغییر دادهٔ تاریخی تامین‌کننده را دریافت یا بازسازی نمی‌کند.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: تاریخ مسیر را با قالب YYYY-MM-DD شمسی بفرستید و calendar=persian را تنظیم کنید. 1405-01-24 برابر با 2026-04-13 است. با نفرستادن include، فیلدهای پاسخ قبلی حفظ می‌شوند.
سهمیه: یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 با کدهای INVALID_PERSIAN_DATE، PERSIAN_DATE_OUT_OF_RANGE یا UNSUPPORTED_CALENDAR؛ 401؛ 403؛ 404 ASSET_NOT_FOUND؛ 429.

درخواست cURL

curl -sS "https://servix.cc/api/v1/assets/USD_RLS/1405-01-24?calendar=persian" \
  -H "X-API-Key: <your-api-key>"

پاسخ نمونهٔ امن

{
  "code": "USD_RLS",
  "name": "USD_RLS",
  "slug": "usd_rls",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "value": "<protected-market-value>",
  "businessTime": "<source-timestamp>",
  "buyPrice": "<protected-market-value>",
  "sellPrice": "<protected-market-value>"
}

GET `/api/v1/assets/USD_RLS/1405-01-24?calendar=persian&include=ohlc`

درخواست تاریخ شمسی همراه OHLC روزانه: تاریخ به روز میلادی متناظر تبدیل می‌شود، value قدیمی حفظ می‌شود و فیلدهای OHLC همان روز اضافه می‌شوند. قیمت سمت‌های مشاهدهٔ ذخیره‌شده: buyPrice قیمت خرید فروشنده از مشتری و sellPrice قیمت فروش به مشتری است. هر سمت متعلق به همان مشاهدهٔ value با همان quoteUnit و businessTime است و به صورت عدد دقیق JSON یا، در صورت ذخیره‌نشدن، صریحاً null برمی‌گردد. در مشاهده‌های قدیمی ممکن است یک یا هر دو سمت ناموجود باشند. قیمت میانی، قیمت قبلی یا قیمت فعلی جایگزین نمی‌شود. calendar=persian فقط تاریخ مسیر را به همان روز میلادی تبدیل می‌کند؛ include=ohlc کندل قیمت میانی را اضافه می‌کند و مشاهدهٔ انتخاب‌شده را تغییر نمی‌دهد. مسیر GET تاریخچه و بازهٔ POST معادل، آخرین مشاهدهٔ انتخاب‌شدهٔ هر روز موجود در نتیجهٔ جست‌وجوی قبلی را برمی‌گردانند؛ روز ناموجود پر نمی‌شود. این تغییر دادهٔ تاریخی تامین‌کننده را دریافت یا بازسازی نمی‌کند.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: تاریخ مسیر را با قالب YYYY-MM-DD شمسی بفرستید؛ calendar=persian تقویم را تعیین می‌کند و include=ohlc مرزهای روز و خلاصهٔ قابل اتکای آن را می‌افزاید. 1405-01-24 برابر با 2026-04-13 است؛ value میانگین نیست و ممکن است با close فرق کند.
سهمیه: یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 با کدهای INVALID_PERSIAN_DATE، PERSIAN_DATE_OUT_OF_RANGE یا مقدار نامعتبر calendar/include؛ 401؛ 403؛ 404 ASSET_NOT_FOUND؛ 429.

درخواست cURL

curl -sS "https://servix.cc/api/v1/assets/USD_RLS/1405-01-24?calendar=persian&include=ohlc" \
  -H "X-API-Key: <your-api-key>"

پاسخ نمونهٔ امن

{
  "code": "USD_RLS",
  "name": "USD_RLS",
  "slug": "usd_rls",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "value": "<protected-market-value>",
  "businessTime": "<source-timestamp>",
  "buyPrice": "<protected-market-value>",
  "sellPrice": "<protected-market-value>",
  "day": {
    "date": "2026-04-13",
    "timeZone": "<database-session-time-zone>",
    "start": "<inclusive-day-start-utc>",
    "end": "<exclusive-day-end-utc>"
  },
  "ohlc": {
    "start": "<inclusive-day-start-utc>",
    "end": "<exclusive-day-end-utc>",
    "open": "<protected-market-value>",
    "high": "<protected-market-value>",
    "low": "<protected-market-value>",
    "close": "<protected-market-value>",
    "observationCount": 12,
    "complete": true
  },
  "ohlcAvailableFrom": "<first-trusted-observation-time>",
  "ohlcStatus": "AVAILABLE"
}

GET `/api/v1/assets/USD_RLS/history?from=2026-04-01&to=2026-04-13`

با پارامترهای کوئری، تاریخچه یک دارایی را در بازه زمانی دلخواه دریافت کنید.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامتر مسیر assetName و بدنهٔ JSON شامل fromDate و toDate با قالب YYYY-MM-DD.
سهمیه: برای کل پاسخ بازه، یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 بدنهٔ ناقص یا بدقالب؛ 401؛ 403؛ 404؛ 417 بازهٔ نامعتبر یا طولانی؛ 429.

درخواست cURL

curl -sS "https://servix.cc/api/v1/assets/USD_RLS/history?from=2026-04-01&to=2026-04-13" \
  -H "X-API-Key: <your-api-key>"

پاسخ نمونهٔ امن

[
  {
    "code": "USD_RLS",
    "name": "USD_RLS",
    "slug": "usd_rls",
    "labelEn": "US Dollar / Iranian Rial",
    "labelFa": "دلار آمریکا / ریال ایران",
    "quoteUnit": "RLS",
    "value": "<protected-market-value>",
    "businessTime": "<source-timestamp>",
    "buyPrice": "<protected-market-value>",
    "sellPrice": "<protected-market-value>"
  }
]

GET `/api/v1/assets/USD_RLS/ohlc?interval=15m&from=2026-08-26T00:00:00Z&to=2026-08-27T00:00:00Z`

کندل‌های باز، بیشینه، کمینه و بسته‌شدن (OHLC) یک نماد را در یک بازهٔ زمانی مشخص و نیمه‌باز برمی‌گرداند.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامتر مسیر assetCode؛ مقدار interval یکی از 15m، 1h، 4h یا 1d است. from و to را با قالب ISO 8601 و زمان UTC بفرستید؛ برای نمونه from=2026-08-26T00:00:00Z و to=2026-08-27T00:00:00Z. مرز to در پاسخ محاسبه نمی‌شود.
سهمیه: برای کل پاسخ کندل‌ها، یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 ورودی ناقص، بدقالب یا interval نامعتبر؛ 401؛ 403؛ 404 نماد ناشناخته یا نبود داده؛ 429.

درخواست cURL

curl -sS "https://servix.cc/api/v1/assets/USD_RLS/ohlc?interval=15m&from=2026-08-26T00:00:00Z&to=2026-08-27T00:00:00Z" \
  -H "X-API-Key: <your-api-key>"

پاسخ نمونهٔ امن

{
  "code": "USD_RLS",
  "baseCode": "USD",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "interval": "15m",
  "from": "2026-08-26T00:00:00Z",
  "to": "2026-08-27T00:00:00Z",
  "availableFrom": "<source-timestamp>",
  "candles": [
    {
      "start": "2026-08-26T00:00:00Z",
      "end": "2026-08-26T00:15:00Z",
      "open": "<protected-market-value>",
      "high": "<protected-market-value>",
      "low": "<protected-market-value>",
      "close": "<protected-market-value>",
      "observationCount": 4,
      "complete": true
    }
  ]
}

POST `/api/v1/assets/USD_RLS`

با ارسال بدنه JSON شامل بازه زمانی، داده‌های تاریخی همان دارایی را دریافت می‌کنید.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: پارامتر مسیر assetName و پارامترهای الزامی from و to با قالب YYYY-MM-DD.
سهمیه: برای کل پاسخ بازه، یک واحد از سهمیه کم می‌شود.
خطاهای مهم: 400 ورودی ناقص یا بدقالب؛ 401؛ 403؛ 404؛ 417 بازهٔ نامعتبر یا طولانی؛ 429.

درخواست cURL

curl -sS https://servix.cc/api/v1/assets/USD_RLS \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  --data '{"fromDate":"2026-04-01","toDate":"2026-04-13"}'

پاسخ نمونهٔ امن

[
  {
    "code": "USD_RLS",
    "name": "USD_RLS",
    "slug": "usd_rls",
    "labelEn": "US Dollar / Iranian Rial",
    "labelFa": "دلار آمریکا / ریال ایران",
    "quoteUnit": "RLS",
    "value": "<protected-market-value>",
    "businessTime": "<source-timestamp>",
    "buyPrice": "<protected-market-value>",
    "sellPrice": "<protected-market-value>"
  }
]

GET `/api/v1/status`

اطلاعات عمومی سرویس مانند نسخه API، زمان سرور، لینک مستندات و نام مسیرهای موجود را برمی گرداند.

احراز هویت: عمومی است و به کلید API نیاز ندارد.
پارامترها یا بدنه: ندارد.
سهمیه: از سهمیه کم نمی‌کند.
خطاهای مهم: 500 خطای داخلی سرویس.

درخواست cURL

curl -sS https://servix.cc/api/v1/status

پاسخ نمونهٔ امن

{
  "status": "OK",
  "application": "price_app",
  "apiVersion": "v1",
  "serverTime": "<response-timestamp>",
  "documentationUrl": "<documentation-url>",
  "endpoints": [
    "GET /api/v1/assets",
    "GET /api/v1/assets/supported",
    "GET /api/v1/assets/{assetName}",
    "GET /api/v1/assets/{assetName}/{date}",
    "GET /api/v1/assets/{assetName}/history?from=YYYY-MM-DD&to=YYYY-MM-DD",
    "GET /api/v1/assets/{assetCode}/ohlc?interval=15m&from=<UTC-time>&to=<UTC-time>",
    "POST /api/v1/assets/{assetName}",
    "GET /api/v1/status",
    "GET /api/v1/access"
  ]
}

GET `/api/v1/access`

نوع دسترسی فعلی حساب و اجباری بودن درج منبع را برمی‌گرداند.

احراز هویت: کلید API در X-API-Key یا Authorization: ApiKey.
پارامترها یا بدنه: ندارد.
سهمیه: از سهمیهٔ مسیرهای assets کم نمی‌کند.
خطاهای مهم: 401 کلید نامعتبر یا ارسال‌نشده؛ 403 حساب محدودشده؛ 500 خطای داخلی سرویس.

درخواست cURL

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

پاسخ نمونهٔ امن

{
  "accessType": "FREE_STARTER",
  "attributionRequired": true
}

نمونه‌ها

نمونه‌های آماده برای درخواست و پاسخ

همه نمونه‌کدها مانند پنل ویرایشگر نمایش داده شده‌اند تا بتوانید به‌راحتی آن‌ها را بخوانید و در ابزارهای خود کپی کنید.

درخواست یک دارایی

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

نمونه JavaScript fetch

const response = await fetch("https://servix.cc/api/v1/assets/USD_RLS", {
  headers: { "X-API-Key": "<your-api-key>" }
});
const data = await response.json();

نمونه پاسخ

{
  "code": "USD_RLS",
  "name": "USD_RLS",
  "slug": "usd_rls",
  "labelEn": "US Dollar / Iranian Rial",
  "labelFa": "دلار آمریکا / ریال ایران",
  "quoteUnit": "RLS",
  "value": "<protected-market-value>",
  "businessTime": "<source-timestamp>",
  "buyPrice": "<protected-market-value>",
  "sellPrice": "<protected-market-value>",
  "midPrice": "<protected-market-value>"
}

بدنه بازه تاریخی

curl -sS "https://servix.cc/api/v1/assets/USD_RLS/history?from=2026-04-01&to=2026-04-13" \
  -H "X-API-Key: <your-api-key>"

ساختار پاسخ خطا

{
  "status": 417,
  "code": "INVALID_DATE_RANGE",
  "message": "The requested date range is not valid.",
  "timestamp": "<response-timestamp>",
  "path": "/api/v1/assets/USD_RLS/history",
  "requestId": "req_example"
}

فهرست خلاصه نمادهای پشتیبانی‌شده

USD_RLS  |  دلار آمریکا / ریال ایران
EUR_RLS  |  یورو / ریال ایران
SEKKEH_RLS  |  سکه امامی / ریال ایران
NIM_SEKKEH_RLS  |  نیم سکه / ریال ایران
ROB_SEKKEH_RLS  |  ربع سکه / ریال ایران
BAHAR_RLS  |  سکه بهار آزادی / ریال ایران
GOLD_18_RLS  |  طلای ۱۸ عیار / ریال ایران
GOLD_OUNCE_USD  |  اونس طلا / دلار آمریکا
SILVER_OUNCE_USD  |  اونس نقره / دلار آمریکا
PLATINUM_OUNCE_USD  |  اونس پلاتین / دلار آمریکا
BTC_USD  |  بیت‌کوین / دلار آمریکا
ETH_USD  |  اتریوم / دلار آمریکا
USDT_USD  |  تتر / دلار آمریکا
BNB_USD  |  بی‌ان‌بی / دلار آمریکا
XRP_USD  |  ایکس‌آرپی / دلار آمریکا
USDC_USD  |  یو‌اس‌دی کوین / دلار آمریکا
SOL_USD  |  سولانا / دلار آمریکا
TRX_USD  |  ترون / دلار آمریکا
HYPE_USD  |  هایپرلیکویید / دلار آمریکا
DOGE_USD  |  دوج‌کوین / دلار آمریکا
ZEC_USD  |  زی‌کش / دلار آمریکا
LINK_USD  |  چین‌لینک / دلار آمریکا
ADA_USD  |  کاردانو / دلار آمریکا
XLM_USD  |  استلار / دلار آمریکا
DAI_USD  |  دای / دلار آمریکا
BCH_USD  |  بیت‌کوین کش / دلار آمریکا
USDE_USD  |  یو‌اس‌دی‌ای / دلار آمریکا
USD1_USD  |  یو‌اس‌دی وان / دلار آمریکا
CC_USD  |  کانتون کوین / دلار آمریکا
LTC_USD  |  لایت‌کوین / دلار آمریکا
USDG_USD  |  گلوبال دلار / دلار آمریکا
HBAR_USD  |  هدرا / دلار آمریکا
AVAX_USD  |  اولانچ / دلار آمریکا
SUI_USD  |  سویی / دلار آمریکا
SHIB_USD  |  شیبا اینو / دلار آمریکا
PYUSD_USD  |  پی‌پل یو‌اس‌دی / دلار آمریکا
XAUT_USD  |  تتر گلد / دلار آمریکا
CRO_USD  |  کرونوس / دلار آمریکا
TAO_USD  |  بیت‌تنسور / دلار آمریکا
UNI_USD  |  یونی‌سواپ / دلار آمریکا
NEAR_USD  |  نیر پروتکل / دلار آمریکا
OKB_USD  |  اوکی‌بی / دلار آمریکا
PAXG_USD  |  پکس گلد / دلار آمریکا
WLFI_USD  |  ورلد لیبرتی فایننشال / دلار آمریکا
RLUSD_USD  |  ریپل یو‌اس‌دی / دلار آمریکا
ASTER_USD  |  استر / دلار آمریکا
ONDO_USD  |  اوندو / دلار آمریکا
MNT_USD  |  منتل / دلار آمریکا
M_USD  |  ام / دلار آمریکا
USDD_USD  |  یو‌اس‌دی‌دی / دلار آمریکا
AAVE_USD  |  آوه / دلار آمریکا
PUMP_USD  |  پامپ / دلار آمریکا
SKY_USD  |  اسکای / دلار آمریکا
DOT_USD  |  پولکادات / دلار آمریکا
WLD_USD  |  ورلدکوین / دلار آمریکا
ICP_USD  |  اینترنت کامپیوتر / دلار آمریکا
PEPE_USD  |  پپه / دلار آمریکا
ATOM_USD  |  کازماس / دلار آمریکا
BTC_RLS  |  بیت‌کوین / ریال ایران
ETH_RLS  |  اتریوم / ریال ایران
USDT_RLS  |  تتر / ریال ایران
BNB_RLS  |  بی‌ان‌بی / ریال ایران
XRP_RLS  |  ایکس‌آرپی / ریال ایران
USDC_RLS  |  یو‌اس‌دی کوین / ریال ایران
SOL_RLS  |  سولانا / ریال ایران
TRX_RLS  |  ترون / ریال ایران
HYPE_RLS  |  هایپرلیکویید / ریال ایران
DOGE_RLS  |  دوج‌کوین / ریال ایران
ZEC_RLS  |  زی‌کش / ریال ایران
LINK_RLS  |  چین‌لینک / ریال ایران
ADA_RLS  |  کاردانو / ریال ایران
XLM_RLS  |  استلار / ریال ایران
DAI_RLS  |  دای / ریال ایران
BCH_RLS  |  بیت‌کوین کش / ریال ایران
USDE_RLS  |  یو‌اس‌دی‌ای / ریال ایران
USD1_RLS  |  یو‌اس‌دی وان / ریال ایران
CC_RLS  |  کانتون کوین / ریال ایران
LTC_RLS  |  لایت‌کوین / ریال ایران
USDG_RLS  |  گلوبال دلار / ریال ایران
HBAR_RLS  |  هدرا / ریال ایران
AVAX_RLS  |  اولانچ / ریال ایران
SUI_RLS  |  سویی / ریال ایران
SHIB_RLS  |  شیبا اینو / ریال ایران
PYUSD_RLS  |  پی‌پل یو‌اس‌دی / ریال ایران
XAUT_RLS  |  تتر گلد / ریال ایران
CRO_RLS  |  کرونوس / ریال ایران
TAO_RLS  |  بیت‌تنسور / ریال ایران
UNI_RLS  |  یونی‌سواپ / ریال ایران
NEAR_RLS  |  نیر پروتکل / ریال ایران
OKB_RLS  |  اوکی‌بی / ریال ایران
PAXG_RLS  |  پکس گلد / ریال ایران
WLFI_RLS  |  ورلد لیبرتی فایننشال / ریال ایران
RLUSD_RLS  |  ریپل یو‌اس‌دی / ریال ایران
ASTER_RLS  |  استر / ریال ایران
ONDO_RLS  |  اوندو / ریال ایران
MNT_RLS  |  منتل / ریال ایران
M_RLS  |  ام / ریال ایران
USDD_RLS  |  یو‌اس‌دی‌دی / ریال ایران
AAVE_RLS  |  آوه / ریال ایران
PUMP_RLS  |  پامپ / ریال ایران
SKY_RLS  |  اسکای / ریال ایران
DOT_RLS  |  پولکادات / ریال ایران
WLD_RLS  |  ورلدکوین / ریال ایران
ICP_RLS  |  اینترنت کامپیوتر / ریال ایران
PEPE_RLS  |  پپه / ریال ایران
ATOM_RLS  |  کازماس / ریال ایران
GOLD_MESGHAL_RLS  |  مثقال طلا / ریال ایران
GOLD_24_RLS  |  طلای ۲۴ عیار / ریال ایران
STOCK_IR  |  شاخص بورس ایران
AFN_RLS  |  افغانی افغانستان / ریال ایران
AED_RLS  |  درهم امارات / ریال ایران
AMD_RLS  |  درام ارمنستان / ریال ایران
AZN_RLS  |  منات آذربایجان / ریال ایران
BHD_RLS  |  دینار بحرین / ریال ایران
BRL_RLS  |  رئال برزیل / ریال ایران
GBP_RLS  |  پوند انگلیس / ریال ایران
CAD_RLS  |  دلار کانادا / ریال ایران
CHF_RLS  |  فرانک سوئیس / ریال ایران
DKK_RLS  |  کرون دانمارک / ریال ایران
GEL_RLS  |  لاری گرجستان / ریال ایران
GERAMI_SEKKEH_RLS  |  سکه گرمی / ریال ایران
HKD_RLS  |  دلار هنگ کنگ / ریال ایران
INR_RLS  |  روپیه هند / ریال ایران
IQD_RLS  |  دینار عراق / ریال ایران
KWD_RLS  |  دینار کویت / ریال ایران
MYR_RLS  |  رینگیت مالزی / ریال ایران
NOK_RLS  |  کرون نروژ / ریال ایران
NZD_RLS  |  دلار نیوزیلند / ریال ایران
OMR_RLS  |  ریال عمان / ریال ایران
PKR_RLS  |  روپیه پاکستان / ریال ایران
QAR_RLS  |  ریال قطر / ریال ایران
SAR_RLS  |  ریال عربستان / ریال ایران
SEK_RLS  |  کرون سوئد / ریال ایران
SGD_RLS  |  دلار سنگاپور / ریال ایران
THB_RLS  |  بات تایلند / ریال ایران
TRY_RLS  |  لیر ترکیه / ریال ایران
AUD_RLS  |  دلار استرالیا / ریال ایران
JPY_RLS  |  ین ژاپن / ریال ایران
CNY_RLS  |  یوان چین / ریال ایران
RUB_RLS  |  روبل روسیه / ریال ایران
SYP_RLS  |  لیره جدید سوریه / ریال ایران
SYP_USD  |  لیره جدید سوریه / دلار آمریکا
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  |  بات تایلند / دلار آمریکا