إنشاء تصدير

POST/exports

يبدأ تصدير مجموعة كاملة كملفات للمستودع. يعمل في الخلفية؛ استعلم عن GET /exports/{export_id} حتى status بالقيمة completed، ثم نزّل كل files. الروابط صالحة لساعة؛ اطلب GET مجددًا لتجديدها.

مجموعات البيانات

listings: كل إعلان نشط يطابق filters، صف لكل إعلان بالشكل المعاد في GET /listings. يتطلب نطاق exports في Pro وEnterprise.
listing_changes: أحداث الإعلانات بين filters.from وfilters.to حتى 366 يومًا: created وprice_changed مع كل تغيير وسعري قبل وبعد، وdelisted، مع الإعلان كما هو الآن. يبدأ السجل 2026-03-09 ويتطلب exports.
registered_transactions: صفقات وزارة العدل كما يعيدها GET /transactions. مجانية في كل خطة كبيانات مفتوحة وفق الرخصة السعودية. يرافق ATTRIBUTION.txt الملفات ويجب إبقاؤه مع البيانات.
registered_rents: خلايا مؤشر إيجار الهيئة كما يعيدها GET /market/registered-rents، مع حجب ما دون 5 عقود. مجانية في كل خطة مع ATTRIBUTION.txt.

الملفات. أجزاء حتى 25,000 صف، part-00001.ndjson.gz وغيرها، مستقلة مع تكرار رأس CSV. صفوف NDJSON كائنات API نفسها؛ يسطّح CSV إلى أعمدة منقّطة مثل price.yearly_sar والمصفوفات JSON. يسرد manifest.json الأجزاء والصفوف والأعمدة والمرشّحات والترخيص والملاحظات. تُحذف الملفات بعد 7 أيام من الاكتمال.

التكلفة. تُعد صادرات الإعلانات قبل الكتابة وتُحسب 1,000 وحدة لكل 1,000 صف مرة واحدة على الشهر لا الدقيقة؛ يعرض units المبلغ. إذا لم تغطها الحصة أو سقف الإنفاق أو المشروع تفشل دون احتساب. صادرات البيانات المفتوحة مجانية.

الحدود. 2 تصدير قيد الانتظار أو التشغيل معًا و20 يوميًا لكل مؤسسة ()، وحتى 2,000,000 صف للتصدير؛ قسّم الأكبر بحسب المدينة أو نوع العرض أو النطاق. أرسل لأمان POST عند التكرار.

الاسم	النوع	الوصف
`dataset`مطلوب	`string`	إحدى القيم: `listings`, `listing_changes`, `registered_transactions`, `registered_rents`
`filters`مطلوب	`object`	مرشّحات GET /listings بصيغة JSON. يقبل `city` و`listing_type` عدة قيم هنا والافتراضي كلها.
`format`	`string`	`ndjson` لكائن JSON في كل سطر، أو `csv`. إحدى القيم: `ndjson`, `csv`
`compression`	`string`	يضغط `gzip` الافتراضي كل ملف جزء. إحدى القيم: `gzip`, `none`

الاسم	النوع	الوصف
`id`مطلوب	`string`
`dataset`مطلوب	`string`	إحدى القيم: `listings`, `listing_changes`, `registered_transactions`, `registered_rents`
`format`مطلوب	`string`	إحدى القيم: `ndjson`, `csv`
`compression`مطلوب	`string`	إحدى القيم: `gzip`, `none`
`status`مطلوب	`string`	`queued` ثم `running` ثم `completed`، أو `failed`. تصبح `expired` بعد حذف الملفات. إحدى القيم: `queued`, `running`, `completed`, `failed`, `expired`
`filters`مطلوب	`object \| null`	كما طُلب. null بعد الاكتمال إذا عطّلت المؤسسة تخزين التفاصيل.
`price_source`مطلوب	`string`	مصدر السعر: `asking` للأسعار المطلوبة في الإعلانات، و`registered` للصفقات أو عقود الإيجار المسجلة. عادة تتجاوز أسعار العرض السعر النهائي المتفق عليه. إحدى القيم: `asking`, `registered`
`rows_estimated`مطلوب	`integer \| null`	الصفوف المعدودة قبل تصدير الإعلانات، أساس تكلفة `units`.
`row_count`مطلوب	`integer \| null`	الصفوف المكتوبة بعد الاكتمال.
`units`مطلوب	`integer`	الوحدات المحتسبة. 0 للمفتوحة، وتُرد عند الفشل.
`progress`مطلوب	`object`
`error`مطلوب	`object \| null`
`attribution`مطلوب	`object \| null`	للصادرات المفتوحة: إشعار الترخيص الموجود أيضًا في ATTRIBUTION.txt. أبقه مع البيانات.
`files`مطلوب	`object[]`	روابط التنزيل في GET /exports/{export_id} للتصدير المكتمل فقط.
`created_at`مطلوب	`string (date-time)`
`started_at`مطلوب	`string (date-time) \| null`
`completed_at`مطلوب	`string (date-time) \| null`
`expires_at`مطلوب	`string (date-time) \| null`	وقت حذف الملفات.

إنشاء تصدير

المعاملات

جسم الطلب

الاستجابة

مثال على الطلب

نقاط نهاية ذات صلة

الأدلة