{ "openapi": "3.0.1", "info": { "title": "French Company Register", "description": "Search French companies by NAF code, location, size and labels, or look up SIREN numbers, via the official open API. Legal persons only, no directors.", "version": "0.1", "x-build-id": "7ooHBYSemCL35wdPE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/avorelis~french-company-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-avorelis-french-company-register", "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/avorelis~french-company-register/runs": { "post": { "operationId": "runs-sync-avorelis-french-company-register", "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/avorelis~french-company-register/run-sync": { "post": { "operationId": "run-sync-avorelis-french-company-register", "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": { "companyNumbers": { "title": "Company numbers to look up (SIREN or SIRET)", "maxItems": 1000, "type": "array", "description": "Look up these companies directly, e.g. to enrich a customer or supplier list. 9-digit SIREN or 14-digit SIRET, up to 1,000 per run. When filled, the search filters below are ignored.", "items": { "type": "string" } }, "query": { "title": "Name or address", "maxLength": 200, "type": "string", "description": "Free text searched in company name and address, e.g. \"boulangerie\" or \"rue de Rivoli\". Leave empty to search by filters only." }, "nafCodes": { "title": "NAF/APE activity codes", "maxItems": 50, "type": "array", "description": "INSEE activity codes in the format \"62.01Z\" (computer programming) or \"6201Z\". Several codes are combined with OR. See the INSEE NAF list for all codes.", "items": { "type": "string" } }, "sections": { "title": "Activity sections", "type": "array", "description": "Broad NAF sections, e.g. F = construction, J = information and communication, M = professional and scientific services.", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U" ], "enumTitles": [ "A - Agriculture, sylviculture et pêche", "B - Industries extractives", "C - Industrie manufacturière", "D - Production et distribution d'électricité, de gaz, de vapeur et d'air conditionné", "E - Production et distribution d'eau ; assainissement, gestion des déchets et dépollution", "F - Construction", "G - Commerce; réparation d'automobiles et de motocycles", "H - Transports et entreposage", "I - Hébergement et restauration", "J - Information et communication", "K - Activités financières et d'assurance", "L - Activités immobilières", "M - Activités spécialisées, scientifiques et techniques", "N - Activités de services administratifs et de soutien", "O - Administration publique", "P - Enseignement", "Q - Santé humaine et action sociale", "R - Arts, spectacles et activités récréatives", "S - Autres activités de services", "T - Activités des ménages en tant qu'employeurs ; activités indifférenciées des ménages en tant que producteurs de biens et services pour usage propre", "U - Activités extra-territoriales" ] } }, "regions": { "title": "Regions", "type": "array", "description": "French regions where the company has at least one establishment. The matching establishment is returned next to the head office.", "items": { "type": "string", "enum": [ "84", "27", "53", "24", "94", "44", "01", "03", "32", "11", "04", "02", "06", "28", "75", "76", "52", "93" ], "enumTitles": [ "Auvergne-Rhône-Alpes", "Bourgogne-Franche-Comté", "Bretagne", "Centre-Val de Loire", "Corse", "Grand Est", "Guadeloupe", "Guyane", "Hauts-de-France", "Île-de-France", "La Réunion", "Martinique", "Mayotte", "Normandie", "Nouvelle-Aquitaine", "Occitanie", "Pays de la Loire", "Provence-Alpes-Côte d'Azur" ] } }, "departements": { "title": "Départements", "maxItems": 110, "type": "array", "description": "Département codes where the company has at least one establishment, e.g. \"75\" (Paris), \"69\" (Rhône), \"2A\" (Corse-du-Sud), \"971\" (Guadeloupe).", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "maxItems": 100, "type": "array", "description": "5-digit postal codes where the company has at least one establishment, e.g. \"75011\".", "items": { "type": "string" } }, "companyCategories": { "title": "Company size category", "type": "array", "description": "INSEE size category: PME = small and medium enterprises, ETI = mid-caps, GE = large enterprises.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME - small and medium-sized", "ETI - mid-sized", "GE - large" ] } }, "employeeRanges": { "title": "Employee ranges", "type": "array", "description": "Number of employees as published by INSEE. Several ranges are combined with OR.", "items": { "type": "string", "enum": [ "NN", "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "No employees (non-employer)", "0 employees at year end", "1-2 employees", "3-5 employees", "6-9 employees", "10-19 employees", "20-49 employees", "50-99 employees", "100-199 employees", "200-249 employees", "250-499 employees", "500-999 employees", "1,000-1,999 employees", "2,000-4,999 employees", "5,000-9,999 employees", "10,000+ employees" ] } }, "labels": { "title": "Labels and certifications", "type": "array", "description": "Only companies with all selected labels: RGE (energy renovation), organic (Agence Bio), Qualiopi (training quality), social economy (ESS), mission company, training provider, association, work integration, living heritage (EPV).", "items": { "type": "string", "enum": [ "rge", "bio", "qualiopi", "ess", "missionCompany", "trainingProvider", "association", "insertion", "livingHeritage" ], "enumTitles": [ "RGE certified", "Organic (Agence Bio)", "Qualiopi", "Social and solidarity economy (ESS)", "Mission company", "Training provider", "Association", "Work integration (SIAE)", "Living heritage (EPV)" ] } }, "minRevenue": { "title": "Minimum revenue (EUR)", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "Only companies with at least this revenue in the latest published accounts. Companies without published accounts are excluded when set." }, "maxRevenue": { "title": "Maximum revenue (EUR)", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "Only companies with at most this revenue in the latest published accounts. Companies without published accounts are excluded when set." }, "activeOnly": { "title": "Only active companies", "type": "boolean", "description": "Return only companies that are still active. Switch off to include ceased companies. Has no effect on direct lookups.", "default": true }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many companies. Each delivered company is charged once, so this also caps the cost. The source returns at most 10,000 per search.", "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 } } } } } } } } } }