{ "openapi": "3.0.1", "info": { "title": "France Company Search (Insee Sirene) - company-level", "description": "Search and look up French companies in Insee Sirene via the official API Recherche d'entreprises: SIREN, legal form, NAF, size, head-office commune, status, computed VAT number. No sole traders, no directors. Licence Ouverte 2.0. Not affiliated with Insee/DINUM.", "version": "0.1", "x-build-id": "QZ8jaW32wYkGulxhW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/itulo~france-sirene-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-itulo-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/itulo~france-sirene-company-search/runs": { "post": { "operationId": "runs-sync-itulo-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/itulo~france-sirene-company-search/run-sync": { "post": { "operationId": "run-sync-itulo-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": { "mode": { "title": "Mode", "enum": [ "search", "lookup" ], "type": "string", "description": "search = query/filters; lookup = list of SIREN/SIRET numbers.", "default": "search" }, "query": { "title": "Search text", "type": "string", "description": "Company name, acronym, SIREN or address words (search mode)." }, "sirenNumbers": { "title": "SIREN / SIRET numbers", "type": "array", "description": "Lookup mode: 9-digit SIREN or 14-digit SIRET (head office or any establishment). Max 1,000.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF/APE activity codes", "type": "array", "description": "Main activity codes (NAF rév. 2 format, e.g. 62.01Z, 70.22Z).", "items": { "type": "string" } }, "section": { "title": "NAF section", "type": "string", "description": "Activity section letter A-U (e.g. J = information & communication)." }, "postCodes": { "title": "Postcodes", "type": "array", "description": "Companies with an establishment in these postcodes (e.g. 75008).", "items": { "type": "string" } }, "communeCodes": { "title": "Insee commune codes", "type": "array", "description": "Insee commune codes (e.g. 31069 Blagnac).", "items": { "type": "string" } }, "departements": { "title": "Départements", "type": "array", "description": "Département codes (e.g. 75, 69, 2A).", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "Insee region codes (e.g. 11 Île-de-France, 84 Auvergne-Rhône-Alpes).", "items": { "type": "string" } }, "legalForms": { "title": "Legal forms (nature juridique)", "type": "array", "description": "Insee legal-form codes, e.g. 5710 SAS, 5499 SARL, 5599 SA, 9220 association. Codes 1xxx (entreprises individuelles) are always excluded.", "items": { "type": "string" } }, "companyCategory": { "title": "Company size category", "enum": [ "PME", "ETI", "GE" ], "type": "string", "description": "Insee category: PME (SME), ETI (mid-cap), GE (large)." }, "headcountBands": { "title": "Headcount bands", "type": "array", "description": "Insee headcount band codes: 00, 01, 02, 03, 11, 12, 21, 22, 31, 32, 41, 42, 51, 52, 53.", "items": { "type": "string" } }, "status": { "title": "Status", "enum": [ "active", "ceased" ], "type": "string", "description": "active or ceased (default: both)." }, "ess": { "title": "Social & solidarity economy (ESS) only", "type": "boolean", "description": "Only ESS companies.", "default": false }, "societeMission": { "title": "Société à mission only", "type": "boolean", "description": "Only sociétés à mission.", "default": false }, "excludeMarketingOptOut": { "title": "Exclude companies opposed to marketing use (recommended)", "type": "boolean", "description": "ON (default): drop companies that objected in the RNE to reuse of their data for commercial prospecting (API field opposition_diffusion_commerciale; GDPR art. 21(2), Code de commerce R.123-320). If you turn it OFF, records with marketingOptOut=true may only be used for non-marketing purposes such as KYB, compliance and credit checks, never for prospecting; you are the data controller.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum companies to return (search mode). The API caps a query at 10,000.", "default": 100 } } }, "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 } } } } } } } } } }