{ "openapi": "3.0.1", "info": { "title": "DPE F/G Leads - New Passoires Thermiques Since Last Run", "description": "RGE renovation firms: get only the NEW F and G energy diagnoses (DPE) since your last run, by departement, with surface, year, heating and energy cost. Adds legal entities registered at the address (SIRENE), never private individuals. France only.", "version": "1.0", "x-build-id": "1aHTzVgUPxzcMBzjt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~france-dpe-fg-new-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-france-dpe-fg-new-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/that_red_bird~france-dpe-fg-new-leads/runs": { "post": { "operationId": "runs-sync-that_red_bird-france-dpe-fg-new-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/that_red_bird~france-dpe-fg-new-leads/run-sync": { "post": { "operationId": "run-sync-that_red_bird-france-dpe-fg-new-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", "properties": { "departments": { "title": "Departements", "type": "array", "description": "French departement codes, for example 75, 69, 13, 33, 2A. Each run reads only diagnoses received after the previous run for this exact combination of filters.", "default": [ "75" ], "items": { "type": "string" } }, "labels": { "title": "Energy labels", "type": "array", "description": "Which DPE energy classes to return. F and G are the passoires thermiques (banned from rental in stages by law). Add E to widen.", "items": { "type": "string", "enum": [ "E", "F", "G" ] }, "default": [ "F", "G" ] }, "buildingTypes": { "title": "Building types", "type": "array", "description": "Keep only these types: appartement, maison, immeuble. Leave empty for all types. Immeuble (whole building) diagnoses are the most useful for renovation firms.", "items": { "type": "string", "enum": [ "appartement", "maison", "immeuble" ] }, "default": [] }, "sinceDays": { "title": "First-run window (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "On the very first run there is no memory, so this many days back from today are read. Later runs continue from where the previous run stopped.", "default": 7 }, "maxResults": { "title": "Max diagnoses per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Oldest-first up to this number; the next run continues after the last one delivered, so nothing is skipped. You are charged per diagnosis delivered, so this is also your spending cap.", "default": 100 }, "joinCompanies": { "title": "Add companies at the address", "type": "boolean", "description": "Look up each address in SIRENE (recherche-entreprises.api.gouv.fr) and list legal entities registered at it. This is the registered address, not proof of ownership. Sole traders and private individuals are never listed.", "default": true }, "stateStoreName": { "title": "Memory store name", "type": "string", "description": "Named key-value store that remembers how far each filter combination has been read. Use the same name on every scheduled run and a different name per client. Empty = every run starts from the first-run window.", "default": "france-dpe-fg-state" } } }, "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 } } } } } } } } } }