{ "openapi": "3.0.1", "info": { "title": "French Company Search API", "description": "Search French companies by name, SIREN, SIRET, activity code, place, size or revenue. Returns one row per company: legal form, NAF activity, size band, head office address, revenue and net income when filed, VAT number. Official open data, no officers or sole traders.", "version": "0.0", "x-build-id": "MInbyYlMTCtcZCASd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/conserving_celerytop~french-company-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-conserving_celerytop-french-company-search-api", "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/conserving_celerytop~french-company-search-api/runs": { "post": { "operationId": "runs-sync-conserving_celerytop-french-company-search-api", "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/conserving_celerytop~french-company-search-api/run-sync": { "post": { "operationId": "run-sync-conserving_celerytop-french-company-search-api", "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": { "searches": { "title": "Searches", "maxItems": 200, "type": "array", "description": "Search company names or SIREN numbers; person-name searches are not supported. Enter one search per line: a company name or keyword (at least 3 characters), a SIREN (9 digits), a SIRET (14 digits) or a French VAT number such as FR14652014051. Leave empty to list companies by the filters below.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Return at most this many companies for each search. The official source never returns more than 10,000 results for one search, so narrow big lists with filters. Each company returned is one charged result.", "default": 25 }, "companyStatus": { "title": "Company status", "enum": [ "active", "ceased", "any" ], "type": "string", "description": "Choose which companies to return. Active means still registered as operating.", "default": "active" }, "activityCodes": { "title": "Activity codes (NAF)", "maxItems": 50, "type": "array", "description": "Enter NAF activity codes (NAF rev. 2), one per line, for example 62.01Z for computer programming or 56.10A for restaurants.", "items": { "type": "string" } }, "departments": { "title": "Departments", "maxItems": 50, "type": "array", "description": "Enter department codes, one per line, for example 75 for Paris, 69 for Rhone, 2A for Corse-du-Sud or 971 for Guadeloupe.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "maxItems": 50, "type": "array", "description": "Enter 5-digit postal codes, one per line, for example 75008.", "items": { "type": "string" } }, "headOfficeOnly": { "title": "Head office only", "type": "boolean", "description": "Keep only companies whose head office is in the departments or postal codes you entered. Turn off to also get companies that only have a branch there. Has no effect without a department or postal code.", "default": true }, "legalForms": { "title": "Legal forms", "maxItems": 50, "type": "array", "description": "Enter 4-digit legal form codes, one per line, for example 5710 for SAS, 5499 for SARL or 9220 for associations.", "items": { "type": "string" } }, "companySize": { "title": "Company size", "enum": [ "any", "PME", "ETI", "GE" ], "type": "string", "description": "Keep only companies in this INSEE size category.", "default": "any" }, "employeeBands": { "title": "Employee bands", "maxItems": 50, "type": "array", "description": "Enter INSEE employee band codes, one per line: 01 (1-2), 02 (3-5), 03 (6-9), 11 (10-19), 12 (20-49), 21 (50-99), 22 (100-199), 31 (200-249), 32 (250-499), 41 (500-999), 42 (1,000-1,999), 51, 52, 53 (10,000+).", "items": { "type": "string" } }, "minRevenue": { "title": "Minimum revenue (EUR)", "minimum": 0, "type": "integer", "description": "Keep only companies whose latest filed revenue is at least this many euros. Companies that do not publish accounts are left out." }, "maxRevenue": { "title": "Maximum revenue (EUR)", "minimum": 0, "type": "integer", "description": "Keep only companies whose latest filed revenue is at most this many euros. Companies that do not publish accounts are left out." } } }, "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 } } } } } } } } } }