{ "openapi": "3.0.1", "info": { "title": "French Company Leads: Official SIRENE Search with Revenue", "description": "Find French companies by activity, city, department or region, size, revenue and labels from the official SIRENE/RNE registry: SIREN, SIRET, address, GPS, VAT, revenue, net income, directors. Legal open data, no 10,000-result limit.", "version": "0.1", "x-build-id": "SBcuniaUYB6Dy5sU4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/frenchdatalab~french-company-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-frenchdatalab-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/frenchdatalab~french-company-leads/runs": { "post": { "operationId": "runs-sync-frenchdatalab-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/frenchdatalab~french-company-leads/run-sync": { "post": { "operationId": "run-sync-frenchdatalab-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": { "activities": { "title": "Activities", "type": "array", "description": "Everyday trade names in French or English (\"plombier\", \"restaurant\", \"accountant\", \"agence immobilière\"), official NAF/APE codes (\"69.20Z\") or sector letters (\"F\" = construction). Leave empty to search every activity.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City (\"Lyon\"), postal code (\"69003\"), department number (\"69\") or region (\"Bretagne\"). Empty = all of France." }, "locationMatch": { "title": "Location match", "enum": [ "headOffice", "anyEstablishment" ], "type": "string", "description": "Head office in the location (local companies, recommended) or any OPEN establishment there (also national companies with a local branch; the branch address is returned in 'localEstablishment').", "default": "headOffice" }, "keywords": { "title": "Name or keyword", "type": "string", "description": "Optional free-text search on company name, trade name or address (e.g. \"bio\", \"transport\")." }, "companySizes": { "title": "Number of employees", "uniqueItems": true, "type": "array", "description": "Official INSEE headcount ranges. Empty = any size.", "items": { "type": "string", "enum": [ "0", "1-9", "10-49", "50-249", "250-999", "1000+" ], "enumTitles": [ "No employees", "1-9 employees", "10-49 employees", "50-249 employees", "250-999 employees", "1,000+ employees" ] } }, "companyCategories": { "title": "Company category", "uniqueItems": true, "type": "array", "description": "INSEE category: SME, mid-size or large company.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME (SME)", "ETI (mid-size)", "GE (large company)" ] } }, "revenueMin": { "title": "Minimum revenue (€)", "minimum": 0, "type": "integer", "description": "Latest published revenue (chiffre d'affaires), in euros. Only companies that published their accounts can match." }, "revenueMax": { "title": "Maximum revenue (€)", "minimum": 0, "type": "integer", "description": "Latest published revenue, in euros." }, "netIncomeMin": { "title": "Minimum net income (€)", "type": "integer", "description": "Latest published net income (résultat net), in euros. Use 0 to keep only profitable companies." }, "labels": { "title": "Labels & certifications", "uniqueItems": true, "type": "array", "description": "Keep only companies holding ALL the selected labels.", "items": { "type": "string", "enum": [ "rge", "qualiopi", "bio", "ess", "trainingOrganization", "siae", "missionCompany", "livingHeritage" ], "enumTitles": [ "RGE (energy renovation)", "Qualiopi (training quality)", "Organic (Agence Bio)", "Social economy (ESS)", "Training organization", "Integration enterprise (SIAE)", "Mission-driven company", "Living Heritage Company (EPV)" ] } }, "createdAfter": { "title": "Created after", "type": "string", "description": "Only companies created on or after this date (YYYY-MM-DD). Great to target young companies." }, "createdBefore": { "title": "Created before", "type": "string", "description": "Only companies created on or before this date (YYYY-MM-DD)." }, "status": { "title": "Company status", "enum": [ "active", "closed", "all" ], "type": "string", "description": "Active companies only (recommended), closed ones, or both.", "default": "active" }, "excludeSoleProprietors": { "title": "Exclude sole proprietors (entrepreneurs individuels)", "type": "boolean", "description": "Recommended for B2B prospecting: removes one-person businesses registered in a person's own name.", "default": true }, "includeDirectors": { "title": "Include directors", "type": "boolean", "description": "Add the directors published in the national registry (name, first names, role). Birth dates are never included. You are responsible for GDPR-compliant use of personal data.", "default": false }, "largestFirst": { "title": "Multi-site companies first", "type": "boolean", "description": "Sort results by number of establishments (networks and chains first).", "default": false }, "sirenList": { "title": "Enrich a list of SIREN / SIRET (optional)", "type": "array", "description": "Paste SIREN (9 digits) or SIRET (14 digits) numbers, one per line, to get the full record of each company (CRM enrichment). When filled, the search filters above are ignored.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Maximum number of companies to return. Large searches are split automatically to go beyond the official API limit of 10,000 results.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed: the official API is reached directly. Leave off unless advised.", "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 } } } } } } } } } }