{ "openapi": "3.0.1", "info": { "title": "French Companies Search: SIRENE, SIREN, SIRET and NAF Data", "description": "Returns French companies from the official INSEE Sirene register: SIREN, head office SIRET, name, legal form, NAF code and label, creation date, employee range, address and status. Search by name, SIREN, NAF code, department, postal code and size. No API key, open licence.", "version": "0.1", "x-build-id": "SdqFIKHx36QTsh8FM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nightwave-owner~france-company-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nightwave-owner-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/nightwave-owner~france-company-register/runs": { "post": { "operationId": "runs-sync-nightwave-owner-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/nightwave-owner~france-company-register/run-sync": { "post": { "operationId": "run-sync-nightwave-owner-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", "type": "string", "description": "Company name, brand or address words, as in the official Annuaire des Entreprises search. Example: \"boulangerie lyon\" or \"Danone\". Leave empty to list companies by the filters below, largest first.", "default": "" }, "sirenNumbers": { "title": "SIREN numbers", "type": "array", "description": "Look up known companies by SIREN (9 digits) or SIRET (14 digits, the first 9 are used), up to 1 000 per run. When this is set, search text and the other filters are ignored except activeOnly. Example: [\"552032534\"].", "default": [], "items": { "type": "string" } }, "nafCodes": { "title": "NAF (APE) activity codes", "type": "array", "description": "INSEE NAF rev. 2 codes for the company's main activity, for example 62.01Z (computer programming), 10.71C (bakeries), 56.10A (restaurants), 68.20B (property rental). \"6201Z\" is accepted too. Example: [\"62.01Z\"].", "default": [], "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes, for example 75 (Paris), 69 (Rhône), 13 (Bouches-du-Rhône), 2A (Corse-du-Sud), 971 (Guadeloupe). A company matches when at least one of its establishments is in the department. Example: [\"69\"].", "default": [], "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Five digit postal codes. A company matches when at least one of its establishments has the postal code. Example: [\"69002\"].", "default": [], "items": { "type": "string" } }, "employeeRange": { "title": "Employee range", "type": "array", "description": "INSEE employee size bands of the company. Leave empty for all sizes. Example: [\"11\", \"12\"] for 10-49 employees.", "items": { "type": "string", "enum": [ "NN", "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "No employees (non-employer)", "0 employees", "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": [] }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Return only companies that are active in the register. Set to false to include closed (cessée) companies. Default true.", "default": true }, "headOfficeInArea": { "title": "Head office in the area", "type": "boolean", "description": "With departments or postal codes: return only companies whose head office is there. Set to false to also get companies that only have a branch there. Default true.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of companies, for example 50. 1 to 10 000, defaults to 50. The API returns at most 10 000 per search, so split large searches by department.", "default": 50 }, "onlyNew": { "title": "Only new since last run", "type": "boolean", "description": "Return only companies that earlier runs with the same input did not deliver, for example true for a daily schedule of new registrations in a sector and department. Defaults to false.", "default": 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 } } } } } } } } } }