{ "openapi": "3.0.1", "info": { "title": "France Company Register Scraper — SIREN, SIRET & Executives", "description": "Scrape French companies (entreprises) from the official French government open-data API: SIREN, SIRET, legal form, NAF activity, address, employees, executives and financials. French company register and business data by department, activity, size and creation date.", "version": "0.1", "x-build-id": "ffeYFuUVe0DvUCSTk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/publicdata~france-company-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-publicdata-france-company-register-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/publicdata~france-company-register-scraper/runs": { "post": { "operationId": "runs-sync-publicdata-france-company-register-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/publicdata~france-company-register-scraper/run-sync": { "post": { "operationId": "run-sync-publicdata-france-company-register-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 query", "type": "string", "description": "Company name, SIREN, SIRET, or keywords. Leave empty to browse using the filters below." }, "sirenList": { "title": "Look up specific SIREN/SIRET", "type": "array", "description": "Exact identifiers to fetch (9-digit SIREN or 14-digit SIRET). Overrides the search query.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "French department codes to filter by, e.g. 75, 13, 2A. Empty = all France.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF/APE activity codes", "type": "array", "description": "Activity codes, e.g. 47.11F (supermarkets), 62.01Z (software). Empty = all activities.", "items": { "type": "string" } }, "legalStatus": { "title": "Company status", "enum": [ "all", "active", "ceased" ], "type": "string", "description": "Restrict to active or ceased companies.", "default": "active" }, "minEmployees": { "title": "Minimum employees", "type": "string", "description": "INSEE employee bracket floor, e.g. 10, 50, 200. Empty = no minimum." }, "createdAfter": { "title": "Created after (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only companies created on or after this date (YYYY-MM-DD). The source API has no creation-date parameter, so the Actor scans the search results and filters them here — combine it with a department or an activity code so the scan covers the whole set." }, "onlyWithExecutives": { "title": "Only with named executives", "type": "boolean", "description": "Keep only companies whose directors are published.", "default": false }, "includeExecutives": { "title": "Include executives", "type": "boolean", "description": "Include directors and officers (names are published by the French register itself). Turn off if you only need company-level data.", "default": true }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Safety cap (0 = unlimited).", "default": 200 }, "scanLimit": { "title": "Records to scan when filtering by creation date", "minimum": 100, "maximum": 100000, "type": "integer", "description": "How many search results to read through while looking for companies that match `createdAfter`. Only matching companies are exported and charged. Raise it for a wide search, lower it to keep runs short. Ignored when `createdAfter` is empty.", "default": 5000 } } }, "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 } } } } } } } } } }