{ "openapi": "3.0.1", "info": { "title": "France Company Register Scraper (SIRENE)", "description": "French companies from the official Recherche d'entreprises API (INSEE SIRENE + INPI RNE). Filter by NAF code, département, region, headcount and creation date. Get SIREN, address, GPS, revenue, net income and VAT number. Splits nationwide searches past the 10k cap. New-company monitor.", "version": "0.2", "x-build-id": "8MaVN50Slr8u6gXu3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mmm_mita~france-company-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mmm_mita-france-company-register", "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/mmm_mita~france-company-register/runs": { "post": { "operationId": "runs-sync-mmm_mita-france-company-register", "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/mmm_mita~france-company-register/run-sync": { "post": { "operationId": "run-sync-mmm_mita-france-company-register", "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 (optional)", "type": "string", "description": "Company name, SIREN or keyword. Leave empty to filter only by the fields below." }, "nafCodes": { "title": "NAF/APE activity codes", "type": "array", "description": "e.g. 62.01Z (software), 56.10A (restaurants), 43.21A (electricians).", "items": { "type": "string" } }, "departements": { "title": "Départements", "type": "array", "description": "e.g. 75, 69, 13, 2A. Empty = all of France (auto-split to bypass the 10,000-result cap).", "items": { "type": "string" } }, "regions": { "title": "Regions (INSEE code)", "type": "array", "description": "e.g. 11 = Île-de-France, 84 = Auvergne-Rhône-Alpes.", "items": { "type": "string" } }, "headcountBands": { "title": "Headcount bands (INSEE tranche)", "type": "array", "description": "Employee size bands.", "items": { "type": "string", "enum": [ "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "0", "1-2", "3-5", "6-9", "10-19", "20-49", "50-99", "100-199", "200-249", "250-499", "500-999", "1000-1999", "2000-4999", "5000-9999", "10000+" ] }, "default": [] }, "companyCategory": { "title": "Company category", "type": "array", "description": "PME = SME, ETI = mid-size, GE = large.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ] }, "default": [] }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Exclude closed companies.", "default": true }, "excludeSoleTraders": { "title": "Exclude sole traders (entrepreneurs individuels)", "type": "boolean", "description": "Sole-trader records carry a natural person's name; excluded by default for GDPR safety.", "default": true }, "createdAfter": { "title": "Created on/after (YYYY-MM-DD)", "type": "string", "description": "Keep only companies created on or after this date." }, "includeLegalEntityDirectors": { "title": "Include corporate directors", "type": "boolean", "description": "Adds directors that are companies (holding companies). Natural-person directors are never output.", "default": false }, "maxItems": { "title": "Max companies", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Upper bound on output rows.", "default": 1000 }, "monitorMode": { "title": "Monitor mode (only new companies)", "type": "boolean", "description": "Remembers SIRENs between runs; schedule to receive newly registered companies only.", "default": false }, "monitorStoreName": { "title": "Monitor memory name", "type": "string", "description": "One name per saved search.", "default": "fr-companies-monitor" }, "headOfficeInAreaOnly": { "title": "Head office must be in the selected area", "type": "boolean", "description": "The register matches companies with ANY establishment in a département/region. Keep this on to output only companies whose head office (siège) is there.", "default": true }, "monitorFirstRunBaseline": { "title": "Monitor: first run is a free baseline", "type": "boolean", "description": "In monitor mode, the first run (empty memory) only stores what already exists, with no output and no charge. Later runs return only new records. Turn off to receive (and pay for) the existing records on the first run too.", "default": true } } }, "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 } } } } } } } } } }