{ "openapi": "3.0.1", "info": { "title": "France DPE by commune: energy labels & hogs", "description": "French energy performance (DPE) statistics per commune: labels A to G, energy hogs F and G, building types, periods. No addresses. / Statistiques DPE par commune, sans adresse.", "version": "0.1", "x-build-id": "U5Yx9bvu4S5DOn1Qb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/westbrook_data~dpe-france-communes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-westbrook_data-dpe-france-communes", "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/westbrook_data~dpe-france-communes/runs": { "post": { "operationId": "runs-sync-westbrook_data-dpe-france-communes", "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/westbrook_data~dpe-france-communes/run-sync": { "post": { "operationId": "run-sync-westbrook_data-dpe-france-communes", "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": [ "demo", "live" ], "type": "string", "description": "Demo: one synthetic row, no network, no result charge. Live: official ADEME data. / Démo : une ligne fictive, sans réseau ni événement facturé. Réel : données officielles ADEME.", "default": "demo" }, "communeCodes": { "title": "INSEE commune codes / Codes INSEE des communes", "maxItems": 500, "type": "array", "description": "Up to 500 five-character INSEE codes (59350 for Lille, 2A004 for Ajaccio). For Paris, Lyon and Marseille use the arrondissement codes (75101, 69381, 13201); a city code returns nothing. Invalid codes and duplicates are listed in SUMMARY, never charged. / Jusqu'à 500 codes INSEE à cinq caractères (59350 pour Lille, 2A004 pour Ajaccio). Pour Paris, Lyon et Marseille, utilisez les codes d'arrondissement (75101, 69381, 13201) ; le code de la ville ne renvoie rien. Codes invalides et doublons listés dans SUMMARY, jamais facturés.", "default": [], "items": { "type": "string" } }, "departments": { "title": "Departments / Départements", "maxItems": 5, "type": "array", "description": "Up to 5 department codes (59, 2A, 971): every commune of the department is added (Paris, Lyon and Marseille by arrondissement). At most 1,000 communes per run in total. / Jusqu'à 5 codes de département (59, 2A, 971) : toutes les communes du département sont ajoutées (Paris, Lyon et Marseille par arrondissement). 1 000 communes au plus par run.", "default": [], "items": { "type": "string" } }, "sinceYear": { "title": "Diagnostics since year / Diagnostics depuis l'année", "minimum": 2021, "maximum": 2100, "type": "integer", "description": "Keeps only diagnostics established from January 1 of this year (2021 to current year). Empty: all diagnostics since July 2021. / Ne garde que les diagnostics établis depuis le 1er janvier de cette année (2021 à l'année en cours). Vide : tous les diagnostics depuis juillet 2021." } } }, "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 } } } } } } } } } }