{ "openapi": "3.0.1", "info": { "title": "France Company Leads & SIREN Lookup (SIRENE)", "description": "Build French B2B company lists from the official SIRENE/RNE registry: filter by NAF code, region, department, headcount, revenue and legal form, or look up SIREN/SIRET/VAT numbers. Returns VAT number, address, revenue, certifications. GDPR opt-outs respected.", "version": "0.1", "x-build-id": "aX1wCUwv9tO5an4Va" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eurodata-tools~france-company-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eurodata-tools-france-company-leads", "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/eurodata-tools~france-company-leads/runs": { "post": { "operationId": "runs-sync-eurodata-tools-france-company-leads", "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/eurodata-tools~france-company-leads/run-sync": { "post": { "operationId": "run-sync-eurodata-tools-france-company-leads", "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": "What do you want to do?", "enum": [ "search", "lookup" ], "type": "string", "description": "`search` builds a list of companies from the filters below. `lookup` returns registry data for a list of SIREN / SIRET / VAT numbers or company names.", "default": "search" }, "purpose": { "title": "Purpose of use", "enum": [ "prospecting", "verification" ], "type": "string", "description": "French law lets companies object to the use of their registry data for commercial prospecting (GDPR art. 21, Code de commerce R.123-320). With `prospecting` those companies are left out (and not charged). Choose `verification` only for KYB, supplier checks, compliance or research where you will not use the data to prospect: then every company is returned, with the `prospectingOptOut` flag.", "default": "prospecting" }, "nafCodes": { "title": "Activity codes (NAF / APE)", "type": "array", "description": "Official French activity codes. Exact (`62.01Z`), class (`62.01`), group (`62.0`) or whole division (`62`) are accepted. Examples: `43.21A` electricians, `56.10A` restaurants, `71.12B` engineering firms, `47` retail. Full list: https://www.insee.fr/fr/information/2406147", "items": { "type": "string" } }, "sectors": { "title": "Sectors (broad)", "type": "array", "description": "Broad sectors (NACE sections). Use this or the activity codes above.", "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, forestry and fishing", "B – Mining and quarrying", "C – Manufacturing", "D – Electricity, gas, steam and air conditioning supply", "E – Water supply, sewerage and waste management", "F – Construction", "G – Wholesale and retail trade, repair of motor vehicles", "H – Transportation and storage", "I – Accommodation and food service", "J – Information and communication", "K – Financial and insurance activities", "L – Real estate activities", "M – Professional, scientific and technical activities", "N – Administrative and support service activities", "O – Public administration and defence", "P – Education", "Q – Human health and social work", "R – Arts, entertainment and recreation", "S – Other service activities", "T – Activities of households as employers", "U – Extraterritorial organisations" ] } }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional text search on company name, trade name and address (e.g. `boulangerie`, `solaire`)." }, "regions": { "title": "Regions", "type": "array", "description": "French regions.", "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" ] } }, "departments": { "title": "Departments", "type": "array", "description": "Department numbers, e.g. `75` (Paris), `69` (Rhône), `13` (Bouches-du-Rhône), `2A`, `974`.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes, e.g. `75008`, `69002`.", "items": { "type": "string" } }, "communeCodes": { "title": "Commune INSEE codes", "type": "array", "description": "INSEE commune codes (not postal codes), e.g. `69123` for Lyon, `13055` for Marseille.", "items": { "type": "string" } }, "headOfficeInArea": { "title": "Head office must be in the area", "type": "boolean", "description": "On: only companies whose head office is in the selected area. Off: also companies based elsewhere that have a branch in the area.", "default": true }, "minEmployees": { "title": "Min employees", "minimum": 0, "type": "integer", "description": "Based on the official headcount band (e.g. 10 = companies in the 10-19 band or larger)." }, "maxEmployees": { "title": "Max employees", "minimum": 0, "type": "integer", "description": "Based on the official headcount band." }, "companyCategories": { "title": "Company size category", "type": "array", "description": "Official INSEE category.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME – SME (< 250 employees)", "ETI – mid-size (250–4,999)", "GE – large enterprise (5,000+)" ] } }, "legalForms": { "title": "Legal forms", "type": "array", "description": "Legal form of the company.", "items": { "type": "string", "enum": [ "SAS", "SARL", "SA", "SNC", "SCS_SCA", "SE", "CIVIL", "SCI", "GIE", "COOP", "ASSOCIATION", "FOREIGN", "PUBLIC" ], "enumTitles": [ "SAS / SASU (simplified joint-stock company)", "SARL / EURL (limited liability company)", "SA (public limited company)", "SNC (general partnership)", "SCS / SCA (limited partnership)", "SE (European company)", "Société civile (incl. SCI, SCM, SCP)", "SCI only (real-estate civil company)", "GIE / GEIE (economic interest grouping)", "Agricultural cooperatives (incl. GAEC)", "Association / foundation", "Foreign company (French branch)", "Public body / administration" ] } }, "minRevenue": { "title": "Min revenue (EUR)", "minimum": 0, "type": "integer", "description": "Only companies that published accounts with at least this turnover. Many small companies do not publish accounts and are then left out." }, "maxRevenue": { "title": "Max revenue (EUR)", "minimum": 0, "type": "integer", "description": "Only companies that published accounts with at most this turnover." }, "certifications": { "title": "Certifications and labels", "type": "array", "description": "Only companies that hold all the selected labels, e.g. RGE for energy-renovation installers.", "items": { "type": "string", "enum": [ "rge", "qualiopi", "bio", "ess", "societe_mission", "patrimoine_vivant", "organisme_formation", "siae", "entrepreneur_spectacle", "finess", "achats_responsables", "alim_confiance", "uai" ], "enumTitles": [ "RGE (energy renovation)", "Qualiopi (training quality)", "Organic certified (Agence Bio)", "Social & solidarity economy (ESS)", "Société à mission", "Living Heritage Company (EPV)", "Registered training organisation", "Work-integration enterprise (SIAE)", "Live-entertainment licence", "Health & social care (FINESS)", "Responsible purchasing label (RFAR)", "Food-safety inspected (Alim'Confiance)", "Education establishment (UAI)" ] } }, "maxResults": { "title": "Max companies", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many companies. Queries with more than 10,000 matches are split automatically (by department, then by headcount).", "default": 1000 }, "identifiers": { "title": "SIREN, SIRET, VAT numbers or names", "type": "array", "description": "One per line: `552032534` (SIREN), `55203253400703` (SIRET), `FR27552032534` (VAT) or a company name. Used only in lookup mode.", "items": { "type": "string" } }, "sourceDatasetId": { "title": "Or: read identifiers from a dataset", "type": "string", "description": "ID of an Apify dataset with SIREN / VAT numbers, e.g. the output of EU Company Contacts & VAT Extractor. Combined with the list above." }, "sourceDatasetField": { "title": "Identifier field in that dataset", "type": "string", "description": "Field holding the SIREN, SIRET or VAT number. A list such as `vatIds` also works: non-French VAT IDs are skipped.", "default": "siren" }, "includeNotFound": { "title": "Include rows for numbers not found", "type": "boolean", "description": "Adds a free row with the reason for each identifier that was not found or not returned.", "default": true }, "includeClosed": { "title": "Include closed companies", "type": "boolean", "description": "By default only active companies are returned.", "default": false }, "excludeSoleTraders": { "title": "Exclude sole traders", "type": "boolean", "description": "Sole traders (entrepreneurs individuels, micro-entrepreneurs) are private persons: their company name is their own name. Excluded by default for GDPR reasons.", "default": true }, "includeDirectors": { "title": "Include directors", "type": "boolean", "description": "Adds the officers registered in the RNE (name and role; birth dates are never returned). Only turn on if you have a lawful basis to process this data.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed: the registry API is public. Turn on only if the log shows many rate-limit warnings.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }