{
  "openapi": "3.0.1",
  "info": {
    "title": "French Companies Scraper",
    "description": "Find and export French company records from the public registry search API. Results include SIREN, SIRET, legal form, NAF code, status, head-office address, establishment count, directors and available year-keyed finances. Search using names, identifiers, departments, postal codes or activity codes.",
    "version": "0.1",
    "x-build-id": "YF7bOzxJhkT5ntxyf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/axiomworks~french-companies-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-axiomworks-french-companies-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/axiomworks~french-companies-scraper/runs": {
      "post": {
        "operationId": "runs-sync-axiomworks-french-companies-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/axiomworks~french-companies-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-axiomworks-french-companies-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": {
          "searchQueries": {
            "title": "Company names, SIREN, SIRET or address text",
            "type": "array",
            "description": "Free-text terms to search, one per entry: company names ('boulangerie'), 9-digit SIREN ('380474494'), 14-digit SIRET or address text. An exact SIREN/SIRET does a direct lookup and ignores other filters. Max 200 characters each. Combine with departements/nafCodes to narrow. Optional if another filter is set.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "departements": {
            "title": "French department codes (75, 01, 2A)",
            "type": "array",
            "description": "French department codes, e.g. 75, 01, 2A or 971; comma-separated codes also work. Single digits are padded and letters uppercased. Unsupported codes are skipped; if none match, the run succeeds with zero results. Combine with NAF or name filters.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "postalCodes": {
            "title": "French postal codes (75001)",
            "type": "array",
            "description": "Five-digit French postal codes, e.g. ['75001','69003']. Each code is searched separately and results are de-duplicated by SIREN. A malformed code fails the run with an input error.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "nafCodes": {
            "title": "NAF activity codes (62.01Z)",
            "type": "array",
            "description": "NAF/APE activity codes in the form NN.NNL, e.g. ['62.01Z' (software development), '56.10A' (restaurants)]. Each code is searched separately and results are de-duplicated by SIREN. A malformed code fails the run with an input error.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "legalForms": {
            "title": "INSEE legal form codes (5710)",
            "type": "array",
            "description": "INSEE legal-form (nature juridique) codes, 4 digits, e.g. ['5710' (SAS), '5499' (SARL), '9220' (association)]. Companies matching any listed code are returned. Optional.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "headcountBands": {
            "title": "INSEE employee band codes (11)",
            "type": "array",
            "description": "INSEE workforce band codes as used by the API, e.g. ['11' (10-19 employees), '12' (20-49), '21' (50-99)]. Each code is searched separately. Optional.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "directorNames": {
            "title": "Director names (Dupont)",
            "type": "array",
            "description": "Names of directors/officers to search, e.g. ['Dupont']. Returns companies where a listed director matches; each entry is searched separately. Optional; counts as a filter on its own.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "minRevenue": {
            "title": "Minimum revenue (EUR)",
            "type": "integer",
            "description": "Only companies whose latest reported revenue is at least this many euros, e.g. 10000000. Companies without published figures are excluded when set. Optional; counts as a filter on its own."
          },
          "maxRevenue": {
            "title": "Maximum revenue (EUR)",
            "type": "integer",
            "description": "Only companies whose latest reported revenue is at most this many euros, e.g. 20000000. Companies without published figures are excluded when set. Optional."
          },
          "minNetResult": {
            "title": "Minimum net result (EUR)",
            "type": "integer",
            "description": "Minimum latest reported net result in euros, e.g. -100000 to include losses down to that amount. Requires a published net-result figure; companies lacking one do not match. Optional; combine with maxNetResult for a range."
          },
          "maxNetResult": {
            "title": "Maximum net result (EUR)",
            "type": "integer",
            "description": "Only companies whose latest net result is at most this many euros, e.g. 0 to find loss-making companies. Optional."
          },
          "companyCategory": {
            "title": "Company size category (PME, ETI, GE)",
            "enum": [
              "PME",
              "ETI",
              "GE"
            ],
            "type": "string",
            "description": "Company size category, e.g. 'PME': 'PME' (small/medium), 'ETI' (mid-cap), or 'GE' (large). Omit for all sizes. Supply at least one searchQueries entry, another filter list, or a financial bound too; category alone is insufficient."
          },
          "activeOnly": {
            "title": "Return active companies only (true/false)",
            "type": "boolean",
            "description": "Whether to restrict searches to administratively active companies: true (default) filters to status 'A'; false includes closed companies ('C'). Ignored for exact SIREN/SIRET lookups. At least one query or company filter is still required.",
            "default": true
          },
          "includeFinances": {
            "title": "Include available finances (true/false)",
            "type": "boolean",
            "description": "Whether to include available yearly financial figures: true (default) copies the finances object; false returns finances: null. Missing figures remain null. This output option does not disable revenue or net-result search filters.",
            "default": true
          },
          "maxItems": {
            "title": "Maximum unique companies across all searches",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum unique companies across all filter combinations, 1-10000, default 50; e.g. 7 returns at most seven rows and charges only saved results. Fewer are returned when matches run out. Use 1-25 for a quick test.",
            "default": 50
          },
          "proxyConfiguration": {
            "title": "Apify Proxy settings (direct by default)",
            "type": "object",
            "description": "Apify Proxy settings. Default: direct requests, which work for this public API. Enable Apify Proxy only if requests are blocked (the run then says so in its status message).",
            "default": {
              "useApifyProxy": 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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}