{ "openapi": "3.0.1", "info": { "title": "DPE F/G Leads 🇫🇷 Passoires Thermiques, SCI Owners (SIREN)", "description": "Transformez les passoires thermiques en leads B2B : chaque DPE F/G d'une commune, relié au propriétaire (SCI, SARL) via la DGFiP, enrichi SIRENE avec les dirigeants. Seul actor du store à croiser DPE et propriétaire. Mode veille avec digests Slack.", "version": "0.1", "x-build-id": "XLa1WGLXKpQK1CQMf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tagadanar~french-dpe-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tagadanar-french-dpe-leads", "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/tagadanar~french-dpe-leads/runs": { "post": { "operationId": "runs-sync-tagadanar-french-dpe-leads", "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/tagadanar~french-dpe-leads/run-sync": { "post": { "operationId": "run-sync-tagadanar-french-dpe-leads", "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", "required": [ "communes" ], "properties": { "communes": { "title": "Communes", "type": "array", "description": "Communes to scan: 5-character INSEE codes (\"35238\") or names (\"Rennes\"). Up to 20 per run.", "items": { "type": "string" } }, "classes": { "title": "DPE classes", "type": "array", "description": "Energy classes to match. F and G are the rental-ban \"passoires thermiques\".", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G" ] }, "default": [ "F", "G" ] }, "typeBatiment": { "title": "Building type", "enum": [ "any", "maison", "appartement" ], "type": "string", "description": "Houses give the highest owner-match confidence (the parcel owner owns the dwelling).", "default": "any" }, "sinceDays": { "title": "Established within (days)", "minimum": 0, "maximum": 1825, "type": "integer", "description": "Only diagnostics established in the last N days. 0 = no date filter.", "default": 0 }, "ownerFilter": { "title": "Keep", "enum": [ "all", "company-owned", "company-or-syndic" ], "type": "string", "description": "Which records to output. Owner matching always runs; this only filters what you receive and pay for.", "default": "all" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on DPE diagnostics fetched per run (before the owner filter).", "default": 500 }, "monitorMode": { "title": "Monitor mode (only new diagnostics)", "type": "boolean", "description": "Remember diagnostics from previous runs and return only new ones. Schedule the actor to get a feed of fresh F/G leads.", "default": false }, "webhookUrl": { "title": "Webhook / Slack URL", "type": "string", "description": "Monitor mode only: POST a digest of new leads to this URL (Slack incoming webhooks work as-is)." } } }, "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 } } }, "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 } } } } } } } } } }