Accueil›Documentation

شروع سریع API BODACC

داده باز و رایگان

API باداک رایگان و باز است: دسترسی به داده‌های باز و بلادرنگ پایگاه داده کامل بولتن رسمی را فراهم می‌کند — ۱۱.۳ میلیون آگهی، ۶.۷ میلیون شرکت، ۱.۹ میلیون شخص (اعداد زنده stats/counts). در حالی که فایل تاریخی باداک یک بار در روز دانلود می‌شود، API آگهی‌ها را از لحظه انتشار بدون کلید برای داده‌های عمومی ارائه می‌دهد.

# شمارنده‌های دقیق، بدون کلید
curl "https://bodacc.io/api/bodacc/stats/counts"

اولین فراخوانی

API عمومی باداک برای داده‌ها بدون کلید قابل دسترسی است. پرکاربردترین نقطه پایانی، جستجوی آگهی‌ها با کلمه کلیدی است:

curl "https://bodacc.io/api/bodacc/annonces?q=boulangerie&limit=5"

پاسخ (بخشی از آن):

{
  "total": 48231,
  "results": [
    {
      "id": "A2023001_000123",
      "dateparution": "2026-08-07",
      "typeavis": "A",
      "familleavis": "creation",
      "commercant": "BOULANGERIE DUPONT",
      "ville": "LYON",
      "numerodepartement": "69"
    }
  ],
  "limit": 5,
  "offset": 0
}

مشخصات کامل

API شامل ۴۶ نقطه پایانی است (تأیید شده در OpenAPI زنده). دو راه برای کاوش آن‌ها:

  • رابط Swagger: https://bodacc.io/api/bodacc/docs
  • https://bodacc.io/api/bodacc/openapi.json

نقاط پایانی اصلی

نقطه پایانیتوضیحات
GET /api/bodacc/annoncesجستجوی آگهی‌ها (کلمه کلیدی، خانواده، شهر، بخش، SIREN، تاریخ‌ها)
GET /api/bodacc/annonces/{id}جزئیات یک آگهی + روابط (شرکت، اشخاص)
GET /api/bodacc/entreprisesجستجوی شرکت‌ها (نام، SIREN، NAF، وضعیت، فیلترهای پیشرفته)
GET /api/bodacc/entreprises/{siren}پرونده کامل یک SIREN
GET /api/bodacc/personnes/{id}پرونده شخص (هویت + سمت‌ها)
GET /api/bodacc/annuaire/{role}فهرست تصفیه‌کنندگان، نمایندگان، مدیران
GET /api/bodacc/stats/countsشمارنده‌های کلی (آگهی‌ها، شرکت‌ها، اشخاص)

احراز هویت

دسترسی عمومی به هیچ کلیدی نیاز ندارد. برای طرح‌های حرفه‌ای و سازمانی، نقاط پایانی مستند شده یک کلید API را می‌پذیرند:

curl "https://bodacc.io/api/bodacc/annonces?q=boulangerie" \
  -H "X-API-Key: sk_bodacc_..."

کلید همچنین می‌تواند به صورت Authorization: Bearer sk_bodacc_... ارسال شود. کلید نامعتبر یا لغو شده، پاسخ 401 برمی‌گرداند.

خطاها

API خطاهای HTTP استاندارد را با بدنه JSON حاوی جزئیات مشکل برمی‌گرداند:

  • 400: پارامتر نامعتبر
  • 401: کلید API نامعتبر یا لغو شده
  • 404: منبع یافت نشد
  • 429: درخواست‌های بیش از حد — به هدر Retry-After احترام بگذارید

محدودیت‌ها

  • limit: بین ۱ تا ۵۰۰ در هر درخواست
  • offset: تا ۱۰,۰۰۰ (صفحه‌بندی ضد استخراج)
  • داده‌ها پس از هر انتشار باداک به صورت بلادرنگ به‌روزرسانی می‌شوند
  • جستجو بر اساس خانواده از مجموع‌های دقیق مادی‌شده استفاده می‌کند (total_estime وجود ندارد)؛ جستجوهای متنی ترکیبی ممکن است مجموع تخمینی برگردانند ("total_estime": true)

گام‌های بعدی

FAQ

سوالی دارید؟

تیم ما به سرعت پاسخ می‌دهد. درخواست شما با دسته API منتقل می‌شود.