{ "openapi": "3.0.1", "info": { "title": "French Company Profile (Sirene + Financials) – Legal Entities", "description": "Search French companies by name, activity, department, size or turnover, or look them up by SIREN/SIRET: legal form, headcount, seat, latest turnover and net result. Legal entities only, no people (GDPR by design). Unofficial, open data.", "version": "0.1", "x-build-id": "whyb5pXArxFlMAPKU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shadow-tools~french-company-profile-sirene/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shadow-tools-french-company-profile-sirene", "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/shadow-tools~french-company-profile-sirene/runs": { "post": { "operationId": "runs-sync-shadow-tools-french-company-profile-sirene", "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/shadow-tools~french-company-profile-sirene/run-sync": { "post": { "operationId": "run-sync-shadow-tools-french-company-profile-sirene", "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": { "mode": { "title": "Mode", "enum": [ "search", "lookup" ], "type": "string", "description": "\"search\" = use when you want a list of companies matching criteria (name words, activity, department, legal form, size, creation dates, turnover). \"lookup\" = use when you already have SIREN or SIRET numbers (for example the winner of a public contract) and want each company's profile and latest financials." }, "query": { "title": "Company name words (search)", "maxLength": 120, "type": "string", "description": "Search mode. Words that must all appear in the company name, accents and case ignored, 1 to 120 characters. Example: \"boulangerie\" or \"transports martin\". Not for numbers: use lookup mode for SIREN/SIRET." }, "nafPrefixes": { "title": "Activity (NAF code or prefix)", "maxItems": 50, "type": "array", "description": "Search mode. List of NAF/APE activity codes or prefixes of the main activity, each 2 digits or more. Example: [\"62\"] for IT services, [\"56.10A\"] for traditional restaurants, [\"47.11\"] for food retail.", "items": { "type": "string" } }, "departments": { "title": "Departments (seat)", "maxItems": 100, "type": "array", "description": "Search mode. List of French department codes where the company has an establishment: 2-3 digits, or 2A / 2B. Example: [\"75\", \"92\"] for Paris and Hauts-de-Seine, [\"971\"] for Guadeloupe.", "items": { "type": "string" } }, "legalForms": { "title": "Legal forms", "type": "array", "description": "Search mode. Closed list of INSEE legal-form codes to keep. Example: [\"5710\"] for SAS only, [\"5499\", \"5498\"] for limited liability companies.", "items": { "type": "string", "enum": [ "5710", "5720", "5499", "5498", "5599", "5699", "5202", "9220", "9230" ], "enumTitles": [ "5710 – SAS", "5720 – SASU (single-shareholder SAS)", "5499 – SARL", "5498 – EURL (single-member SARL)", "5599 – SA (board of directors)", "5699 – SA (management board)", "5202 – SNC (general partnership)", "9220 – Association (declared)", "9230 – Association (public-interest)" ] } }, "headcountBands": { "title": "Headcount bands", "type": "array", "description": "Search mode. Closed list of INSEE employee bands to keep (employer companies). Example: [\"12\", \"21\"] for 20-99 employees.", "items": { "type": "string", "enum": [ "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "00 – 0 employees", "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 or more" ] } }, "sizeCategories": { "title": "Company size category", "type": "array", "description": "Search mode. Closed list of INSEE size categories to keep: PME (small and medium), ETI (mid-cap), GE (large). Example: [\"ETI\", \"GE\"].", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME – small and medium", "ETI – mid-cap", "GE – large" ] } }, "createdFrom": { "title": "Created on or after", "type": "string", "description": "Search mode. Earliest company creation date, format YYYY-MM-DD. Example: 2025-01-01. Applied after fetching (the directory has no date filter), so combine it with a department or NAF prefix to keep it fast." }, "createdTo": { "title": "Created on or before", "type": "string", "description": "Search mode. Latest company creation date, format YYYY-MM-DD. Example: 2025-12-31. Applied after fetching, see createdFrom." }, "onlyActive": { "title": "Only active companies", "type": "boolean", "description": "Search mode. When true, ceased companies are left out. Set false to include ceased companies (status \"ceased\" in the output).", "default": true }, "minTurnover": { "title": "Minimum turnover (EUR)", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "Search mode. Keep companies whose latest published turnover is at least this amount in euros. Example: 1000000. Companies without published accounts are then left out." }, "maxTurnover": { "title": "Maximum turnover (EUR)", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "Search mode. Keep companies whose latest published turnover is at most this amount in euros. Example: 50000000." }, "minNetResult": { "title": "Minimum net result (EUR)", "minimum": -1000000000000, "maximum": 1000000000000, "type": "integer", "description": "Search mode. Keep companies whose latest published net result is at least this amount in euros (can be negative). Example: 0 for profitable companies." }, "maxNetResult": { "title": "Maximum net result (EUR)", "minimum": -1000000000000, "maximum": 1000000000000, "type": "integer", "description": "Search mode. Keep companies whose latest published net result is at most this amount in euros (can be negative). Example: -100000 for loss-making companies." }, "excludeProspectingOptOut": { "title": "Exclude companies opposed to commercial use", "type": "boolean", "description": "Both modes. When true, companies flagged commercialDiffusionOpposition (they asked not to be used for commercial prospecting) or with an unknown flag are left out. Default false; about half of the companies carry the flag.", "default": false }, "ids": { "title": "SIREN / SIRET numbers (lookup)", "maxItems": 10000, "type": "array", "description": "Lookup mode. List of SIREN (9 digits) or SIRET (14 digits) identifiers, spaces tolerated, up to 10000. Example: [\"383474814\", \"552081317\"]. Unknown numbers, sole traders and non-public records are skipped and never charged.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of company records to return (each one is billed). Default 20; in lookup mode the default is the number of ids. Example: 200. The directory exposes at most 10,000 rows per query.", "default": 20 } } }, "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 } } } } } } } } } }