{ "openapi": "3.0.1", "info": { "title": "France Company Search (SIRENE / SIREN lookup)", "description": "Search French companies or look up SIREN/SIRET numbers in the official SIRENE register (api.gouv.fr): name, legal form, NAF code, status, headcount, address, establishments. No officers or personal names. Empty input = free demo. $2 per 1,000 companies.", "version": "0.1", "x-build-id": "5wjcnOSHudymJNmFA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ucchiii~france-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ucchiii-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/ucchiii~france-company-search/runs": { "post": { "operationId": "runs-sync-ucchiii-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/ucchiii~france-company-search/run-sync": { "post": { "operationId": "run-sync-ucchiii-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": { "queries": { "title": "Search queries", "type": "array", "description": "Company names or keywords to search for in the French register, one per entry (e.g. 'Danone', 'boulangerie Lyon'). Each query returns up to 'Max results per query' companies. Up to 200 queries. Leave everything empty to run a free demo (not charged).", "items": { "type": "string" } }, "sirenList": { "title": "SIREN / SIRET numbers", "type": "array", "description": "Optional. 9-digit SIREN or 14-digit SIRET numbers to look up, one per entry. Spaces and dots are ignored ('552 032 534' works). A SIRET returns the company it belongs to. Up to 5,000 numbers. Invalid and unknown numbers come back as free rows with an 'error' field.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max results per query", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of companies returned for each query (or for the filters alone). Allowed range 1 to 1,000. Each company returned is charged once; a company found by several queries is returned and charged only once." }, "codePostal": { "title": "Postal code", "type": "string", "description": "Optional filter: postal code of the headquarters or of a matching establishment, e.g. '75001'. Several codes can be separated by commas. Filters can be used with queries, or alone." }, "departement": { "title": "Department", "type": "string", "description": "Optional filter: French department code, e.g. '75', '2A' or '974'. Several codes can be separated by commas ('38,69')." }, "activitePrincipale": { "title": "NAF code", "type": "string", "description": "Optional filter: main activity (NAF rev. 2) code, e.g. '56.10A' (restaurants) or '62.01Z' (programming). Several codes can be separated by commas." }, "sectionActivitePrincipale": { "title": "NAF section", "enum": [ "", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U" ], "type": "string", "description": "Optional filter: NAF section letter (broad sector). Leave 'Any' for no filter." }, "etatAdministratif": { "title": "Status", "enum": [ "", "A", "C" ], "type": "string", "description": "Optional filter on the administrative status of the company: active or ceased. Leave 'Any' for no filter." }, "includeEstablishments": { "title": "Include matching establishments", "type": "boolean", "description": "Add the list of establishments that matched your search (SIRET, address, status) to each row. The API fills it for text queries and filters, not for plain SIREN lookups. The price per company is the same.", "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 } } } } } } } } } }