{ "openapi": "3.0.1", "info": { "title": "France BODACC Scraper: SIREN, Insolvency & Legal Announcements", "description": "Scrape BODACC, France's official company legal-announcements gazette. Look up firms by SIREN, name or keyword: insolvency (procedures collectives), business sales (cessions de fonds de commerce), registrations, deregistrations and account filings. JSON, CSV, Excel.", "version": "0.1", "x-build-id": "3eAbu03HRiXpCua7n" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~france-bodacc-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-france-bodacc-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/scrapers_lat~france-bodacc-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-france-bodacc-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/scrapers_lat~france-bodacc-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-france-bodacc-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "query": { "title": "Search text or SIREN", "type": "string", "description": "Free-text search across company name, trader name, address and registration numbers (for example \"boulangerie\", a company name, or a 9 digit SIREN like \"552100554\"). Leave empty to list every announcement that matches the filters below." }, "companyName": { "title": "Company name (alias of query)", "type": "string", "description": "Alternative to Search text: match by company or trader name (partial match). If both are set, Search text wins." }, "sirens": { "title": "SIREN list (bulk lookup)", "uniqueItems": true, "type": "array", "description": "Look up one or more companies by their 9-digit SIREN, one per line. When provided, this overrides the free-text search and pulls every announcement for each SIREN (deduplicated).", "items": { "type": "string" } }, "keywords": { "title": "Keywords (OR)", "uniqueItems": true, "type": "array", "description": "One trade/activity term per line. Announcements matching ANY of the keywords are returned (logical OR). Combine with the filters below.", "items": { "type": "string" } }, "announcementType": { "title": "Announcement type", "enum": [ "", "collective", "creation", "immatriculation", "vente", "modification", "radiation", "dpc", "conciliation", "retablissement", "divers" ], "type": "string", "description": "Restrict to a single announcement family. Leave as \"Any type\" to include all. To combine several families, use \"Announcement types\" below instead.", "default": "" }, "announcementTypes": { "title": "Announcement types (multiple)", "uniqueItems": true, "type": "array", "description": "Restrict to several announcement families at once (logical OR). Use family codes: collective, creation, immatriculation, vente, modification, radiation, dpc, conciliation, retablissement, divers.", "items": { "type": "string" } }, "department": { "title": "Department code", "type": "string", "description": "Restrict to a French department by its 2 or 3 character code (for example \"75\" for Paris, \"13\" for Bouches-du-Rhone, \"2A\" for Corse-du-Sud). Optional." }, "departments": { "title": "Department codes (multiple)", "uniqueItems": true, "type": "array", "description": "Restrict to several French departments at once (logical OR), one code per line (for example 75, 92, 2A).", "items": { "type": "string" } }, "noticeType": { "title": "Notice type", "type": "string", "description": "Restrict to a notice classification, for example \"annonce\" (initial notice), \"rectificatif\" (correction) or \"annulation\" (cancellation). Optional." }, "dateFrom": { "title": "Published from", "type": "string", "description": "Only announcements published on or after this date (format YYYY-MM-DD, for example \"2025-01-01\"). Optional." }, "dateTo": { "title": "Published to", "type": "string", "description": "Only announcements published on or before this date (format YYYY-MM-DD, for example \"2025-12-31\"). Optional." }, "dedupeBySiren": { "title": "One row per company (dedupe by SIREN)", "type": "boolean", "description": "Return only the first (most relevant) announcement per SIREN, so each company appears once. Useful for lead lists.", "default": false }, "maxAnnouncements": { "title": "Max announcements", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of announcements to collect across all matching results. Free plans are capped at 10." }, "withCompanyHistory": { "title": "Company legal history (paid add-on)", "type": "boolean", "description": "For each result, attach the company's other BODACC announcements (a legal-event timeline) fetched by SIREN. Billed per record that actually gets a history attached. Requires a paid Apify plan.", "default": false }, "withAiSummary": { "title": "AI summary (paid add-on)", "type": "boolean", "description": "Add an AI-generated plain-English summary of each legal announcement (what happened, to which company, the impact). Charged only when a usable summary is produced. Requires a paid Apify plan.", "default": false }, "withAiRiskFlags": { "title": "AI KYB risk flags (paid add-on)", "type": "boolean", "description": "Add an AI KYB/credit-risk assessment with red-flag phrases and a risk level (insolvency, liquidation, deregistration, disputes). Charged only on usable output. Requires a paid Apify plan.", "default": false }, "withAiTranslate": { "title": "AI English translation (paid add-on)", "type": "boolean", "description": "Add an AI English translation of the French announcement content. Charged only on usable output. Requires a paid Apify plan.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }