{ "openapi": "3.0.1", "info": { "title": "France Company Search - SIREN, SIRET & B2B Lists (Sirene)", "description": "French company data from the official government API: SIREN/SIRET lookup or B2B lists by NAF code, department and size, with address, VAT number, headcount, revenue and directors. $1.50 per 1,000 companies; not found free.", "version": "0.1", "x-build-id": "5ekrxlYd4NhRWAh8B" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tinyrex~france-company-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tinyrex-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/tinyrex~france-company-search/runs": { "post": { "operationId": "runs-sync-tinyrex-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/tinyrex~france-company-search/run-sync": { "post": { "operationId": "run-sync-tinyrex-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": { "companies": { "title": "SIREN, SIRET or company names", "type": "array", "description": "One per line: SIREN (9 digits), SIRET (14 digits), French VAT number (FR + 11 digits) for an exact lookup, or a company name for the best match. Invalid numbers and names with no match are free.", "items": { "type": "string" } }, "maxResultsPerName": { "title": "Results per company name", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many matches to return for each company name (best match first). SIREN/SIRET lookups always return one company.", "default": 1 }, "preferLargest": { "title": "Prefer the largest company for names", "type": "boolean", "description": "Rank name matches by company size, so \"Michelin\" returns the Michelin group company instead of a one-person shop with the same name. Turn off for pure text relevance.", "default": true }, "searchQuery": { "title": "Search text (B2B list)", "type": "string", "description": "Optional free text for a list search (name, address, director). Combine with the filters below, or use the filters alone." }, "nafCodes": { "title": "NAF / APE codes", "type": "array", "description": "Activity codes, e.g. 62.01Z (software), 56.10A (restaurants), 43.21A (electricians). 6201Z also works.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes, e.g. 75 (Paris), 69 (Rhone), 13, 2A.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes, e.g. 69002. Matches companies with an establishment there.", "items": { "type": "string" } }, "employeeRanges": { "title": "Employee ranges", "type": "array", "description": "INSEE headcount bands (tranche d'effectif).", "items": { "type": "string", "enum": [ "NN", "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "Non-employer", "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 size category.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "SME (PME)", "Mid-size (ETI)", "Large (GE)" ] } }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "Skip ceased companies in name lookups and list searches (SIREN/SIRET lookups always return the company).", "default": true }, "maxResults": { "title": "Max companies from the list search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap for the filtered search (the API serves at most 10,000 per search; split by department to get more).", "default": 100 }, "includeDirectors": { "title": "Include directors", "type": "boolean", "description": "Directors and officers from the national register (RNE): name and role only, no birth dates.", "default": true } } }, "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 } } } } } } } } } }