{ "openapi": "3.0.1", "info": { "title": "French Company Leads – SIRENE, SIREN & VAT (No 10k Cap)", "description": "Export every French company matching your filters (NAF/APE code, département, headcount, revenue, RGE/Qualiopi/Bio labels) or enrich a SIREN/SIRET list. Official INSEE Sirene + RNE data, VAT number, GPS, financials. No 10,000-result cap. $3 per 1,000 companies.", "version": "0.0", "x-build-id": "lgBh86hraKs33khGu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spherical_distinction~french-company-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spherical_distinction-french-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/spherical_distinction~french-company-leads/runs": { "post": { "operationId": "runs-sync-spherical_distinction-french-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/spherical_distinction~french-company-leads/run-sync": { "post": { "operationId": "run-sync-spherical_distinction-french-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": "Mode", "enum": [ "search", "enrich", "vat" ], "type": "string", "description": "Search: build a list from filters (or look up one company by name, SIREN, SIRET or VAT number). Enrich: look up a list of SIREN / SIRET / VAT numbers. VAT lookup: validate French VAT numbers with the EU VIES service and return the company data.", "default": "search" }, "query": { "title": "Company name, SIREN, SIRET or VAT number (optional)", "type": "string", "description": "Free text on company name / address / director (e.g. \"boulangerie\", \"plomberie Lyon\"), or one identifier: SIREN (9 digits), SIRET (14 digits) or French VAT number (FR + 2-character key + SIREN). Identifiers do an exact lookup (NAF / department filters still apply; ceased companies are returned with isActive = false). Leave empty to use filters only." }, "nafCodes": { "title": "NAF / APE activity codes", "type": "array", "description": "INSEE NAF rev.2 codes, e.g. 62.01Z (software), 43.22A (plumbing), 56.10A (restaurants). 6201Z format also accepted.", "items": { "type": "string" } }, "nafSections": { "title": "NAF sections", "type": "array", "description": "Broad activity sections (A–U), e.g. F = construction, I = hotels & restaurants, J = information & communication.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "French department codes, e.g. 75, 69, 13, 2A, 971. Filters on establishment location.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes (codes postaux).", "items": { "type": "string" } }, "communeCodes": { "title": "INSEE commune codes", "type": "array", "description": "5-character INSEE commune codes (not postal codes), e.g. 35238 for Rennes.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "INSEE region codes, e.g. 11 Île-de-France, 53 Bretagne, 84 Auvergne-Rhône-Alpes.", "items": { "type": "string" } }, "headcountRanges": { "title": "Headcount ranges (tranches d'effectif)", "type": "array", "description": "INSEE headcount codes: NN no employees, 00 = 0, 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 = 1000–1999, 51 = 2000–4999, 52 = 5000–9999, 53 = 10000+.", "items": { "type": "string", "enum": [ "NN", "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "No employees", "0 employees", "1–2", "3–5", "6–9", "10–19", "20–49", "50–99", "100–199", "200–249", "250–499", "500–999", "1 000–1 999", "2 000–4 999", "5 000–9 999", "10 000+" ] } }, "companyCategories": { "title": "Company size category", "type": "array", "description": "INSEE category: PME (SME), ETI (mid-cap), GE (large enterprise).", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME – SME", "ETI – mid-cap", "GE – large enterprise" ] } }, "legalForms": { "title": "Legal forms (nature juridique codes)", "type": "array", "description": "INSEE legal category codes, e.g. 5710 SAS, 5499 SARL, 5720 SASU, 1000 sole trader, 9220 association.", "items": { "type": "string" } }, "certifications": { "title": "Labels & certifications", "type": "array", "description": "Keep only companies holding ALL selected labels.", "items": { "type": "string", "enum": [ "rge", "qualiopi", "bio", "ess", "trainingOrganisation", "missionCompany", "insertion", "livingHeritage", "performingArts", "association", "healthSocial", "responsiblePurchasing" ], "enumTitles": [ "RGE (energy renovation)", "Qualiopi (training)", "Organic (Agence Bio)", "Social & solidarity economy (ESS)", "Training organisation", "Société à mission", "Insertion (SIAE)", "Entreprise du Patrimoine Vivant", "Performing-arts licence", "Association", "Health & social (FINESS)", "Responsible purchasing label (RFAR)" ] } }, "revenueMin": { "title": "Min revenue (€)", "type": "integer", "description": "Minimum turnover (chiffre d'affaires) from the latest published accounts. Only companies that publish accounts match." }, "revenueMax": { "title": "Max revenue (€)", "type": "integer", "description": "Maximum turnover." }, "netIncomeMin": { "title": "Min net income (€)", "type": "integer", "description": "Minimum net result (résultat net)." }, "netIncomeMax": { "title": "Max net income (€)", "type": "integer", "description": "Maximum net result." }, "createdAfter": { "title": "Created on/after (YYYY-MM-DD)", "type": "string", "description": "Keep companies created on or after this date (applied after download — still browses matching companies)." }, "createdBefore": { "title": "Created on/before (YYYY-MM-DD)", "type": "string", "description": "Keep companies created on or before this date." }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Exclude ceased companies (état administratif = C).", "default": true }, "soleTraders": { "title": "Sole traders (entreprises individuelles)", "enum": [ "include", "exclude", "only" ], "type": "string", "description": "Sole traders' company name is usually a person's name (personal data under GDPR). Choose 'exclude' for a companies-only list.", "default": "include" }, "sirenList": { "title": "SIREN / SIRET / VAT list (enrich mode)", "type": "array", "description": "One SIREN (9 digits), SIRET (14 digits) or French VAT number (FRkk + SIREN) per line. Spaces and dots are ignored.", "items": { "type": "string" } }, "vatNumbers": { "title": "French VAT numbers, SIREN or SIRET (VAT lookup mode)", "type": "array", "description": "One per line: French VAT number (e.g. FR27552032534), SIREN or SIRET. For each one the Actor derives the SIREN, computes the expected VAT key, checks validity with the EU VIES service (about 1 check per second) and returns the Sirene company data. Each number is checked once per run.", "items": { "type": "string" } }, "outputLevel": { "title": "One row per…", "enum": [ "company", "establishment" ], "type": "string", "description": "Company: one row per legal entity (head office address). Establishment: one row per matching site/branch (useful with location filters).", "default": "company" }, "directorsMode": { "title": "Directors (dirigeants)", "enum": [ "namesAndRoles", "legalEntitiesOnly", "none" ], "type": "string", "description": "Directors come from the public RNE register. Birth dates are never exported (GDPR data minimisation).", "default": "namesAndRoles" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of rows to save (search mode). You pay per row.", "default": 100 }, "splitLargeQueries": { "title": "Go beyond 10 000 results", "type": "boolean", "description": "The official API stops at 10 000 results per query. When enabled, large queries are automatically split (by department, headcount…) to fetch everything.", "default": true }, "requestsPerSecond": { "title": "Requests per second", "minimum": 1, "maximum": 6, "type": "integer", "description": "Politeness limit. The API allows 7 req/s per IP; keep ≤ 6.", "default": 5 } } }, "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 } } } } } } } } } }