ناروال المستندات
العربية
مرجع APIالموقع
تصفّح الوثائق كلها

مرجع واجهة API للأسهم

بيانات يومية عبر REST وMCP، بالإضافة إلى بث WebSocket مدفوع لثمانية أسهم بالدولار الأمريكي.

العمليات

إرسال Authorization: Bearer YOUR_API_KEY إلى https://api.narwhalapi.comتتوفر MCP على /mcpاستخدم معرّف الأداة الحقيقي الذي يعيده الاكتشاف.

مسار GETأداة MCP
/v1/equities/instrumentsequities_list_instruments
/v1/equities/instruments/{instrument_id}equities_get_instrument
/v1/equities/instruments/{instrument_id}/barsequities_get_bars
curl "https://api.narwhalapi.com/v1/equities/instruments?symbol=AAPL" \
  -H "Authorization: Bearer $NARWHAL_API_KEY"

المعلمات

يقبل الاكتشاف اختياريًا symbol, mic_code و country، بالإضافة إلى page (الافتراضي 1) و outputsize (الافتراضي 100، الحد الأقصى 5,000).

تتطلب الأشرطة instrument_idالقيم المدعومة هي interval=1day و adjust=splitsاختياري start_date و end_date استخدم YYYY-MM-DD. outputsize الافتراضي 30 والحد الأقصى 5,000.

الاستجابات والحدود

يعيد الاكتشاف والتفاصيل count, data و statusتتضمن كل أداة معرّفها ورمزها واسمها وعملتها وبورصتها وMIC ودولتها ونوع السهم العادي.

تعيد الأشرطة meta, values و statusتتضمن البيانات الوصفية العملة والمنطقة الزمنية للبورصة وMIC. وتحتوي القيم على datetime, open, high, low, close و volume، مرتبة من الأحدث إلى الأقدم. الأسعار والحجم سلاسل عشرية.

يغطي كتالوج REST وMCP عدد 102 من الأدوات المقبولة والجلسات اليومية المغلقة. أما أشرطة التداول خلال اليوم والأرباح والأساسيات فتقع خارج هذا الإصدار. وتستهلك استدعاءات REST وMCP الناجحة الحصة المشتركة نفسها.

اقرأ المنهجية ونطاق التغطيةالـ مخطط OpenAPI لوقت التشغيل يحدد التحقق الدقيق واستجابات الأخطاء.

بث عروض الأسعار · Basic وPro

الاتصال بـ wss://api.narwhalapi.com/v1/equities/stream بمفتاح Narwhal Basic أو Pro نشط. يرسل عملاء الخادم Authorization: Bearer YOUR_API_KEY أثناء ترقية WebSocket. هذا البروتوكول منفصل عن REST وMCP.

الرموز المدعومة هي ADSK, ALL, APD, ASML, EBAY, DOW, KMX, DVA، مسعّرة بالدولار الأمريكي. لا يعني كتالوج البيانات اليومية توفر تغطية البث.

انتظر الـ ready الرسالة، ثم أرسل كل أمر كإطار نص JSON منفصل:

{"action":"subscribe","symbols":["ADSK","ALL"]}
{"action":"unsubscribe","symbols":["ALL"]}
{"action":"ping"}

تتضمن عروض الأسعار symbol, currency، سلسلة عشرية price, source_timestamp, received_at, delivered_at, source_age_seconds, stale و snapshotنوعها هو quote. market_status هو not_evaluated؛ يؤدي تجاوز عمر المصدر 60 ثانية إلى تعيين stale=true.

يستهلك كل سعر مقبول وحدة واحدة من الحصة الشهرية المشتركة، بما في ذلك اللقطات المخزنة مؤقتًا. وتنطبق أيضًا حدود معدل الحساب والدفعة. ويستهلك اتصالان يتلقيان السعر نفسه وحدتين. الأوامر غير محسوبة؛ استخدم 30 أمرًا كحد أقصى لكل جلسة، وإطارات نصية لا تتجاوز 2 KiB.

يمكن لكل حساب فتح اتصالين متزامنين. تستمر الجلسات 180 ثانية كحد أقصى؛ أعد الاتصال مع تراجع وأعد الاشتراك. يؤدي سحب الوصول أو عدم توفر البيانات أو استنفاد الحصة أو بطء المستهلك إلى إغلاق الاتصال. وقد يفشل التسليم بعد أن يستهلك السعر حصة.

تقبل اتصالات المتصفح حاليًا فقط https://narwhalapi.com المصدر. ويرسلون {"action":"auth","api_key":"YOUR_API_KEY"} خلال خمس ثوانٍ، قبل الاشتراك. تُرفض أصول المتصفح الأخرى؛ استخدم عميلاً خادمياً لتكاملك. لا تضع المفتاح في URL ولا تنشره في كود العميل.

عرض خطتي Basic وPro أو قراءة حدود النطاق والطابع الزمني للبث.