{ "openapi": "3.0.1", "info": { "title": "France Company Search: SIREN, VAT, Revenue & Directors", "description": "Search French companies by name, NAF activity code, department, postal code, size, revenue or label (RGE, Qualiopi...), or look up SIREN/SIRET lists. Official government API: VAT number, address, GPS, headcount, revenue, net income, directors. $2 per 1,000 companies.", "version": "0.1", "x-build-id": "BsC8ii3Nh5xHNgECx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/larkmoor~france-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-larkmoor-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/larkmoor~france-company-search/runs": { "post": { "operationId": "runs-sync-larkmoor-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/larkmoor~france-company-search/run-sync": { "post": { "operationId": "run-sync-larkmoor-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": { "query": { "title": "Search text", "type": "string", "description": "Company name, brand, keyword, address words or a director's name (e.g. 'boulangerie', 'Michelin'). Optional when you use filters below." }, "sirenOrSiret": { "title": "SIREN / SIRET numbers", "type": "array", "description": "Look up these companies directly: 9-digit SIREN or 14-digit SIRET (spaces allowed). Can be combined with a search.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF / APE activity codes", "type": "array", "description": "Keep companies whose main activity is one of these INSEE NAF codes, e.g. '56.10A' (restaurants), '62.01Z' (software), '43.22A' (plumbing). '5610A' also works.", "items": { "type": "string" } }, "sections": { "title": "Activity sections (A-U)", "type": "array", "description": "Broad INSEE sections, e.g. 'F' (construction), 'I' (hotels & restaurants), 'J' (IT & media), 'Q' (health).", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes where the company has an establishment, e.g. '75' (Paris), '69' (Rhône), '13', '2A', '971'.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes where the company has an establishment, e.g. '75011'.", "items": { "type": "string" } }, "communeCodes": { "title": "Commune INSEE codes", "type": "array", "description": "5-character INSEE commune codes (not postal codes), e.g. '69123' for Lyon.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "2-digit INSEE region codes, e.g. '11' (Île-de-France), '84' (Auvergne-Rhône-Alpes), '93' (Provence-Alpes-Côte d'Azur).", "items": { "type": "string" } }, "employeeRanges": { "title": "Headcount bands", "type": "array", "description": "Keep companies in these INSEE headcount bands. Empty = any size.", "items": { "type": "string", "enum": [ "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "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 category", "type": "array", "description": "INSEE category: PME (SME), ETI (mid-size), GE (large). Empty = all.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME (SME)", "ETI (mid-size)", "GE (large)" ] } }, "legalFormCodes": { "title": "Legal form codes", "type": "array", "description": "INSEE legal-form codes, e.g. '5710' (SAS), '5720' (SASU), '5499' (SARL), '1000' (sole trader), '9220' (association).", "items": { "type": "string" } }, "status": { "title": "Status", "enum": [ "active", "closed", "any" ], "type": "string", "description": "Active companies only (default), closed only, or both.", "default": "active" }, "minRevenue": { "title": "Min revenue (EUR)", "type": "integer", "description": "Keep companies whose latest published revenue (chiffre d'affaires) is at least this. Only companies that publish accounts have revenue." }, "maxRevenue": { "title": "Max revenue (EUR)", "type": "integer", "description": "Keep companies whose latest published revenue is at most this." }, "minNetIncome": { "title": "Min net income (EUR)", "type": "integer", "description": "Keep companies whose latest published net income is at least this (can be negative)." }, "maxNetIncome": { "title": "Max net income (EUR)", "type": "integer", "description": "Keep companies whose latest published net income is at most this." }, "createdAfter": { "title": "Created on or after", "type": "string", "description": "Keep companies created on or after this date (YYYY-MM-DD). Filtered after the search, so very broad searches scan more pages." }, "directorName": { "title": "Director last name", "type": "string", "description": "Keep companies where a director has this last name." }, "onlyEmployers": { "title": "Only companies with employees", "type": "boolean", "description": "Skip companies with 0 or unknown headcount.", "default": false }, "onlyRge": { "title": "Only RGE-certified", "type": "boolean", "description": "Only companies with the RGE (energy renovation) certification - useful for builders and installers.", "default": false }, "onlyQualiopi": { "title": "Only Qualiopi-certified", "type": "boolean", "description": "Only training providers with the Qualiopi certification.", "default": false }, "onlyTrainingOrganisations": { "title": "Only training organisations", "type": "boolean", "description": "Only registered training organisations.", "default": false }, "onlyBio": { "title": "Only organic-certified", "type": "boolean", "description": "Only companies with an establishment certified by Agence Bio.", "default": false }, "onlyEss": { "title": "Only social economy (ESS)", "type": "boolean", "description": "Only companies in the social and solidarity economy.", "default": false }, "onlyAssociations": { "title": "Only associations", "type": "boolean", "description": "Only associations.", "default": false }, "onlySoleTraders": { "title": "Only sole traders", "type": "boolean", "description": "Only entrepreneurs individuels.", "default": false }, "rowPer": { "title": "One row per", "enum": [ "company", "establishment" ], "type": "string", "description": "'Company' = one row per company with its head-office address. 'Establishment' = one row per matching establishment (shop, branch) in your area filters, up to 100 per company.", "default": "company" }, "includeDirectors": { "title": "Include directors", "type": "boolean", "description": "Add directors' names and roles (no birth dates are ever output).", "default": true }, "sortBySize": { "title": "Biggest first", "type": "boolean", "description": "Sort by number of establishments instead of relevance.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many rows. The API serves at most 10,000 companies per search.", "default": 100 } } }, "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 } } } } } } } } } }