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

خطاها

همهٔ کدهای خطای API نرخ ارز نِت اَرز با وضعیت HTTP، معنای هر خطا و راه رفع آن؛ از کلید نامعتبر و دامنهٔ تأییدنشده تا سهمیهٔ تمام‌شده و قابلیت‌های طرح پرو.

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

همهٔ خطاها یک شکل دارند: وضعیت HTTP معنادار، شیء error با code ثابت (برای کد شما)، message فارسی (برای انسان)، status و لینک docs که به همین صفحه می‌آید. بسته به خطا، فیلدهای کمکی هم اضافه می‌شود.

قالب خطا
{
  "error": {
    "code": "origin_not_allowed",
    "message": "درخواست از دامنهٔ «evil.example» برای این اپ مجاز نیست. دامنهٔ ثبت‌شده: example.com",
    "status": 403,
    "docs": "https://netarz.ir/docs/fx/errors#origin_not_allowed",
    "origin": "evil.example",
    "allowed": ["example.com", "*.example.com"]
  }
}
خطای اعتبارسنجی
{
  "error": {
    "code": "validation_failed",
    "message": "The amount field must be at least 0.",
    "status": 422,
    "errors": { "amount": ["The amount field must be at least 0."] },
    "docs": "https://netarz.ir/docs/fx/errors#validation_failed"
  }
}

فهرست کدها

HTTPcodeمعنا و راه‌حل
400invalid_requestپارامتر نامعتبر (توضیح در message).
400unknown_currencyدر convert: from یا to ناشناخته (param می‌گوید کدام).
400invalid_rangeمقدار range خارج از 1h/24h/7d/30d/90d/1y/3y/5y/10y/all.
400invalid_timefrom/to/at تاریخ معتبری نیست (ISO 8601 یا Unix timestamp).
400invalid_windowfrom بعد از to است.
400interval_too_smallinterval کمتر از حداقل (۵ دقیقه).
400period_too_smallperiod کندل کمتر از ۱۵ دقیقه.
400too_many_pointsبازه ÷ interval بیشتر از سقف نقاط؛ interval بزرگ‌تر بدهید.
400archive_is_dailyinterval یا period کمتر از یک روز برای پیش از شروع ثبت درون‌روزی (فیلد intraday_since)؛ 1d یا بزرگ‌تر بدهید.
400invalid_dateتاریخ archive به شکل YYYY-MM-DD (میلادی یا شمسی) نیست.
400invalid_webhook_urlآدرس وبهوک https نیست یا به آدرس داخلی اشاره می‌کند.
401missing_api_keyهدر Authorization / X-API-Key نیست.
401invalid_api_keyکلید وجود ندارد.
401app_disabledاپ از پنل متوقف شده.
402pro_requiredامکان فقط در پرو (فیلد upgrade_url): تاریخچه، آرشیو، OHLC، آمار، snapshot، هشدار و استریم.
403app_suspendedاپ توسط نِت اَرز معلق شده؛ دلیل در message.
403domain_not_verifiedمالکیت دامنه تأیید نشده.
403origin_not_allowedOrigin/Referer با دامنه‌های اپ نمی‌خواند (فیلدهای origin و allowed).
403origin_requiredبدون Origin/Referer و بدون IP مجاز؛ IP سرور را در پنل مجاز کنید.
403ip_not_allowedIP درخواست در فهرست مجاز نیست (فیلد ip).
403outside_history_windowsnapshot یا archive خارج از پنجرهٔ تاریخچهٔ طرح (فیلد earliest).
403alert_limit_reachedسقف هشدار هر اپ پر است.
404unknown_currencyکد ارز در فهرست نیست (rates/history/ohlc/stats/snapshot).
404no_dataبرای این بازه یا لحظه داده‌ای ثبت نشده.
404alert_not_foundهشدار با این شناسه برای این اپ نیست.
422validation_failedاعتبارسنجی ورودی (فیلد errors به تفکیک پارامتر).
429rate_limit_exceededمحدودیت در دقیقه (اپ یا IP). Retry-After را بخوانید.
429daily_quota_exceededسهمیهٔ روزانه تمام شده (فیلدهای quota, used, plan).
429too_many_failed_attemptsکلیدهای اشتباه زیاد از این IP؛ چند دقیقه صبر کنید.
429too_many_streamsاستریم همزمان بیش از حد برای این اپ.
503service_disabledسرویس موقتاً توسط نِت اَرز خاموش است.
کد را بررسی کنید، نه پیام را

پیام‌ها ممکن است بهتر شوند؛ codeها ثابت می‌مانند. برای ۴۲۹ به Retry-After و برای ۴۰۲ به upgrade_url نگاه کنید.