{ "openapi": "3.0.1", "info": { "title": "France Company Carbon Reports: ADEME BEGES Emissions", "description": "Official greenhouse gas reports (BEGES) of French companies, public bodies and local authorities, from ADEME. Look up SIRENs or filter by sector (NAF), department, year or CSRD. Scope 1, 2 and 3 in tCO2e, 22-line breakdown, targets, report links. Pay per report.", "version": "1.0", "x-build-id": "2RO55Sd97GF3dMIbR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~france-company-carbon-reports/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-france-company-carbon-reports", "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/datacraft-studio~france-company-carbon-reports/runs": { "post": { "operationId": "runs-sync-datacraft-studio-france-company-carbon-reports", "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/datacraft-studio~france-company-carbon-reports/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-france-company-carbon-reports", "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": { "sirens": { "title": "SIREN or SIRET numbers", "type": "array", "description": "Companies or public bodies to look up (9-digit SIREN or 14-digit SIRET). Leave empty to search with the filters below.", "items": { "type": "string" } }, "nameQuery": { "title": "Organisation name contains", "type": "string", "description": "Full-text search on the organisation name, e.g. renault or hopital." }, "structureTypes": { "title": "Organisation types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "company", "public_body", "local_authority", "state", "association" ], "enumTitles": [ "Company", "Public body", "Local authority", "State service", "Association" ] } }, "nafCodes": { "title": "Sector (NAF/APE code prefixes)", "type": "array", "description": "e.g. 62 (IT), 4791A, 10 (food industry). Matches codes starting with the value.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes, e.g. 75, 69, 2A, 974.", "items": { "type": "string" } }, "minReportingYear": { "title": "Minimum reporting year", "minimum": 2000, "maximum": 2100, "type": "integer", "description": "Only reports about this year or later." }, "publishedSince": { "title": "Published since (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only reports published on the ADEME platform on or after this date." }, "csrdOnly": { "title": "Only organisations subject to CSRD", "type": "boolean", "description": "Keep reports where the organisation declared it is subject to the CSRD.", "default": false }, "minTotalEmissionsTco2e": { "title": "Minimum total emissions (tCO2e)", "minimum": 0, "type": "integer", "description": "Skip reports below this total (scope 1 + 2 + 3)." }, "latestOnly": { "title": "Latest report per organisation only", "type": "boolean", "description": "Turn off to get the full history (one row per report).", "default": true }, "includeTexts": { "title": "Include long texts", "type": "boolean", "description": "Adds the organisation presentation, sustainability policy and reduction actions (long texts).", "default": false }, "onlyNew": { "title": "Alert mode: only reports not delivered before", "type": "boolean", "description": "Remembers delivered reports (per state store). Schedule it weekly to get only newly published reports.", "default": false }, "stateStoreName": { "title": "Alert state store name", "type": "string", "description": "Use different names for different alert setups.", "default": "france-company-carbon-reports-state" }, "maxItems": { "title": "Max reports", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of reports delivered (and charged).", "default": 200 } } }, "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 } } } } } } } } } }