{ "openapi": "3.0.1", "info": { "title": "French Company Data API - SIREN, SIRET, NAF & Revenue", "description": "French company data for B2B lead lists: search the official SIRENE-based register by name, NAF code, department, size or revenue. One result = one company: SIREN, SIRET, NAF, employees, revenue, VAT, address, GPS, labels. No login. $1.00 per 1,000 results.", "version": "1.0", "x-build-id": "cDSjo1Itr9DMa7Vbq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rel8ble~france-company-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rel8ble-france-company-data", "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/rel8ble~france-company-data/runs": { "post": { "operationId": "runs-sync-rel8ble-france-company-data", "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/rel8ble~france-company-data/run-sync": { "post": { "operationId": "run-sync-rel8ble-france-company-data", "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": { "searchTerms": { "title": "Search terms (optional)", "type": "array", "description": "Company name, address words, or a SIREN / SIRET number, one per line, e.g. \"boulangerie\", \"Michelin\", \"812809234\". Each term is one search. Leave empty to search on the filters below alone. At least one term or one filter is needed.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF activity codes", "type": "array", "description": "INSEE activity codes, e.g. \"62.01Z\" (software), \"43.21A\" (electricians), \"56.10A\" (restaurants). 6201Z also works. Several codes are combined with OR.", "items": { "type": "string" } }, "nafSections": { "title": "NAF sections", "type": "array", "description": "One letter per line, A to U, e.g. \"F\" for construction.", "items": { "type": "string" } }, "companySizes": { "title": "Company size", "type": "array", "description": "INSEE size category: PME (small and medium), ETI (intermediate), GE (large), one per line.", "items": { "type": "string" } }, "employeeBands": { "title": "Employee bands", "type": "array", "description": "INSEE band codes, one per line: NN no employees reported, 00 = 0, 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+.", "items": { "type": "string" } }, "legalForms": { "title": "Legal form codes", "type": "array", "description": "INSEE four-digit legal form codes, e.g. \"5710\" (SAS), \"5499\" (SARL).", "items": { "type": "string" } }, "minRevenue": { "title": "Minimum revenue (EUR)", "type": "integer", "description": "Optional. Only companies with published accounts can match." }, "maxRevenue": { "title": "Maximum revenue (EUR)", "type": "integer", "description": "Optional. Only companies with published accounts can match." }, "minNetResult": { "title": "Minimum net result (EUR)", "type": "integer", "description": "Optional. Only companies with published accounts can match." }, "maxNetResult": { "title": "Maximum net result (EUR)", "type": "integer", "description": "Optional. Only companies with published accounts can match." }, "labels": { "title": "Labels", "type": "array", "description": "Keep companies on these registers, one per line: rge, bio, qualiopi, ess, training, mission, heritage, association.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes, e.g. \"69\", \"75\", \"2A\", \"971\". These match any establishment of the company, not only the head office: see matchedEstablishment in the output.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "Two-digit INSEE region codes, e.g. \"84\" (Auvergne-Rhone-Alpes). Same matching as departments.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Five-digit postal codes. Same matching as departments.", "items": { "type": "string" } }, "communeCodes": { "title": "INSEE commune codes", "type": "array", "description": "Five-character INSEE commune codes (not postal codes). Same matching as departments.", "items": { "type": "string" } }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "true (default) = leave out ceased companies.", "default": true }, "excludeSoleTraders": { "title": "Leave out sole traders", "type": "boolean", "description": "true (default) = leave out sole traders (entreprises individuelles), whose company name is a person's name. Not charged.", "default": true }, "excludeOptedOut": { "title": "Leave out companies that opposed commercial use", "type": "boolean", "description": "true (default) = leave out companies whose register entry says they oppose commercial use of their data. Not charged. Turn off only if your use is not commercial prospecting.", "default": true }, "includeDirectors": { "title": "Include directors", "type": "boolean", "description": "false (default). true = add directors: name and role as registered. Birth dates are never collected. Names of people are personal data: GDPR applies to how you use them.", "default": false }, "includeEstablishments": { "title": "Include matching establishments", "type": "boolean", "description": "false (default). true = add every establishment that matched the search, up to 100 per company. The first match is always in matchedEstablishment.", "default": false }, "sortBySize": { "title": "Biggest companies first", "type": "boolean", "description": "Sort by number of establishments, biggest first.", "default": false }, "maxResultsPerSearch": { "title": "Max companies per search", "minimum": 0, "type": "integer", "description": "Optional. Companies saved per search term, or in total for a filters-only search, integer >= 0. Default 100; 0 = the API limit of 10,000 per search. Split by department or NAF code to go deeper. You pay per company, so start small.", "default": 100 } } }, "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 } } } } } } } } } }