نِت اَرز · مستندات API نرخ ارز
همهٔ مستندات
تابلوی نرخ مرجع تعاملی کلید رایگان

وضعیت و حساب

GET /status برای سلامت سرویس و تازگی نرخ، GET /me برای اپ، طرح و سهمیهٔ امروز، و هدرهای سهمیه که در هر پاسخ API نرخ ارز برمی‌گردند.

base_url: https://netarz.ir/api/fx/v1 دلار امروز: ۲۷۳,۶۰۰ تومان به‌روزرسانی: 1405/06/14

سلامت سرویس

GET /api/fx/v1/status رایگان + پرو

برای مانیتورینگ و برای این‌که قبل از نمایش نرخ بدانید چقدر تازه است. as_of نرخی است که شما می‌گیرید (با تأخیر طرح)، live_updated_at آخرین به‌روزرسانی واقعی بازار.

cURL
curl https://netarz.ir/api/fx/v1/status \
  -H "Authorization: Bearer $NETARZ_FX_KEY"
پاسخ
{
  "data": {
    "status": "ok", "version": "1.0.0",
    "usd_irt": 102400, "as_of": "2026-09-05T10:20:00+03:30",
    "live_updated_at": "2026-09-05T10:20:00+03:30", "refresh_interval_minutes": 5, "auto_updated": true,
    "currencies": 32, "server_time": "2026-09-05T10:21:02+03:30"
  }
}

اپ و سهمیه

GET /api/fx/v1/me رایگان + پرو

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

هدرهای هر پاسخ

هدرها
HTTP/1.1 200 OK
Content-Type: application/json
X-FX-Plan: pro
X-FX-Delayed-Minutes: 0
X-Quota-Limit: 200000
X-Quota-Remaining: 198567
X-Quota-Reset: 2026-09-05T20:29:59+00:00
X-RateLimit-Limit: 600
X-RateLimit-Remaining: 599
Cache-Control: no-store, private
هدرمعنا
X-FX-Planطرح اپ: free / pro.
X-FX-Delayed-Minutesتأخیر نرخ سروشده.
X-Quota-Limit / X-Quota-Remainingسهمیهٔ روزانه و باقی‌مانده.
X-Quota-Resetزمان صفرشدن سهمیه (پایان روز به وقت تهران، به UTC).
X-RateLimit-Limit / X-RateLimit-Remainingمحدودیت در دقیقه. در ۴۲۹، Retry-After هم می‌آید.

در مرورگر این هدرها با Access-Control-Expose-Headers قابل خواندن‌اند: res.headers.get("X-Quota-Remaining").