{ "openapi": "3.0.1", "info": { "title": "France Company & SIRET Search", "description": "Look up French companies by SIREN, SIRET or VAT number, or search by name with department, NAF and status filters. Official Sirene data with legal form, NAF, head office, establishments and clear not-found status.", "version": "0.1", "x-build-id": "nez0GmB0z8cFyjM5o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cliqtomedia~france-sirene-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cliqtomedia-france-sirene-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/cliqtomedia~france-sirene-company-search/runs": { "post": { "operationId": "runs-sync-cliqtomedia-france-sirene-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/cliqtomedia~france-sirene-company-search/run-sync": { "post": { "operationId": "run-sync-cliqtomedia-france-sirene-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": { "identifiers": { "title": "SIREN / SIRET / VAT numbers", "maxItems": 100, "type": "array", "description": "Exact lookup of up to 100 French company numbers: SIREN (9 digits, e.g. 552081317), SIRET (14 digits, e.g. 55208131766522) or French VAT number (FR + 2 characters + SIREN, e.g. FR03552081317). Spaces, dots and dashes are ignored; duplicates are looked up once. Never a fuzzy name match. Leave empty to run a name search instead.", "items": { "type": "string" } }, "query": { "title": "Search by name or address", "maxLength": 200, "type": "string", "description": "Fuzzy full-text search on company names, brands, acronyms and addresses, e.g. boulangerie or Michelin. 3–200 characters (shorter is allowed with a filter). Cannot be combined with identifiers (the run is rejected with INVALID_INPUT). Results are ranked by the source: check siren and name before treating one as a verified match." }, "departments": { "title": "Departments", "maxItems": 20, "type": "array", "description": "Search filter, not combinable with identifiers. Up to 20 French department codes: 01–95, 2A, 2B, 971–976, e.g. 75 or 69. Keeps companies with at least one establishment there. Default: empty (all of France).", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "maxItems": 20, "type": "array", "description": "Search filter, not combinable with identifiers. Up to 20 five-digit postal codes, e.g. 75008. Keeps companies with at least one establishment there. Default: empty.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF / APE activity codes", "maxItems": 20, "type": "array", "description": "Search filter, not combinable with identifiers. Up to 20 NAF rev. 2 activity codes, with or without the dot, e.g. 62.01Z or 6201Z. Unknown codes and NAF 2025 codes are rejected with INVALID_INPUT. Default: empty.", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "enum": [ "any", "active", "ceased" ], "type": "string", "description": "Search filter on company status: any (default), active or ceased. Active or ceased cannot be combined with identifiers.", "default": "any" }, "maxResults": { "title": "Max companies (search)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Search mode only. Maximum companies returned, 1–100. Default 25. Each company row is charged.", "default": 25 }, "includeEstablishments": { "title": "Include establishments (SIRET rows)", "type": "boolean", "description": "Add one row per establishment (SIRET: address, status, head-office flag, NAF, trade names). For identifiers: the head office plus establishments listed by the source; for a search: the establishments that matched the search. Default false. Each found establishment row is charged.", "default": false }, "maxEstablishmentsPerCompany": { "title": "Max establishments per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum establishment rows per company, 1–100. Default 20. The company row shows establishmentsTotal and establishmentsComplete so you know when the list is a subset. Used only with includeEstablishments.", "default": 20 } } }, "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 } } } } } } } } } }