{ "openapi": "3.0.1", "info": { "title": "French Company Finder - Sirene Financials", "description": "French company lead lists from Sirene screened by net result and revenue, with net margin, size, matching establishment and optional directors.", "version": "0.5", "x-build-id": "BqOSx0kfwBRWJQdBa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datagrit~french-company-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datagrit-french-company-finder", "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/datagrit~french-company-finder/runs": { "post": { "operationId": "runs-sync-datagrit-french-company-finder", "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/datagrit~french-company-finder/run-sync": { "post": { "operationId": "run-sync-datagrit-french-company-finder", "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, activities or keywords, for example boulangerie or logiciel. Each term is searched separately. Leave empty when you search by filters or by SIREN/SIRET number only. If the input has no search term, no number and no filter at all, the Actor runs a small free example search (boulangerie in department 75) and says so in the status message.", "default": [], "items": { "type": "string" } }, "sirens": { "title": "SIREN or SIRET numbers", "type": "array", "description": "Look up specific companies by 9-digit SIREN or 14-digit SIRET. These lookups ignore the filters below and also return closed companies; a SIRET returns exactly that establishment. Numbers that are not in the public register get a free status row and are listed in the status message; when the input has only numbers and none exists, the run fails.", "default": [], "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "French department codes, for example 75 for Paris, 69 for Rhône or 2A for Corse-du-Sud. A company is returned when it has an establishment in one of these departments; with \"Only active companies\" on (default) that establishment must be open. The establishment is returned in the matchedEstablishment fields. Switch on \"Head office only\" to require the head office itself.", "default": [], "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "INSEE region codes, for example 11 for Île-de-France or 84 for Auvergne-Rhône-Alpes. Same rule as departments: an establishment in the region, open when \"Only active companies\" is on, or the head office when \"Head office only\" is on.", "default": [], "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Postal codes, for example 75011. Same rule as departments: an establishment with this postal code, open when \"Only active companies\" is on, or the head office when \"Head office only\" is on.", "default": [], "items": { "type": "string" } }, "headOfficeOnly": { "title": "Head office only", "type": "boolean", "description": "Keep only companies whose head office is in the requested departments, regions or postal codes. Off by default: any establishment of the company in the location counts.", "default": false }, "activityCodes": { "title": "Activity codes (NAF)", "type": "array", "description": "Main activity codes in the NAF classification, for example 62.01Z for computer programming or 10.71C for bakeries.", "default": [], "items": { "type": "string" } }, "companySizes": { "title": "Company size categories", "type": "array", "description": "Official size category: PME (small and medium), ETI (mid-sized) or GE (large).", "default": [], "items": { "type": "string" } }, "employeeBands": { "title": "Employee bands", "type": "array", "description": "INSEE employee band codes, for example 11 for 10-19 employees, 12 for 20-49, 21 for 50-99, 22 for 100-199.", "default": [], "items": { "type": "string" } }, "legalForms": { "title": "Legal forms", "type": "array", "description": "INSEE legal form codes, for example 5710 for SAS, 5499 for SARL or 5599 for SA.", "default": [], "items": { "type": "string" } }, "minRevenue": { "title": "Minimum revenue (EUR)", "minimum": 0, "type": "integer", "description": "Only companies whose latest published revenue is at least this amount. Only companies that file their accounts publicly have revenue data." }, "maxRevenue": { "title": "Maximum revenue (EUR)", "minimum": 0, "type": "integer", "description": "Only companies whose latest published revenue is at most this amount." }, "minNetResult": { "title": "Minimum net result (EUR)", "type": "integer", "description": "Only companies whose latest net result is at least this amount. Use 1 to keep only profitable companies." }, "maxNetResult": { "title": "Maximum net result (EUR)", "type": "integer", "description": "Only companies whose latest net result is at most this amount. Use 0 to find loss-making companies." }, "onlyActive": { "title": "Only active companies", "type": "boolean", "description": "Skip companies that have ceased activity. With a location filter it also skips companies whose establishments in the location are all closed, and the status message counts them.", "default": true }, "employersOnly": { "title": "Employers only", "type": "boolean", "description": "Keep only companies flagged as employers: the head office is registered as an employer or the company employee band shows at least one employee (the isEmployer field). Checked by the Actor on every record.", "default": false }, "socialEconomyOnly": { "title": "Social and solidarity economy only", "type": "boolean", "description": "Keep only companies flagged as part of the social and solidarity economy (the isSocialEconomy field).", "default": false }, "includeDirectors": { "title": "Include company directors", "type": "boolean", "description": "Adds the names and roles of the directors listed in the register. Off by default because it contains personal data; when you switch it on you are responsible for using it in line with data protection law.", "default": false }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many companies in total. The register search returns at most 10,000 results per search.", "default": 25 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy. Leave disabled: the Sirene search API is public and needs none.", "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 } } } } } } } } } }