القسم الحالي: رموز الأخطاء

رموز الأخطاء

تستخدم الواجهة رموز حالة HTTP القياسية وتعيد أخطاء منظمة بصيغة JSON.

رموز أخطاء HTTP

400INVALID_ROUTE

تم استخدام مسار نقطة نهاية خاطئ، وتعيد API اقتراحاً للمسار الصحيح.

401detail

ترويسة X-API-Key مفقودة.

403detail

صيغة مفتاح API غير صالحة، أو أن المفتاح غير صالح أو ملغى.

403PLAN_LIMIT

تتطلب نقطة النهاية باقة أعلى (مثلاً تتطلب البيانات التاريخية Starter+، أو طُلبت تركيبات مالية أعلى ضمن Starter).

404INVALID_SYMBOL

لم يتم العثور على رمز التداول.

404 / 409INVALID_IDENTIFIER / AMBIGUOUS_IDENTIFIER

لم تتم مطابقة استعلام المعرّف، أو طابق عدة شركات.

429detail

تم بلوغ حد يومي أو حد ذروة (burst) أو حد IP أو حد أمني مؤقت.

500SERVER_ERROR

خطأ داخلي في الخادم. أعد المحاولة أو تواصل مع الدعم.

قد تصل بعض الحسابات المجانية الجديدة مؤقتاً إلى حد أمني. عند حدوث ذلك تعيد API HTTP 429 مع detail يحتوي على Temporary security limit reached. التزم بقيمة Retry-After عند توفرها، ثم حاول لاحقاً.

خطأ تكامل شائع: استدعاء GET /api/v1/quote/batch/ يعيد 400 INVALID_ROUTE مع إرشاد للمسار الصحيح.

json
{
  "error": {
    "code": "INVALID_ROUTE",
    "message": "Did you mean /api/v1/quotes/?symbols=2222,1120 ?"
  }
}

صيغ استجابات الأخطاء

تستخدم أخطاء التحقق والبحث في نقاط النهاية عادةً كائن error منظماً:

json
{
  "error": {
    "code": "INVALID_SYMBOL",
    "message": "Stock symbol '9999' not found."
  }
}

تستخدم أخطاء المصادقة والحد قيمة detail نصية في المستوى الأعلى:

json
{
  "detail": "Request was throttled. Expected available in 60 seconds."
}

آخر تحديث في