{ "openapi": "3.0.1", "info": { "title": "France Company Search", "description": "Search French companies by name, SIREN/SIRET, NAF code, place, legal form and size. Uses the official open API Recherche d'entreprises (SIRENE / RNE). Unofficial.", "version": "0.1", "x-build-id": "v80x78hQzfZh9iuMx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plusonets~france-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plusonets-france-company-search", "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/plusonets~france-company-search/runs": { "post": { "operationId": "runs-sync-plusonets-france-company-search", "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/plusonets~france-company-search/run-sync": { "post": { "operationId": "run-sync-plusonets-france-company-search", "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, address, or a director's name. At least 3 characters. A single SIREN (9 digits) or SIRET (14 digits) is accepted here too. Leave this empty when you only pass an identifier list or filters.", "default": "boulangerie" }, "identifiers": { "title": "SIREN or SIRET list", "type": "array", "description": "Look up these 9-digit SIREN or 14-digit SIRET numbers. Spaces are ignored. The official API ignores other filters on a direct lookup; this Actor applies them to the returned company. Department and postcode are compared with the headquarters, because a direct lookup does not list branch establishments.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF / activity codes", "type": "array", "description": "NAF rév. 2 subclass codes of the legal unit, for example 10.71C (bakery) or 62.01Z (computer programming). One code per line. NAF 2025 codes are not accepted.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "INSEE department codes of an establishment. Examples: 75 (Paris), 13, 2A (Corse-du-Sud), 974 (La Réunion). One code per line.", "items": { "type": "string" } }, "postalCodes": { "title": "Postcodes", "type": "array", "description": "5-digit postcodes of an establishment. One code per line.", "items": { "type": "string" } }, "legalForms": { "title": "Legal form", "type": "array", "description": "INSEE catégorie juridique codes. Common codes: 5710 SAS, 5499 SARL, 5599 SA, 1000 entrepreneur individuel, 6540 SCI, 9220 association déclarée. SASU (5720) and EURL (5498) were merged into 5710 and 5499 in 2020.", "items": { "type": "string" } }, "companySize": { "title": "Company size", "type": "array", "description": "INSEE company category. Leave empty for any size.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME — small or medium enterprise", "ETI — mid-sized enterprise", "GE — large enterprise" ] } }, "headcountBands": { "title": "Headcount band", "type": "array", "description": "INSEE workforce bracket of the company (tranche d'effectif salarié). Leave empty for any headcount. This is separate from the PME / ETI / GE category.", "items": { "type": "string", "enum": [ "NN", "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "NN — non-employer", "00 — 0 employees", "01 — 1 or 2 employees", "02 — 3 to 5 employees", "03 — 6 to 9 employees", "11 — 10 to 19 employees", "12 — 20 to 49 employees", "21 — 50 to 99 employees", "22 — 100 to 199 employees", "31 — 200 to 249 employees", "32 — 250 to 499 employees", "41 — 500 to 999 employees", "42 — 1,000 to 1,999 employees", "51 — 2,000 to 4,999 employees", "52 — 5,000 to 9,999 employees", "53 — 10,000 employees or more" ] } }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Keep companies whose administrative status is active (état A). Turn this off to include ceased companies.", "default": true }, "createdFrom": { "title": "Created from", "type": "string", "description": "Keep companies created on or after this date (YYYY-MM-DD). Applied locally. A narrow window on a broad query examines at most 1,000 companies and may return fewer rows than the maximum." }, "createdTo": { "title": "Created to", "type": "string", "description": "Keep companies created on or before this date (YYYY-MM-DD). Applied locally, with the same 1,000-company scan cap as Created from." }, "maxResults": { "title": "Maximum companies", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many companies. Each saved company is one company-result event. The default is small so a run finishes quickly.", "default": 5 } } }, "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 } } } } } } } } } }