{ "openapi": "3.0.1", "info": { "title": "France Company Registry Scraper — SIREN, Officers & Revenue", "description": "Search the France company registry by name, SIREN or SIRET. Export legal form, NAF code, address, VAT number, officers and published revenue for B2B prospecting, KYC checks and market analysis, with industry, location and size filters.", "version": "0.2", "x-build-id": "5Zk5rhwZ8YJwIwSbE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~france-company-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-france-company-registry", "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/s-r~france-company-registry/runs": { "post": { "operationId": "runs-sync-s-r-france-company-registry", "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/s-r~france-company-registry/run-sync": { "post": { "operationId": "run-sync-s-r-france-company-registry", "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": "Query", "maxLength": 1000, "type": "string", "description": "Company name, address, officer name, 9-digit SIREN or 14-digit SIRET. Use either query or sirens." }, "sirens": { "title": "Sirens", "type": "array", "description": "Identifiers to look up individually, retaining input order and removing duplicates.", "items": { "type": "string" } }, "naf_codes": { "title": "Naf codes", "type": "array", "description": "NAF rev.2 codes as a string array or comma-separated string.", "items": { "type": "string" } }, "postal_codes": { "title": "Postal codes", "type": "array", "description": "Filter by establishment postal codes.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Filter by establishment departments.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "Filter by establishment regions.", "items": { "type": "string" } }, "legal_forms": { "title": "Legal forms", "type": "array", "description": "Filter by legal forms, using the official code table.", "items": { "type": "string" } }, "employee_ranges": { "title": "Employee ranges", "type": "array", "description": "Filter by employee bands, using the official code table.", "items": { "type": "string" } }, "company_category": { "title": "Company category", "enum": [ "PME", "ETI", "GE" ], "type": "string", "description": "Official company size category." }, "status": { "title": "Status", "enum": [ "active", "closed", "any" ], "type": "string", "description": "Administrative company status. any applies no status filter.", "default": "any" }, "officer_last_name": { "title": "Officer last name", "type": "string", "description": "Filter by an officer surname." }, "officer_first_name": { "title": "Officer first name", "type": "string", "description": "Filter by officer given names." }, "revenue_min": { "title": "Revenue min", "minimum": 0, "type": "integer", "description": "Minimum available revenue in euros." }, "revenue_max": { "title": "Revenue max", "minimum": 0, "type": "integer", "description": "Maximum available revenue in euros." }, "net_income_min": { "title": "Net income min", "type": "integer", "description": "Minimum available net income in euros; negative values are allowed." }, "net_income_max": { "title": "Net income max", "type": "integer", "description": "Maximum available net income in euros; negative values are allowed." }, "max_results": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum unique companies across the entire cursor sequence, excluding officers.", "default": 100 }, "include_officers": { "title": "Include officers", "type": "boolean", "description": "Include available officers with a published role in the separate officers output. Officers are included without an extra company charge.", "default": true }, "page_size": { "title": "Page size", "minimum": 1, "maximum": 25, "type": "integer", "description": "Companies requested per source page. Keep this unchanged when resuming a cursor.", "default": 25 }, "cursor": { "title": "Cursor", "maxLength": 400000, "type": "string", "description": "Opaque continuation token returned as next_cursor. Keep the original search and options." } } }, "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 } } } } } } } } } }