{ "openapi": "3.0.1", "info": { "title": "Winter Heating Fuel Budget Planner by State and ZIP", "description": "Month-by-month winter heating cost for propane, heating oil, natural gas, or electricity from your state's latest public prices and local degree days.", "version": "0.1", "x-build-id": "QgNkUUyCaCRbp7nae" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/standardwork~winter-heating-budget-planner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-standardwork-winter-heating-budget-planner", "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/standardwork~winter-heating-budget-planner/runs": { "post": { "operationId": "runs-sync-standardwork-winter-heating-budget-planner", "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/standardwork~winter-heating-budget-planner/run-sync": { "post": { "operationId": "run-sync-standardwork-winter-heating-budget-planner", "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": { "state": { "title": "State", "type": "string", "description": "Two-letter U.S. state code, for example OH. Fuel prices come from this state (or its region when the state has no published price).", "default": "OH" }, "zip": { "title": "ZIP code (optional)", "type": "string", "description": "Optional 5-digit ZIP. When set, weather (heating degree days) comes from the grid point at the ZIP's center instead of the statewide average. Prices still come from the state above." }, "fuelType": { "title": "Fuel type", "enum": [ "propane", "heating_oil", "natural_gas", "electricity", "kerosene", "wood_pellets", "cord_wood" ], "type": "string", "description": "Your main heating fuel. Kerosene, wood pellets, and cord wood have no free public state price, so enter your own price for those.", "default": "propane" }, "homeSqft": { "title": "Heated floor area (sq ft)", "minimum": 200, "maximum": 20000, "type": "integer", "description": "Heated square feet. Used when past usage is not given. 200 to 20000.", "default": 1800 }, "insulation": { "title": "Insulation and air sealing", "enum": [ "poor", "average", "good" ], "type": "string", "description": "Rough home tightness. Poor (older, drafty), average, or good (newer or upgraded). Used only with floor area.", "default": "average" }, "annualUsage": { "title": "Past winter usage (optional)", "type": "number", "description": "If you know how much fuel you used last winter (gallons, Mcf, kWh, tons, or cords to match the fuel), enter it. This replaces the floor area estimate and is spread across months by degree days." }, "efficiencyPercent": { "title": "Heating system efficiency % (optional)", "type": "number", "description": "Leave blank for typical values (propane and gas 90, oil and kerosene 83, pellets 80, cord wood 65, electric resistance 100). Use about 250 for an electric heat pump." }, "pricePerUnit": { "title": "Your price per unit (optional)", "type": "number", "description": "Your own price in dollars per gallon, Mcf, kWh, ton, or cord. Overrides the public price. Required for kerosene, wood pellets, and cord wood." }, "winters": { "title": "Winters of weather history", "minimum": 3, "maximum": 30, "type": "integer", "description": "How many recent complete winters to average for heating degree days. 3 to 30.", "default": 10 } } }, "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 } } } } } } } } } }