{ "openapi": "3.0.1", "info": { "title": "Emission Factors API: DEFRA, EPA & Grid CO2e Calculator", "description": "Emission factor lookup and CO2e calculator on public open data: UK DESNZ (DEFRA), US EPA, EEA and Ember grid factors. Scope, GHG category, formula and source per activity. Not affiliated with DEFRA or EPA.", "version": "0.1", "x-build-id": "qVje4Xiv9Z9dZXU3v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reliable_tools~emission-factors-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reliable_tools-emission-factors-api", "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/reliable_tools~emission-factors-api/runs": { "post": { "operationId": "runs-sync-reliable_tools-emission-factors-api", "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/reliable_tools~emission-factors-api/run-sync": { "post": { "operationId": "run-sync-reliable_tools-emission-factors-api", "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": { "activities": { "title": "Activities", "type": "array", "description": "One entry per activity. Plain text such as \"500 km diesel van\", \"1200 kWh electricity Germany 2025\", \"3 t steel\", \"flight LHR-JFK economy return\" or \"$25,000 office furniture\". Or an object with \"activity\" (or \"category\"), \"quantity\", \"unit\", \"country\", \"year\", \"scope\", \"reference\"; for flights \"from\" and \"to\" (IATA codes) and \"passengers\". Without a quantity you get the factor only." }, "csvUrl": { "title": "CSV file URL", "type": "string", "description": "Optional: a link to a CSV file with a header row. Recognised columns: activity (or description), category, quantity, unit, country, year, scope, reference, from, to, passengers." }, "defaultCountry": { "title": "Default country", "type": "string", "description": "Used when an activity names no country, for example UK, US or Germany. Grid electricity and hotel stays need a country." }, "defaultYear": { "title": "Default reporting year", "minimum": 1990, "maximum": 2100, "type": "integer", "description": "Used when an activity names no year. Without it the latest published factor set is used." }, "preferredSource": { "title": "Preferred factor set", "enum": [ "auto", "desnz", "epa" ], "type": "string", "description": "Which official set to search first for fuels, vehicles, freight, waste and travel. The other set is searched when the first has no good match.", "default": "auto" }, "aviationRadiativeForcing": { "title": "Flights: include radiative forcing", "type": "boolean", "description": "Uses the DESNZ air factors that include the indirect effects of non-CO2 emissions, as DESNZ recommends. Turn off for direct emissions only.", "default": true }, "includeUpstream": { "title": "Add upstream emissions to the total", "type": "boolean", "description": "Adds the well-to-tank and grid loss factors of the same item (Scope 3 Category 3) to kgCO2e. They are always listed under upstreamFactors.", "default": false }, "maxAlternatives": { "title": "Alternatives per activity", "minimum": 0, "maximum": 10, "type": "integer", "description": "Other factor rows that were considered, with their value and kgCO2e.", "default": 3 }, "aiMatching": { "title": "AI match score", "type": "boolean", "description": "Picks the best official factor row for your text and rates the fit from 0 to 1. Off: text similarity only, no match score.", "default": true }, "maxActivities": { "title": "Max activities per run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stops after this many activities.", "default": 5000 } } }, "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 } } } } } } } } } }