{ "openapi": "3.0.1", "info": { "title": "France Company Registry Scraper - Search, SIREN, VAT", "description": "French company registry API (Sirene): look up a name or SIREN, or search all 26M companies by text, place, activity, size, revenue, director or map radius. Status, address, SIRET, officers, revenue, VAT number and VIES check, BODACC notices. $4 per 1,000 companies. Official source, no key.", "version": "0.1", "x-build-id": "CHvBSI2sO2thuyDT0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/om_kh~france-company-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-om_kh-france-company-registry-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/om_kh~france-company-registry-scraper/runs": { "post": { "operationId": "runs-sync-om_kh-france-company-registry-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/om_kh~france-company-registry-scraper/run-sync": { "post": { "operationId": "run-sync-om_kh-france-company-registry-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": { "companyNames": { "title": "Company names", "type": "array", "description": "Company names to verify against the French Sirene registry.", "items": { "type": "string" } }, "sirenNumbers": { "title": "SIREN numbers", "type": "array", "description": "SIREN registration numbers, if you have them instead of names.", "items": { "type": "string" } }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Reserved for future use pending live schema confirmation.", "default": false }, "includeFilings": { "title": "Include filings", "type": "boolean", "description": "Reserved for future use pending live schema confirmation.", "default": false }, "searchQuery": { "title": "Search text (optional)", "type": "string", "description": "Search the whole register by name, address or director: boulangerie Lyon, Bernard Arnault. Fill this or any filter below to get every matching company." }, "department": { "title": "Department (optional)", "type": "string", "description": "Two-digit code: 75 Paris, 69 Rhône, 13 Bouches-du-Rhône." }, "postalCode": { "title": "Postal code (optional)", "type": "string", "description": "Five digits, e.g. 75009." }, "cityCode": { "title": "INSEE city code (optional)", "type": "string", "description": "e.g. 75109 for Paris 9th." }, "region": { "title": "Region (optional)", "type": "string", "description": "Two-digit code: 11 Île-de-France, 84 Auvergne-Rhône-Alpes." }, "nafCode": { "title": "Activity code NAF / APE (optional)", "type": "string", "description": "e.g. 62.01Z software, 56.10A restaurants." }, "nafSection": { "title": "Activity section (optional)", "type": "string", "description": "One letter: A agriculture, C manufacturing, F construction, G trade, J information, K finance, M consulting." }, "companyCategory": { "title": "Company size (optional)", "enum": [ "", "PME", "ETI", "GE" ], "type": "string", "description": "The official size category.", "default": "" }, "employeeBand": { "title": "Employee band (optional)", "type": "string", "description": "INSEE code: 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=1000-1999, 51=2000-4999, 52=5000-9999, 53=10000+." }, "companyStatus": { "title": "Status", "enum": [ "active", "ceased", "all" ], "type": "string", "description": "For searches.", "default": "active" }, "personLastName": { "title": "Director or elected official: last name (optional)", "type": "string", "description": "e.g. ARNAULT." }, "personFirstName": { "title": "First name (optional)", "type": "string", "description": "Used with the last name." }, "personType": { "title": "Kind of person (optional)", "enum": [ "", "dirigeant", "elu" ], "type": "string", "description": "Used with the name fields.", "default": "" }, "revenueMin": { "title": "Minimum revenue in EUR (optional)", "minimum": 0, "type": "integer", "description": "Only companies that filed accounts have a revenue." }, "revenueMax": { "title": "Maximum revenue in EUR (optional)", "minimum": 0, "type": "integer", "description": "Only companies that filed accounts have a revenue." }, "latitude": { "title": "Map search: latitude (optional)", "type": "string", "description": "With longitude and radius: every company around a point, e.g. 48.8566." }, "longitude": { "title": "Map search: longitude (optional)", "type": "string", "description": "e.g. 2.3522." }, "radiusKm": { "title": "Map search: radius in km", "minimum": 0.1, "maximum": 50, "type": "number", "description": "0.1 to 50 km.", "default": 5 }, "rgeOnly": { "title": "RGE certified only", "type": "boolean", "description": "Reconnu Garant de l'Environnement (eco-construction).", "default": false }, "qualiopiOnly": { "title": "Qualiopi certified only", "type": "boolean", "description": "Training quality certification.", "default": false }, "organicOnly": { "title": "Organic certified only", "type": "boolean", "description": "Agence Bio.", "default": false }, "socialEconomyOnly": { "title": "Social economy only", "type": "boolean", "description": "Économie sociale et solidaire.", "default": false }, "associationsOnly": { "title": "Associations only", "type": "boolean", "description": "Loi 1901 associations.", "default": false }, "trainingOrganizationsOnly": { "title": "Training organizations only", "type": "boolean", "description": "Registered training providers.", "default": false }, "missionCompaniesOnly": { "title": "Mission companies only", "type": "boolean", "description": "Sociétés à mission.", "default": false }, "maxResults": { "title": "Max companies for a search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "1 to 10,000 (the register's own limit per search). Default 100.", "default": 100 }, "validateVat": { "title": "Check the VAT number with the EU", "type": "boolean", "description": "Every company gets its intra-EU VAT number (vat_number). Turn this on to also ask the EU VIES service whether it is valid (vat_valid).", "default": false }, "checkBodacc": { "title": "Check the official gazette (BODACC)", "type": "boolean", "description": "Add the number of gazette notices and the date and kind of the latest one: a quick risk and activity signal.", "default": false }, "analyzeWithAi": { "title": "Analyze each company with AI", "type": "boolean", "description": "Add an ai object: what the company does, and a 0-100 fit score when you describe what you sell. Uses your own Anthropic API key; the model usage is billed by Anthropic to you, not by this Actor.", "default": false }, "anthropicApiKey": { "title": "Your Anthropic API key", "type": "string", "description": "Needed only for the AI analysis. Used for this run only and never stored." }, "aiModel": { "title": "AI model", "type": "string", "description": "Claude model ID, e.g. claude-opus-5-5 (default), claude-sonnet-5-5 or claude-haiku-4-5 for a lower cost.", "default": "claude-opus-5-5" }, "businessProfile": { "title": "What you sell, in one or two sentences (optional)", "type": "string", "description": "Used by the AI to score how well each company fits you." }, "maxAiRows": { "title": "Max companies to analyze", "minimum": 1, "maximum": 500, "type": "integer", "description": "1 to 500 per run.", "default": 100 }, "monitorEnabled": { "title": "Enable monitoring", "type": "boolean", "description": "On later runs with the same Monitor ID, deliver only companies not seen before.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Groups runs into one monitored target. Leave blank for a one-off run." }, "maxTotalChargeUsd": { "title": "Maximum charge (USD)", "minimum": 0, "type": "number", "description": "Hard ceiling on what this run can bill you." } } }, "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 } } } } } } } } } }