{ "openapi": "3.0.1", "info": { "title": "France Companies Scraper - SIRENE, SIRET, NAF & Directors", "description": "French companies from the official SIRENE registry, no API key: search by name, NAF, department, postal code, size, revenue, director or map. Pappers search links read filter by filter, free count, BODACC insolvency and VAT checks. SIREN, SIRET, address, revenue, directors. US$ 2 per 1,000.", "version": "0.1", "x-build-id": "gvu1zFueXsPmsRgME" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapewise~france-companies-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapewise-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/scrapewise~france-companies-scraper/runs": { "post": { "operationId": "runs-sync-scrapewise-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/scrapewise~france-companies-scraper/run-sync": { "post": { "operationId": "run-sync-scrapewise-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": { "mode": { "title": "Mode", "enum": [ "search", "count", "geo", "siren" ], "type": "string", "description": "Leave empty for a normal search. 'count' returns one free row per search with the number of matching companies. 'geo' lists the companies around lat/lon within radiusKm." }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Company names, activities or words to search for, one per line (for example: boulangerie, plombier, cabinet comptable, Danone). The registry searches company names, trade names, addresses and directors. Leave empty to search by filters only.", "items": { "type": "string" } }, "sirenNumbers": { "title": "SIREN or SIRET numbers", "type": "array", "description": "9-digit SIREN or 14-digit SIRET numbers, one per line (for example 552032534). Each returns that company (or that establishment in establishments mode).", "items": { "type": "string" } }, "startUrls": { "title": "Links (annuaire-entreprises, pappers.fr, societe.com)", "type": "array", "description": "Links from annuaire-entreprises.data.gouv.fr (/entreprise/danone-552032534, /etablissement/55203253400646, /rechercher?terme=boulangerie&cp_dep=75), pappers.fr (a company page, or a search page whose filters are read one by one: status, departments, NAF, legal form, headcount, revenue, creation dates, director) or societe.com company pages. A search link with a filter this Actor cannot apply is refused with a free UNSUPPORTED_FILTER row, never run wider than you asked.", "items": { "type": "string" } }, "lat": { "title": "Latitude (map search)", "type": "number", "description": "Map search: latitude of the center, for example 48.8566 (Paris)." }, "lon": { "title": "Longitude (map search)", "type": "number", "description": "Map search: longitude of the center, for example 2.3522 (Paris)." }, "radiusKm": { "title": "Radius in km (map search)", "minimum": 0, "maximum": 50, "type": "number", "description": "Map search: radius around the point, up to 50 km. Empty = 5 km." }, "resultType": { "title": "One row per", "enum": [ "companies", "establishments" ], "type": "string", "description": "Companies: one row per legal unit (SIREN) with its head office. Establishments: one row per matching establishment (SIRET), useful to get every shop or branch in a department or postal code.", "default": "companies" }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How many companies to take from each search term, link or filter-only search. Empty = 100. The registry returns up to 10,000 per query; above that the Actor splits the search by department automatically." }, "maxItems": { "title": "Max rows in total", "minimum": 0, "type": "integer", "description": "Hard cap on charged rows for the whole run, across all searches. Empty or 0 = no cap besides the per-search limit." }, "nafCodes": { "title": "NAF / APE codes", "type": "array", "description": "INSEE activity codes, one per line (for example 56.10A restaurants, 62.01Z software development, 10.71C bakeries). Dots are optional.", "items": { "type": "string" } }, "activitySections": { "title": "Activity sections", "type": "array", "description": "NAF section letters A to U (for example F construction, I accommodation and food, J information and communication).", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "French department codes, one per line (75 Paris, 69 Rhône, 13 Bouches-du-Rhône, 2A, 971...). Filters on establishments located there.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "5-digit postal codes, one per line (for example 75011, 69003).", "items": { "type": "string" } }, "communeCodes": { "title": "INSEE commune codes", "type": "array", "description": "5-character INSEE commune codes (not postal codes), one per line (for example 75056 Paris, 69123 Lyon).", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "2-digit INSEE region codes (11 Île-de-France, 84 Auvergne-Rhône-Alpes, 93 Provence-Alpes-Côte d'Azur...).", "items": { "type": "string" } }, "companyCategories": { "title": "Company size category", "uniqueItems": true, "type": "array", "description": "INSEE company category. Empty = any.", "items": { "type": "string", "enum": [ "PME", "ETI", "GE" ], "enumTitles": [ "PME (small and medium)", "ETI (mid-size)", "GE (large)" ] } }, "employeeRanges": { "title": "Employee ranges", "uniqueItems": true, "type": "array", "description": "Headcount range of the company (INSEE). Empty = any.", "items": { "type": "string", "enum": [ "NN", "00", "01", "02", "03", "11", "12", "21", "22", "31", "32", "41", "42", "51", "52", "53" ], "enumTitles": [ "Not an employer", "0", "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+" ] } }, "legalForms": { "title": "Legal forms", "type": "array", "description": "INSEE legal category codes, one per line (5710 SAS, 5720 SASU, 5499 SARL, 5498 EURL, 5599 SA, 6540 SCI, 9220 association). 2-digit codes also work (57 = all SAS).", "items": { "type": "string" } }, "status": { "title": "Status", "enum": [ "active", "closed", "any" ], "type": "string", "description": "Administrative status of the company in the registry.", "default": "active" }, "minRevenue": { "title": "Min revenue (EUR)", "type": "integer", "description": "Only companies whose last published revenue is at least this (only companies that publish accounts have it)." }, "maxRevenue": { "title": "Max revenue (EUR)", "type": "integer", "description": "Only companies whose last published revenue is at most this." }, "associationsOnly": { "title": "Associations only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "essOnly": { "title": "Social and solidarity economy (ESS) only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "rgeOnly": { "title": "RGE certified (energy renovation) only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "bioOnly": { "title": "Organic (Agence Bio) only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "qualiopiOnly": { "title": "Qualiopi certified only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "trainingOrganizationsOnly": { "title": "Training organizations only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "missionCompaniesOnly": { "title": "Sociétés à mission only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "healthSocialOnly": { "title": "Health and social sector (FINESS) only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "livingHeritageOnly": { "title": "Entreprise du Patrimoine Vivant only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "insertionOnly": { "title": "Work integration (SIAE) only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "publicAdministrationsOnly": { "title": "Public administrations only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "localAuthoritiesOnly": { "title": "Local authorities only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "showLicenseOnly": { "title": "Show business license holders only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "responsiblePurchasingOnly": { "title": "Responsible purchasing label (RFAR) only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "foodInspectionOnly": { "title": "With a food safety inspection (Alim'Confiance) only", "type": "boolean", "description": "Registry filter: keep only these organizations." }, "sortBySize": { "title": "Largest companies first", "type": "boolean", "description": "Sort by company size (number of establishments) instead of relevance." }, "excludeSoleProprietors": { "title": "Exclude sole proprietors", "type": "boolean", "description": "Skip entreprises individuelles (legal form 1000): their name is a person's name and their address is often a home. On by default for clean B2B lists. Skipped rows are not charged.", "default": true }, "soleProprietorsOnly": { "title": "Sole proprietors only", "type": "boolean", "description": "Only entreprises individuelles (for example freelancers or craftsmen). Their street address and coordinates are never returned, only city, postal code and department." }, "employersOnly": { "title": "Employers only", "type": "boolean", "description": "Skip companies with no employees (headcount range NN or 0), or establishments not marked as employer." }, "createdAfter": { "title": "Created on or after", "type": "string", "description": "Only companies created on or after this date (2024-01-01, 2024-06 or 2024). Useful for new-business leads." }, "createdBefore": { "title": "Created on or before", "type": "string", "description": "Only companies created on or before this date." }, "excludeKeywords": { "title": "Exclude names containing", "type": "array", "description": "Words, one per line. Companies whose name or trade name contains any of them are skipped and not charged.", "items": { "type": "string" } }, "splitByDepartment": { "title": "Split big searches by department", "type": "boolean", "description": "When a search matches more than 10,000 companies, read it department by department to go past the registry's 10,000 limit. On by default.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy is the default. Change it only to use your own proxies.", "default": { "useApifyProxy": true } }, "includeOfficers": { "title": "Include directors", "type": "boolean", "description": "Directors (name, first names, role; never birth date or nationality). Turn off for lighter rows.", "default": true }, "requireFinancials": { "title": "Only companies with published accounts", "type": "boolean", "description": "Keep only companies with a published revenue figure (revenue, net income, year). Skipped rows are free." }, "checkBodacc": { "title": "Check the BODACC gazette (insolvency)", "type": "boolean", "description": "For each company, add the BODACC official gazette signal: number of notices, last notice date and type, whether there is an insolvency proceeding (procédure collective) and its last judgment. Free open data, same price; slower runs (two extra lookups per company)." }, "validateVat": { "title": "Validate the VAT number (EU VIES)", "type": "boolean", "description": "For each company, check its intra-community VAT number on the European Commission's VIES service: vatValid true or false. Same price; slower runs." } } }, "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 } } } } } } } } } }