دليل التكامل مع Housing Market API
تُولَّد الجداول المرجعية وأوصاف نقاط النهاية ورموز الأخطاء والأمثلة من مواصفات API، وتبقى باللغة الإنجليزية في كل اللغات. الأسماء والمعاملات والرموز متطابقة في كل مكان.
ترقيم الصفحات
تستخدم كل نقطة نهاية تُعيد قائمةً مؤشراتٍ (cursors). تحمل الاستجابة data وnext_cursor وhas_more.
مرّروا قيمة next_cursor من استجابة على أنها cursor للطلب التالي، وتوقفوا عندما تكون قيمة has_more هي false.
لا يوجد إجمالي ولا أرقام صفحات. وهذا مقصود: فقد صُمّمت API للبحث عن الإعلانات، لا لنسخ قاعدة البيانات.
يحدد المعامل limit حجم الصفحة. قيمته الافتراضية 50 ولا يجوز أن تتجاوز 100.
المؤشر معتم. لا تحلّلوه ولا تنشئوا مؤشرًا بأنفسكم ولا تحتفظوا به لوقت لاحق. فهو مرتبط بمفتاحكم وبعوامل تصفية الطلب الذي أنتجه، ويُرفض المؤشر غير الصالح بالرمز invalid_cursor.
تأتي النتائج بترتيب ثابت ضمن عملية تصفح واحدة، لكن هذا الترتيب لا يحمل أي معنى. لا تعتمدوا عليه.
Response shape
| Field | Type | Description |
|---|---|---|
data required | array | The items on this page. |
next_cursor required | string | null | Pass as cursor to get the next page. Null on the last page. |
has_more required | boolean | False when there is no further page. |
Request parameters
| Parameter | Type | Required | Values | Description |
|---|---|---|---|---|
limit | integer | no | default 50min 1max 100 | Page size. At most the maximum shown; larger values are refused with invalid_parameter. |
cursor | string | no | The next_cursor of the previous page. Opaque: do not parse it, store
it, or build one. It is bound to your key and to the filters of the
request that produced it, and a cursor used with different filters is
refused with invalid_cursor. |