{
  "openapi": "3.0.1",
  "info": {
    "title": "France BODACC Monitor: Insolvency & Company Changes",
    "description": "Know the day a French customer or supplier enters insolvency, changes management, moves or is struck off. Official BODACC notices by SIREN with risk flags, officers, address and capital. Schedule it: each run delivers only new notices, never repeats.",
    "version": "0.1",
    "x-build-id": "A1bpkLu1XzHBNeDxI"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automatic~france-bodacc-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automatic-france-bodacc-monitor",
        "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/automatic~france-bodacc-monitor/runs": {
      "post": {
        "operationId": "runs-sync-automatic-france-bodacc-monitor",
        "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/automatic~france-bodacc-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-automatic-france-bodacc-monitor",
        "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": {
          "sirenNumbers": {
            "title": "Companies to watch (SIREN, SIRET, VAT or link)",
            "maxItems": 2000,
            "type": "array",
            "description": "French companies, e.g. 503833162, 503 833 162, a 14-digit SIRET, an FR VAT number or a Pappers / Societe.com / Annuaire des Entreprises link. Up to 2,000; duplicates collapse and invalid entries are skipped with a note. Omit for a bounded family/date sample.",
            "items": {
              "type": "string"
            }
          },
          "companyName": {
            "title": "Company name keywords (optional)",
            "maxLength": 200,
            "type": "string",
            "description": "Source full-text company-name search, e.g. TAXI CAILLON. Combined with supplied SIRENs using AND. Omit or leave empty for the bounded sample."
          },
          "eventFamilies": {
            "title": "Event families",
            "maxItems": 11,
            "type": "array",
            "description": "Native BODACC codes verified from source facets. OR within this list; AND with company, geography and date filters. Empty or omitted means collective proceedings.",
            "items": {
              "type": "string",
              "enum": [
                "collective",
                "conciliation",
                "creation",
                "divers",
                "dpc",
                "immatriculation",
                "inconnue",
                "modification",
                "radiation",
                "retablissement_professionnel",
                "vente"
              ],
              "enumTitles": [
                "Procédures collectives",
                "Procédures de conciliation",
                "Créations",
                "Annonces diverses",
                "Dépôts des comptes",
                "Immatriculations",
                "inconnue",
                "Modifications diverses",
                "Radiations",
                "Procédures de rétablissement professionnel",
                "Ventes et cessions"
              ]
            }
          },
          "departments": {
            "title": "Department codes (optional)",
            "maxItems": 110,
            "type": "array",
            "description": "French department codes, e.g. 75, 69, 2A, 971 (1 is read as 01). OR within this list. An omitted or empty list selects all departments.",
            "items": {
              "type": "string"
            }
          },
          "publishedFrom": {
            "title": "Published from (inclusive)",
            "type": "string",
            "description": "Europe/Paris calendar date YYYY-MM-DD, e.g. 2026-11-07. Omit for six days before the end date. At most 31 days. For an ongoing monitor, omit both dates; a monitor with a start date also needs an end date."
          },
          "publishedTo": {
            "title": "Published through (inclusive)",
            "type": "string",
            "description": "Europe/Paris calendar date YYYY-MM-DD, e.g. 2026-11-13. Omit for today. Future dates are rejected."
          },
          "maxItems": {
            "title": "Maximum delivered notices",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "1–5,000 notices. Omitted means 25, or 10 for the quick sample with no company, place or date filter. Monitor caps retain pending work for the next run."
          },
          "includeDetails": {
            "title": "Include available structured details",
            "type": "boolean",
            "description": "Include judgment date, proceeding type and description, when available. Omitted means true. No documents are downloaded.",
            "default": true
          },
          "onlyAdverse": {
            "title": "Only adverse notices",
            "type": "boolean",
            "description": "Deliver only notices flagged isAdverse: collective proceedings (insolvency), conciliation, deregistrations, and changes announcing dissolution or cessation of activity. Other notices are skipped and not charged. Example: true with eventFamilies collective, modification, radiation."
          },
          "mode": {
            "title": "Delivery mode",
            "enum": [
              "full",
              "monitor"
            ],
            "type": "string",
            "description": "full returns matching notices; monitor returns new or materially changed notices using a persistent named ledger. Omitted means full unless onlyNewSinceLastRun is true."
          },
          "onlyNewSinceLastRun": {
            "title": "Only new or changed notices",
            "type": "boolean",
            "description": "true alone is an alias for mode: monitor. Conflicts with an explicit mode: full. Example: true with ledgerName: supplier-watch."
          },
          "ledgerName": {
            "title": "Ledger name",
            "maxLength": 64,
            "type": "string",
            "description": "Delivery history name for a schedule, e.g. supplier-watch. Omitted means daily. Keep the same filters for one name; one run at a time per name. 1–64 printable characters."
          },
          "bootstrapMode": {
            "title": "First-window handling",
            "enum": [
              "emit",
              "baseline"
            ],
            "type": "string",
            "description": "emit delivers the initial bounded window. baseline stores inspected notices without delivery; maxItems bounds each baseline run. Monitor only for baseline."
          },
          "overlapHours": {
            "title": "Publication overlap in hours",
            "minimum": 24,
            "maximum": 168,
            "type": "integer",
            "description": "Rescan completed publication days covering at least this overlap; rounded up to whole Paris calendar days. Default 48; 24–168. Example: 72."
          },
          "resetLedger": {
            "title": "Reset a valid ledger",
            "type": "boolean",
            "description": "Explicitly discard this named ledger and its history, then inspect a new bounded window. Example: true after intentionally changing filters. Set back to false afterward. Corrupt ledgers require inspection or a new name."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}