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

مستندات

مستندات وب‌سرویس و API قیمت بازار ایران

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

curl -sS https://servix.cc/api/v1/assets/USD_RLS \
  -H "X-API-Key: pk_live_your_key_here"

اندپوینت‌ها

اندپوینت‌های موجود برای دارایی‌ها

حساب تست

با یک حساب آزمایشی که خودتان فعال می‌کنید شروع کنید.

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

۰۱

ورود به حساب

ابتدا ثبت‌نام کنید یا وارد حساب شوید. صرف ثبت‌نام، حساب آزمایشی را ایجاد یا فعال نمی‌کند.

۰۲

فعال‌سازی از داشبورد

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

۰۳

مشاهده کلید API

به مسیر «پروفایل ← کلیدهای API» بروید و کلید ساخته‌شده را نمایش دهید؛ سپس در محدوده سهمیه روزانه درخواست‌های دارای احراز هویت بفرستید.

امنیت کلید API

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

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

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

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

https://servix.cc/api/v1/assets/USD_RLS?api_key=pk_live_your_key_here

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

curl -sS https://servix.cc/api/v1/assets/USD_RLS \
  -H "X-API-Key: pk_live_your_key_here"

curl -sS https://servix.cc/api/v1/assets/USD_RLS \
  -H "Authorization: ApiKey pk_live_your_key_here"

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

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

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

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

راهنمای خرید

از ثبت سفارش تا اولین درخواست موفق.

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

۰۱

انتخاب پلن

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

۰۲

تکمیل خرید

وارد حساب شوید، سفارش را تأیید کنید و با بیت‌کوین یا روش پرداخت دستی، خرید را تکمیل کنید.

۰۳

نمایش کلید API

پس از تکمیل پرداخت، به مسیر «پروفایل ← کلیدهای API» بروید و کلید فعال را نمایش دهید. مقدار کامل کلید فقط یک‌بار نشان داده می‌شود.

۰۴

ارسال درخواست با کلید API

کلید را در هدر X-API-Key یا به‌شکل Authorization: ApiKey ... قرار دهید و دریافت داده‌های قیمت را شروع کنید.

احراز هویت

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

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

  • هر درخواست موفق به اندپوینت‌های دارایی در سهمیه روزانه پلن شما حساب می‌شود.
  • فهرست کامل دارایی‌ها، آخرین رکورد یک دارایی، رکورد یک تاریخ مشخص و تاریخچه یک بازه زمانی، همگی از طریق همین API دارایی‌ها در دسترس‌اند.
X-API-Key: pk_live_your_key_here
Authorization: ApiKey pk_live_your_key_here

اندپوینت‌ها

اندپوینت‌های موجود برای دارایی‌ها

این مسیرها دقیقاً با پیاده‌سازی فعلی بک‌اند هماهنگ‌اند.

GET /api/v1/assets

فهرست کامل آخرین قیمت دارایی‌های پشتیبانی‌شده را برمی گرداند.

GET /api/v1/assets/USD_RLS

آخرین قیمت یک کد دارایی را برمی گرداند.

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

قیمت یک دارایی را در یک تاریخ مشخص برمی گرداند.

POST /api/v1/assets/USD_RLS

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

GET /api/v1/assets/supported

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

GET /api/v1/status

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

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

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

نمونه‌ها

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

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

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

curl -sS https://servix.cc/api/v1/assets/USD_RLS \
  -H "X-API-Key: pk_live_your_key_here"

نمونه JavaScript fetch

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

نمونه پاسخ

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

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

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

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

{
  "status": 417,
  "code": "INVALID_DATE_RANGE",
  "message": "The requested date range is not valid.",
  "timestamp": "2026-04-13T12:00:00Z",
  "path": "/api/v1/assets/USD_RLS/history",
  "requestId": "req_example"
}

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

Plain text
دریافت فایل نمونه
USD_RLS  |  دلار آمریکا / ریال ایران
EUR_RLS  |  یورو / ریال ایران
SEKKEH_RLS  |  سکه امامی / ریال ایران
NIM_SEKKEH_RLS  |  نیم سکه / ریال ایران
ROB_SEKKEH_RLS  |  ربع سکه / ریال ایران
BAHAR_RLS  |  سکه بهار آزادی / ریال ایران
GERAMI_SEKKEH_RLS  |  سکه گرمی / ریال ایران
GOLD_18_RLS  |  طلای ۱۸ عیار / ریال ایران
GOLD_OUNCE_USD  |  اونس طلا / دلار آمریکا
SILVER_OUNCE_USD  |  اونس نقره / دلار آمریکا
PLATINUM_OUNCE_USD  |  اونس پلاتین / دلار آمریکا
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  |  لاری گرجستان / ریال ایران
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  |  روبل روسیه / ریال ایران
BTC_USD  |  بیت‌کوین / دلار آمریکا
ETH_USD  |  اتریوم / دلار آمریکا
USDT_USD  |  تتر / دلار آمریکا
USDC_USD  |  یو‌اس‌دی کوین / دلار آمریکا
SOL_USD  |  سولانا / دلار آمریکا
XRP_USD  |  ایکس‌آرپی / دلار آمریکا
ADA_USD  |  کاردانو / دلار آمریکا
DOGE_USD  |  دوج‌کوین / دلار آمریکا
DOT_USD  |  پولکادات / دلار آمریکا
LTC_USD  |  لایت‌کوین / دلار آمریکا
LINK_USD  |  چین‌لینک / دلار آمریکا
AVAX_USD  |  اولانچ / دلار آمریکا
XLM_USD  |  استلار / دلار آمریکا
ATOM_USD  |  کازماس / دلار آمریکا