تخطَّ إلى المحتوى الرئيسي

التوثيق

كل ما تحتاج إليه للتكامل

يُولَّد الدليل والمرجع والمواصفة من ملف OpenAPI واحد، لذا فهي متطابقة دائمًا. والمعرّفات هي نفسها في كل اللغات.

  • دليل التكامل

    الحصول على مفتاح، والمصادقة، والمرشّحات، وترقيم الصفحات، والحدود، والأخطاء، بلغتك.

    افتح الدليل

  • مواصفة OpenAPI

    ملف OpenAPI 3.1 الذي يُولَّد منه المرجع، لمولّدات الشيفرة وأدوات API.

    نزّل المواصفة

  • الدليل بصيغة PDF

    دليل التكامل في مستند واحد، لقراءته دون اتصال أو مشاركته مع فريقك.

    نزّل ملف PDF

التوثيق متاح للعموم. ولا تحتاج إلى مفتاح إلا لاستدعاء API.

البدء السريع

تحقّق من مفتاحك ومن العنوان الذي نراه
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
اقرأ الصفحة الأولى من الإعلانات لدولة ما
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

لمحة سريعة

عنوان URL الأساسي
https://api.housingmarketapi.com
المصادقة
المفتاح في الترويسة x-api-key، مُرسَلًا من عنوان الخادم المسجّل له.

نقاط النهاية

نقطة النهايةالخطةالوصف
GET /v1/pingالقياسيةيؤكد أن مفتاحك يعمل من العنوان المسجّل له، ويُعيد هذا العنوان.
GET /v1/propertiesالقياسيةالإعلانات المنشورة لدولة يغطيها مفتاحك، صفحةً تلو الأخرى.
GET /v1/insights/*المتقدمةبيانات سوق مجمّعة حسب المكان والفترة، لمفاتيح الخطة المتقدمة. قريبًا: نقاط النهاية هذه ليست مفعّلة بعد.

رموز الأخطاء

يحمل كل خطأ حالة HTTP وأحد هذه الرموز. ابنِ منطقك على الرمز، لا على الرسالة.

  • invalid_parameter
  • invalid_cursor
  • unauthenticated
  • ip_not_allowed
  • key_paused
  • country_not_entitled
  • upgrade_required
  • not_found
  • method_not_allowed
  • rate_limited
  • quota_exceeded
  • internal_error
  • not_configured
  • service_unavailable
احصل على مفتاح APIاطّلع على الأسعار