{
"openapi": "3.0.1",
"info": {
"title": "Pappers Scraper | French Companies, Directors & Financials",
"description": "Pappers scraper for French company data: search by keyword, pappers.fr link or SIREN/SIRET and get legal form, NAF code, directors, shareholders, revenue, net income, risk scores, phone, email and head office. 20 companies in 24 seconds, 66 fields each. No Pappers account or API key needed.",
"version": "1.0",
"x-build-id": "TMDFUIb5NVjYBQNs6"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/silentflow~pappers-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-silentflow-pappers-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/silentflow~pappers-scraper/runs": {
"post": {
"operationId": "runs-sync-silentflow-pappers-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/silentflow~pappers-scraper/run-sync": {
"post": {
"operationId": "run-sync-silentflow-pappers-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": {
"searches": {
"title": "🔎 Keywords",
"type": "array",
"description": "What you would type in the Pappers search box, one per line: an activity (boulangerie, plombier, agence immobilière) or a company name (Doctolib). Each keyword is one search, narrowed by the filters below. A search reads up to 400 companies; a wide one with no département is then read département by département. To find the companies of a director, paste a pappers.fr search link with the Dirigeants option instead.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "🔗 Pappers links",
"type": "array",
"description": "Links copied from pappers.fr: a company search with its filters (https://www.pappers.fr/recherche?q=plombier&departement=69&en_activite=true), a director search (...&bases=dirigeants) or a company page (https://www.pappers.fr/entreprise/doctolib-794598813). A search link keeps every filter you set on the site (activity, size, revenue, creation date, director's age) and ignores the filters below.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"companyIds": {
"title": "🔢 SIREN or SIRET numbers",
"type": "array",
"description": "Companies you already know, one per line: a SIREN (794598813), a SIRET (79459881300077) or a French VAT number (FR14794598813), spaces allowed. Each number gives one full company row. Handy to refresh a CRM list.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "💯 Max companies",
"minimum": 1,
"type": "integer",
"description": "How many companies to save in total, across every keyword, link and number. A common activity matches thousands of companies in France: set the number you actually need.",
"default": 100
},
"department": {
"title": "📍 Département",
"type": "string",
"description": "One French département, picked in the list or typed as its number or name (75, Paris, 2A, 974). Several, separated by commas: 75, 92, 93. Matches companies with their head office or a branch there."
},
"postalCode": {
"title": "📮 Postal code",
"type": "string",
"description": "Five-digit postal codes, separated by commas: 75011, 69002, 69003. Like the département, matches the head office or a branch."
},
"nafCode": {
"title": "🏭 NAF / APE code",
"type": "string",
"description": "The activity code INSEE gives every company, with or without its dot: 10.71C (bakeries), 62.01Z (software), 43.22A (plumbers), 68.31Z (real estate agencies). Several, separated by commas. Leave empty to search every activity."
},
"onlyActive": {
"title": "✅ Active companies only",
"type": "boolean",
"description": "Keep only the companies still trading. Turn off to include those that ceased or were struck off.",
"default": true
},
"debugMode": {
"title": "🐞 Debug mode",
"type": "boolean",
"description": "Writes extra details to the run log. Leave off unless support asks for it.",
"default": false
}
}
},
"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
}
}
}
}
}
}
}
}
}
}