{ "openapi": "3.0.1", "info": { "title": "French Company Search: SIREN, SIRET & Pappers Alternative", "description": "Search millions of French companies (sole traders excluded) from the official SIRENE registry: SIREN, SIRET, NAF code, address, headcount, revenue, net income and VAT number. Filter by keyword, postal code, department, NAF code, size or legal form. No API key.", "version": "0.1", "x-build-id": "g1hxrV5yl828eZnvQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boubap~france-companies-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boubap-france-companies-scraper", "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/boubap~france-companies-scraper/runs": { "post": { "operationId": "runs-sync-boubap-france-companies-scraper", "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/boubap~france-companies-scraper/run-sync": { "post": { "operationId": "run-sync-boubap-france-companies-scraper", "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, SIREN or SIRET number, or activity words. Examples: boulangerie, Renault, 812809234. Leave empty if you use another filter. At least one filter (this field or any other) is required." }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Postal codes of the headquarters or of an establishment, one per line. Examples: 75011, 69003. Several values combine with OR.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "French department codes, one per line. Examples: 75, 69, 2A, 971. Several values combine with OR.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF / APE activity codes", "type": "array", "description": "Main activity codes, written with the dot, one per line. Examples: 62.01Z (software development), 10.71C (bakeries), 56.10A (restaurants). Several values combine with OR.", "items": { "type": "string" } }, "employeeRanges": { "title": "Headcount ranges", "type": "array", "description": "INSEE employee headcount ranges to keep. Pick one or more, for example 11 (10-19 employees) and 12 (20-49). Leave empty for any headcount.", "items": { "type": "string", "enum": [ "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "0", "1-2", "3-5", "6-9", "10-19", "20-49", "50-99", "100-199", "200-249", "250-499", "500-999", "1000-1999", "2000-4999", "5000-9999", "10000+" ] } }, "legalCategories": { "title": "Legal form codes", "type": "array", "description": "INSEE legal category codes, one per line. Examples: 5710 (SAS), 5499 (SARL), 5720 (SASU), 9220 (association). Several values combine with OR.", "items": { "type": "string" } }, "companySize": { "title": "Company size", "enum": [ "PME", "ETI", "GE" ], "type": "string", "description": "INSEE company category: SME (PME), mid-size (ETI) or large (GE). Leave empty for any size." }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "When enabled, closed companies are left out. Default: enabled. Disable it to include companies that ceased activity.", "default": true }, "maxResults": { "title": "Max companies", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit of companies returned. Minimum 1, maximum 10,000 (the registry serves up to 10,000 results per search), default 500. To go further, split the search by department or postal code.", "default": 500 } } }, "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 } } } } } } } } } }