البدء السريع

1. احصل على مفتاح API (dk_live_…) من حسابك في دارك.
2. نفّذ طلبًا:

curl "https://api.darak.app/v1/listings?city=riyadh&listing_type=rent&limit=5" \
  -H "Authorization: Bearer $DARAK_API_KEY"

أو استخدم حزمة SDK رسمية تضيف الأنواع وتصفح الصفحات وإعادة المحاولة. تغطي الحزمتان كل نقاط النهاية هنا، وتُولّدان من هذه المواصفة.

// npm install @darak-app/sdk
import { Darak } from "@darak-app/sdk";

const darak = new Darak(); // reads DARAK_API_KEY
const page = await darak.listings.search({ city: "riyadh", listing_type: "rent", limit: 5 });

# pip install darak
from darak import Darak

darak = Darak()  # reads DARAK_API_KEY
page = darak.listings.search(city="riyadh", listing_type="rent", limit=5)

3. استخدم GET /cities وGET /cities/{city}/neighborhoods لمعرفة أسماء المدن المختصرة ومعرّفات الأحياء المقبولة في المرشّحات، وGET /enums لمعرفة القيم المسموح بها.

كل الاستجابات بصيغة JSON. تعود الكائنات المفردة بالشكل { "data": { … } }، والقوائم بالشكل { "data": [ … ], "pagination": { … } }.

أين تجد الموارد. وثيقة OpenAPI متاحة في /v1/openapi.json دون مفتاح. تُولّد منها الحزمتان، ويمكنك توليد عميلك الخاص أيضًا. تتوفر @darak-app/sdk على npm وdarak على PyPI. تُعلن التغييرات في سجل التغييرات، وله موجز RSS، وتظهر حالة الخدمة في صفحة الحالة. إذا حدث خطأ، ابحث عن الطلب باستخدام GET /organization/request-logs?request_id=… لمعرفة الحالة والخطأ والمعامل المسبب له، أو راسل [email protected] مع ذكر request_id.