{ "openapi": "3.0.1", "info": { "title": "SIRENE Scraper: French Company Leads", "description": "Build lists of French companies from the official SIRENE register: filter by NAF code, département, headcount, revenue and creation date. Optionally find each company's website, emails and phones. No account needed.", "version": "0.1", "x-build-id": "rcb8s9lZc8pJ9ReJz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/polunga~sirene-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-polunga-sirene-scraper", "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/polunga~sirene-scraper/runs": { "post": { "operationId": "runs-sync-polunga-sirene-scraper", "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/polunga~sirene-scraper/run-sync": { "post": { "operationId": "run-sync-polunga-sirene-scraper", "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": { "query": { "title": "Keywords", "type": "string", "description": "Optional free text: activity, company name, city... e.g. \"plombier\", \"agence web\"." }, "nafCodes": { "title": "NAF / APE codes", "type": "array", "description": "Activity codes, e.g. 62.01Z (software), 43.22A (plumbing), 56.10A (restaurants), 68.31Z (real estate agencies).", "items": { "type": "string" } }, "nafSections": { "title": "NAF sections", "type": "array", "description": "Broad sectors, letters A to U (e.g. F = construction, J = information & communication).", "items": { "type": "string" } }, "departements": { "title": "Départements", "type": "array", "description": "Département codes, e.g. 75, 69, 13, 2A.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "INSEE region codes, e.g. 84 (Auvergne-Rhône-Alpes), 11 (Île-de-France).", "items": { "type": "string" } }, "employeeRanges": { "title": "Headcount ranges (INSEE codes)", "type": "array", "description": "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+.", "items": { "type": "string" } }, "companyCategory": { "title": "Company category", "enum": [ "PME", "ETI", "GE" ], "type": "string", "description": "PME (SMB), ETI (mid-size), GE (large)." }, "legalForms": { "title": "Legal form codes", "type": "array", "description": "INSEE legal category codes, e.g. 5710 (SAS), 5499 (SARL), 1000 (sole trader).", "items": { "type": "string" } }, "flags": { "title": "Labels", "type": "array", "description": "Only companies with these labels.", "items": { "type": "string", "enum": [ "est_rge", "est_bio", "est_ess", "est_qualiopi", "est_entrepreneur_individuel", "est_association" ] } }, "minRevenue": { "title": "Min revenue (€)", "type": "integer", "description": "Only companies that published accounts." }, "maxRevenue": { "title": "Max revenue (€)", "type": "integer", "description": "Only companies that published accounts." }, "createdAfter": { "title": "Created after", "type": "string", "description": "YYYY-MM-DD. Great for new-business prospecting." }, "createdBefore": { "title": "Created before", "type": "string", "description": "YYYY-MM-DD." }, "onlyActive": { "title": "Only active companies", "type": "boolean", "description": "Skip closed companies.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum companies to return (the register allows up to 10,000 per search).", "default": 100 }, "includeExecutives": { "title": "Include executives", "type": "boolean", "description": "Names and roles of legal representatives as published in the public register.", "default": true }, "findWebsite": { "title": "Find website and contacts", "type": "boolean", "description": "Look for each company's website (verified against SIREN, name and address) and extract generic emails, phones and social profiles. Slower, charged as an extra event when a website is found.", "default": false }, "extractContacts": { "title": "Extract contacts from website", "type": "boolean", "description": "Only used when Find website is on.", "default": true }, "onlyWithContacts": { "title": "Only companies with an email or phone", "type": "boolean", "description": "Drop companies without any contact found.", "default": 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 } } } } } } } } } }