{ "openapi": "3.0.1", "info": { "title": "France Company Search (SIRENE) - SIREN, Directors $2/1K", "description": "Search French companies in the official SIRENE register: SIREN/SIRET, NAF code, legal form, address, headcount, directors and revenue. Filter by activity, department, postcode, size and creation date. $2 per 1,000 companies.", "version": "0.1", "x-build-id": "YvnDn6rzrpKEcF8wq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plotpointtech~france-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plotpointtech-france-company-search", "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/plotpointtech~france-company-search/runs": { "post": { "operationId": "runs-sync-plotpointtech-france-company-search", "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/plotpointtech~france-company-search/run-sync": { "post": { "operationId": "run-sync-plotpointtech-france-company-search", "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": { "searchQuery": { "title": "Search (name, keyword or address)", "type": "string", "description": "Words to search in company names, trade names, addresses and director names, e.g. boulangerie, Danone, 'agence web Lyon'. Leave empty to search by filters only.", "default": "boulangerie" }, "sirenOrSiret": { "title": "SIREN / SIRET lookup", "type": "array", "description": "Look up specific companies by 9-digit SIREN or 14-digit SIRET (spaces allowed). Can be combined with a search, or used alone.", "default": [], "items": { "type": "string" } }, "nafCodes": { "title": "NAF / APE activity codes", "type": "array", "description": "Only companies whose main activity is one of these NAF rev. 2 codes, e.g. 62.01Z or 6201Z (software development), 10.71C (bakery).", "default": [], "items": { "type": "string" } }, "nafSections": { "title": "NAF sections", "type": "array", "description": "Broad activity sections (A to U).", "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, fishing", "B Mining", "C Manufacturing", "D Electricity, gas", "E Water, waste", "F Construction", "G Wholesale and retail trade", "H Transport and storage", "I Accommodation and food", "J Information and communication", "K Finance and insurance", "L Real estate", "M Professional, scientific, technical", "N Administrative and support", "O Public administration", "P Education", "Q Health and social work", "R Arts and recreation", "S Other services", "T Households", "U Extraterritorial" ] }, "default": [] }, "departments": { "title": "Departments", "type": "array", "description": "Department codes, e.g. 75 (Paris), 69 (Rhone), 13, 2A, 971. Matches companies with at least one establishment there.", "default": [ "69" ], "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes, e.g. 75011. Matches establishments.", "default": [], "items": { "type": "string" } }, "communeCodes": { "title": "Commune INSEE codes", "type": "array", "description": "5-character INSEE commune codes (not postal codes), e.g. 69123 (Lyon), 75111 (Paris 11e).", "default": [], "items": { "type": "string" } }, "legalForms": { "title": "Legal forms", "type": "array", "description": "INSEE legal-form codes (e.g. 5710), code prefixes (e.g. 55) or shortcuts (SIRENE files SASU under SAS and EURL under SARL): SAS, SARL, SA, SCI, SNC, EI, SELARL, SELAS, ASSOCIATION.", "default": [], "items": { "type": "string" } }, "staffSizes": { "title": "Staff-size brackets", "type": "array", "description": "INSEE headcount brackets (employees).", "items": { "type": "string", "enum": [ "NN", "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "NN: No employees (non-employer)", "00: 0 employees at year end", "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: 1,000-1,999", "51: 2,000-4,999", "52: 5,000-9,999", "53: 10,000+" ] }, "default": [] }, "companyCategories": { "title": "Company category", "type": "array", "description": "INSEE category: SME, mid-size or large enterprise.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME (SME)", "ETI (mid-size)", "GE (large)" ] }, "default": [] }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Skip companies that have ceased trading.", "default": true }, "createdFrom": { "title": "Created on or after", "type": "string", "description": "Creation date range start (YYYY-MM-DD). Applied to search results, so combine it with a search or another filter." }, "createdTo": { "title": "Created on or before", "type": "string", "description": "Creation date range end (YYYY-MM-DD)." }, "minRevenue": { "title": "Minimum revenue (EUR)", "type": "integer", "description": "Only companies whose latest published revenue is at least this. Companies without published accounts are excluded when set." }, "maxRevenue": { "title": "Maximum revenue (EUR)", "type": "integer", "description": "Only companies whose latest published revenue is at most this." }, "excludeSoleTraders": { "title": "Exclude sole traders (EI)", "type": "boolean", "description": "Skip individual entrepreneurs (entreprises individuelles) and return only companies and other legal entities.", "default": false }, "sortBySize": { "title": "Largest companies first", "type": "boolean", "description": "Sort by company size (number of establishments) instead of relevance.", "default": false }, "includeEstablishments": { "title": "Establishments (SIRET)", "enum": [ "none", "matching", "all" ], "type": "string", "description": "Add a list of establishments to each company. 'Matching' = those matching your search or location filters (no extra requests). 'All' = all establishments the API returns for the company (one extra request per company, slower).", "default": "none" }, "maxEstablishmentsPerCompany": { "title": "Max establishments per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on establishments listed per company.", "default": 20 }, "includeDirectors": { "title": "Include directors (dirigeants)", "type": "boolean", "description": "Directors and officers as published in the national company register (RNE): name, role, or the company that holds the role.", "default": true }, "includeDirectorBirthYear": { "title": "Include directors' birth year", "type": "boolean", "description": "Add the birth year the register publishes for directors who are natural persons. Off by default (data minimisation).", "default": false }, "includeFinancials": { "title": "Include financials", "type": "boolean", "description": "Revenue and net income by year where the company's accounts are published.", "default": true }, "prospectingOptOuts": { "title": "Commercial prospecting opt-outs", "enum": [ "skipSoleTraders", "skipAll", "keep" ], "type": "string", "description": "Some register entries carry an objection to reuse for commercial prospecting (GDPR art. 21, Code de commerce R.123-320). Default skips sole traders (natural persons) with this objection. Every record also has a prospectingOptOut field.", "default": "skipSoleTraders" }, "maxResults": { "title": "Maximum companies", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many companies. One search can reach at most 10,000 results; narrow filters (e.g. by department) to go further.", "default": 50 } } }, "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 } } } } } } } } } }