{ "openapi": "3.0.1", "info": { "title": "French Company Data API: SIRENE & SIRET Register", "description": "26M+ French companies from the official Annuaire des Entreprises API. Filter by NAF code, postcode, department, legal form, headcount, revenue or net result. Returns SIREN, SIRET, address, directors, finances and labels. Licence Ouverte 2.0.", "version": "0.1", "x-build-id": "ivwDEGzcF3tKalR1a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/smoked_drift~french-company-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-smoked_drift-french-company-data", "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/smoked_drift~french-company-data/runs": { "post": { "operationId": "runs-sync-smoked_drift-french-company-data", "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/smoked_drift~french-company-data/run-sync": { "post": { "operationId": "run-sync-smoked_drift-french-company-data", "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 text", "type": "string", "description": "Free text: company name, trade name, acronym, or a director's name. Also matches on address. Leave empty to filter only by the structured fields below." }, "activitePrincipale": { "title": "NAF activity codes", "type": "array", "description": "French NAF/APE codes, e.g. 56.10A for restaurants, 62.01Z for programming, 43.21A for electrical installation. A company matches if its main activity is one of these.", "items": { "type": "string" } }, "sectionActivitePrincipale": { "title": "Activity section", "type": "string", "description": "Broad NAF section letter, e.g. 'J' for information and communication, 'F' for construction, 'G' for trade." }, "codePostal": { "title": "Postcode", "type": "string", "description": "Exact French postcode of the registered office, e.g. 33000." }, "departement": { "title": "Department", "type": "string", "description": "Department code, e.g. 33 for Gironde, 75 for Paris, 2A for Corse-du-Sud." }, "region": { "title": "Region", "type": "string", "description": "Region code, e.g. 75 for Nouvelle-Aquitaine, 11 for Île-de-France." }, "codeCommune": { "title": "Commune (INSEE code)", "type": "string", "description": "INSEE commune code, e.g. 33063 for Bordeaux." }, "etatAdministratif": { "title": "Administrative status", "enum": [ "A", "C" ], "type": "string", "description": "A for an active company, C for a ceased one. Leave empty for both." }, "natureJuridique": { "title": "Legal form codes", "type": "array", "description": "INSEE legal category codes, e.g. 5710 for SAS, 5499 for SARL, 6540 for SCI. Filtering here is much more reliable than matching on the label.", "items": { "type": "string" } }, "categorieEntreprise": { "title": "Company size category", "type": "array", "description": "PME, ETI, GE or startup labels as INSEE assigns them.", "items": { "type": "string" } }, "trancheEffectifSalarie": { "title": "Headcount bracket codes", "type": "array", "description": "INSEE headcount bracket code, e.g. 00 for none, 11 for 10-19, 53 for 1000-1999.", "items": { "type": "string" } }, "caMin": { "title": "Minimum revenue (EUR)", "type": "integer", "description": "Filter on the last declared turnover. Only companies with published accounts have this, so it narrows the result sharply." }, "caMax": { "title": "Maximum revenue (EUR)", "type": "integer", "description": "Upper bound on the last declared turnover." }, "nomPersonne": { "title": "Director surname", "type": "string", "description": "Find companies by a director's last name. Useful for mapping someone's mandates." }, "prenomsPersonne": { "title": "Director first name", "type": "string", "description": "Used together with the surname." }, "estOrganismeFormation": { "title": "Certified training organisation", "type": "boolean", "description": "Only companies registered as training organisations." }, "estRge": { "title": "RGE certified", "type": "boolean", "description": "Only companies holding an RGE certification, the energy-renovation qualification required for most French subsidy work." }, "estSocieteMission": { "title": "Société à mission", "type": "boolean", "description": "Only companies with the société à mission status." }, "estAssociation": { "title": "Association", "type": "boolean", "description": "Only registered associations." }, "estEntrepreneurIndividuel": { "title": "Sole trader", "type": "boolean", "description": "Only sole traders (entrepreneurs individuels)." }, "estEss": { "title": "Social and solidarity economy", "type": "boolean", "description": "Only companies with the ESS label." }, "includeEtablissements": { "title": "Include secondary establishments", "type": "boolean", "description": "Adds matched SIRET establishments to each company. Makes rows considerably larger.", "default": false }, "sortBySize": { "title": "Sort by size, largest first", "type": "boolean", "description": "Order results by headcount rather than by relevance. Useful when you want the biggest players in a sector.", "default": false }, "minimal": { "title": "Minimal payload", "type": "boolean", "description": "Ask the API for a lighter response. Ignored when secondary establishments are requested.", "default": false }, "maxItems": { "title": "Maximum companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on returned companies. The API caps any single query at 10,000 rows, so slice by postcode or NAF code to go deeper.", "default": 1000 } } }, "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 } } }, "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 } } } } } } } } } }