{ "openapi": "3.0.1", "info": { "title": "French Company Search (SIRENE) in English + Insights", "description": "Search the official French company registry (SIRENE / RNE) with English field names and labels, directors, normalized HQ addresses, VAT numbers, new-company detection, change tracking and a free market-insight summary.", "version": "0.1", "x-build-id": "qTuI6ZBF8c3u3zcRO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zerahdata~france-company-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zerahdata-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/zerahdata~france-company-leads/runs": { "post": { "operationId": "runs-sync-zerahdata-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/zerahdata~france-company-leads/run-sync": { "post": { "operationId": "run-sync-zerahdata-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": { "queries": { "title": "Search terms", "type": "array", "description": "Company names, brands, keywords, or addresses (French search, e.g. \"boulangerie\", \"agence web\", \"Danone\"). Each term is a separate search. Leave empty to search by filters only.", "items": { "type": "string" } }, "sirenList": { "title": "SIREN / SIRET numbers", "type": "array", "description": "Look up specific companies by 9-digit SIREN (or 14-digit SIRET). Invalid numbers produce a free error row.", "items": { "type": "string" } }, "activityCodes": { "title": "Activity codes (NAF/APE)", "type": "array", "description": "NAF rev.2 codes like 62.01Z or 6201Z, or a section letter A-U (e.g. J = Information and communication). Labels are returned in English and French.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes or names, e.g. 75, 69, 2A, Gironde.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "Region names or INSEE codes, e.g. Île-de-France, Occitanie, 84.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes, e.g. 33000.", "items": { "type": "string" } }, "hqInAreaOnly": { "title": "Headquarters must be in the area", "type": "boolean", "description": "Location filters match any establishment of a company. Enable to keep only companies whose headquarters is in the selected departments / regions / postal codes.", "default": false }, "headcountRanges": { "title": "Employee ranges", "type": "array", "description": "Registered headcount ranges (number of employees).", "items": { "type": "string", "enum": [ "0", "1-2", "3-5", "6-9", "10-19", "20-49", "50-99", "100-199", "200-249", "250-499", "500-999", "1000-1999", "2000-4999", "5000-9999", "10000+" ] } }, "companyCategories": { "title": "Company size category", "type": "array", "description": "Official INSEE size category.", "items": { "type": "string", "enum": [ "SME", "ETI", "GE" ], "enumTitles": [ "SME", "Intermediate-sized enterprise (ETI)", "Large enterprise" ] } }, "legalForms": { "title": "Legal form codes", "type": "array", "description": "INSEE legal form codes (catégorie juridique), e.g. 5710 = SAS, 5499 = SARL, 5720 = SASU, 1000 = sole proprietor. 2-digit prefixes are accepted.", "items": { "type": "string" } }, "createdAfter": { "title": "Created on or after", "type": "string", "description": "YYYY-MM-DD. When used without search terms, the actor switches to new-company mode: it reads official BODACC creation notices published since this date, newest first, then enriches each company." }, "createdBefore": { "title": "Created on or before", "type": "string", "description": "YYYY-MM-DD." }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Exclude closed companies.", "default": true }, "employerOnly": { "title": "Employers only", "type": "boolean", "description": "Keep only companies flagged as employers.", "default": false }, "minRevenueEur": { "title": "Minimum revenue (EUR)", "minimum": 0, "type": "integer", "description": "Only companies with published accounts above this revenue." }, "maxRevenueEur": { "title": "Maximum revenue (EUR)", "minimum": 0, "type": "integer", "description": "Only companies with published accounts below this revenue." }, "directorLastName": { "title": "Director last name", "type": "string", "description": "Find companies where a person with this last name is a director or officer." }, "onlySoleProprietors": { "title": "Sole proprietors only", "type": "boolean", "description": "Keep only individual entrepreneurs (entreprise individuelle).", "default": false }, "excludeAssociations": { "title": "Exclude associations", "type": "boolean", "description": "Remove non-profit associations from the results.", "default": false }, "excludeConfidential": { "title": "Skip non-public records", "type": "boolean", "description": "Skip companies whose owners opted out of public disclosure (their name and address are hidden in the registry, so they are useless as leads). Skipped records are never charged.", "default": true }, "maxResults": { "title": "Max companies per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum company rows per search term (or per filter-only search).", "default": 20 }, "maxPagesToScan": { "title": "Max pages to scan", "minimum": 1, "maximum": 400, "type": "integer", "description": "Safety limit for searches that use post-download filters (creation date, employer, HQ in area) and for new-company mode (1 page = 25 registry records or 100 BODACC notices).", "default": 40 }, "includeDirectors": { "title": "Include directors", "type": "boolean", "description": "Directors and officers with English role names (President, Managing Director, Statutory Auditor...).", "default": true }, "includeDirectorBirthYear": { "title": "Include director birth year", "type": "boolean", "description": "Personal data: only enable if you have a lawful basis to process it.", "default": false }, "outputMode": { "title": "Output", "enum": [ "all", "companiesOnly", "summaryOnly" ], "type": "string", "description": "Choose which rows go to the dataset. In summary-only mode each analyzed company is billed like a company row, but only the summary is stored.", "default": "all" }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Remember the results of each search and report new and closed companies on the next run (free change rows; isNew flag on companies). Ideal for scheduled runs.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Separate change-tracking memory per monitor (e.g. one per client)." }, "requestsPerSecond": { "title": "Requests per second", "minimum": 1, "maximum": 7, "type": "integer", "description": "The public API allows 7 requests per second per IP. Lower it if you see rate-limit errors.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Not needed for normal use.", "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 } } } } } } } } } }