{
"openapi": "3.0.1",
"info": {
"title": "BODACC – French Company Creations, Insolvencies & Sales",
"description": "French legal announcements (BODACC), cleaned and structured: new companies, business sales with prices, insolvency proceedings with liquidators and claim deadlines, deregistrations and accounts filings. Daily alerts, SIREN watchlists and statistics.",
"version": "0.1",
"x-build-id": "UhPB3BObFUA36xcgR"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/yck69~french-bodacc/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-yck69-french-bodacc",
"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/yck69~french-bodacc/runs": {
"post": {
"operationId": "runs-sync-yck69-french-bodacc",
"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/yck69~french-bodacc/run-sync": {
"post": {
"operationId": "run-sync-yck69-french-bodacc",
"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",
"required": [
"mode"
],
"properties": {
"mode": {
"title": "What do you want?",
"enum": [
"announcements",
"stats"
],
"type": "string",
"description": "Announcements: BODACC legal announcements, structured: company creations, business sales, insolvency proceedings, modifications, deregistrations, accounts filings. Turn on alerts to get only new ones (e.g. a watchlist of SIRENs).
Statistics: announcements counted by type, insolvency procedure, department, region, court or month.",
"default": "announcements"
},
"families": {
"title": "Announcement types",
"type": "array",
"description": "Any of them. All types by default.",
"items": {
"type": "string",
"enum": [
"creation",
"immatriculation",
"vente",
"collective",
"conciliation",
"retablissement_professionnel",
"modification",
"radiation",
"dpc"
],
"enumTitles": [
"Company creations",
"Registrations (transfers, new establishments)",
"Business sales and transfers",
"Insolvency proceedings",
"Conciliations",
"Professional recovery",
"Modifications (directors, address, capital…)",
"Deregistrations",
"Accounts filings"
]
}
},
"procedures": {
"title": "Insolvency judgments",
"type": "array",
"description": "Kinds of insolvency judgments (implies insolvency proceedings).",
"items": {
"type": "string",
"enum": [
"liquidation-opened",
"receivership-opened",
"safeguard-opened",
"plan-adopted",
"sale-plan",
"closed-insufficient-assets",
"closed-debts-paid",
"sanction",
"claims"
],
"enumTitles": [
"Liquidation opened (incl. conversions)",
"Receivership opened (redressement)",
"Safeguard opened (sauvegarde)",
"Recovery or safeguard plan adopted",
"Sale plan (plan de cession)",
"Closed for insufficient assets",
"Closed, debts paid",
"Personal bankruptcy or management ban",
"Lists of claims and distributions"
]
}
},
"lastDays": {
"title": "Published in the last (days)",
"minimum": 1,
"type": "integer",
"description": "Without any period, company or SIREN, announcements of the last 30 days (365 for statistics)."
},
"publishedAfter": {
"title": "Published after",
"type": "string",
"description": "On or after this date."
},
"publishedBefore": {
"title": "Published before",
"type": "string",
"description": "Before this date."
},
"sirens": {
"title": "SIRENs (watchlist)",
"type": "array",
"description": "Companies to follow, 9 digits each. Combine with alerts to monitor customers or suppliers.",
"items": {
"type": "string"
}
},
"companyName": {
"title": "Company name",
"type": "string",
"description": "Words in the company name."
},
"activities": {
"title": "Activity keywords",
"type": "array",
"description": "Words in the activity description, e.g. restaurant, boulangerie, informatique. Any of the lines.",
"items": {
"type": "string"
}
},
"personType": {
"title": "Companies or individuals",
"enum": [
"all",
"companies",
"individuals"
],
"type": "string",
"description": "Companies (legal entities) or sole traders.",
"default": "all"
},
"onlyInitial": {
"title": "Exclude corrections and cancellations",
"type": "boolean",
"description": "Only initial announcements.",
"default": false
},
"departments": {
"title": "Departments",
"type": "array",
"description": "e.g. 69, 2A, 974.",
"items": {
"type": "string"
}
},
"regions": {
"title": "Regions",
"type": "array",
"description": "Whole regions.",
"items": {
"type": "string",
"enum": [
"11",
"24",
"27",
"28",
"32",
"44",
"52",
"53",
"75",
"76",
"84",
"93",
"94",
"1",
"2",
"3",
"4",
"6"
],
"enumTitles": [
"Île-de-France",
"Centre-Val de Loire",
"Bourgogne-Franche-Comté",
"Normandie",
"Hauts-de-France",
"Grand Est",
"Pays de la Loire",
"Bretagne",
"Nouvelle-Aquitaine",
"Occitanie",
"Auvergne-Rhône-Alpes",
"Provence-Alpes-Côte d'Azur",
"Corse",
"Guadeloupe",
"Martinique",
"Guyane",
"La Réunion",
"Mayotte"
]
}
},
"postalCodes": {
"title": "Postal codes",
"type": "array",
"description": "e.g. 69002.",
"items": {
"type": "string"
}
},
"cities": {
"title": "Cities",
"type": "array",
"description": "City names.",
"items": {
"type": "string"
}
},
"onlyNew": {
"title": "Alerts: only new announcements since the last run",
"type": "boolean",
"description": "Schedule the Actor (e.g. every day) with an email, Slack or webhook integration. The first run saves the current announcements.",
"default": false
},
"alertName": {
"title": "Alert name",
"type": "string",
"description": "Separate memory per alert. Defaults to one per set of filters."
},
"groupBy": {
"title": "Statistics by",
"enum": [
"family",
"procedure",
"department",
"region",
"court",
"month"
],
"type": "string",
"description": "For Statistics mode.",
"default": "family"
},
"perMonth": {
"title": "Split by month",
"type": "boolean",
"description": "One row per group and month: trends.",
"default": false
},
"maxResults": {
"title": "Maximum results",
"minimum": 1,
"maximum": 20000,
"type": "integer",
"description": "Announcements or statistics rows.",
"default": 50
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}