{ "openapi": "3.0.1", "info": { "title": "Australian Energy Plans - Electricity, Gas & Solar FiT", "description": "Every electricity and gas plan from 42 Australian retailers, ~19,000 plans, by postcode: supply charge, time-of-use rates, solar feed-in tariff, controlled load, discounts, plus an estimated annual bill for your usage and a daily plan-change feed. Consumer Data Right data, refreshed nightly.", "version": "0.0", "x-build-id": "oPNg8advbi8dImaev" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlplant~au-energy-plans/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlplant-au-energy-plans", "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/crawlplant~au-energy-plans/runs": { "post": { "operationId": "runs-sync-crawlplant-au-energy-plans", "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/crawlplant~au-energy-plans/run-sync": { "post": { "operationId": "run-sync-crawlplant-au-energy-plans", "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": [ "cheapest", "plans", "changes", "brands" ], "type": "string", "description": "cheapest = plans available at your postcodes, ranked by the estimated annual bill; plans = every matching plan; changes = price changes since a date or your last run; brands = the retailers we cover.", "default": "cheapest" }, "postcodes": { "title": "Postcodes", "type": "array", "description": "Australian postcodes (4 digits, e.g. 2000, 3000, 0800). A plan is returned once with every requested postcode it serves.", "default": [ "2000" ], "items": { "type": "string" } }, "fuelTypes": { "title": "Fuel", "type": "array", "description": "Electricity, gas, or dual-fuel plans (exact match).", "items": { "type": "string", "enum": [ "ELECTRICITY", "GAS", "DUAL" ], "enumTitles": [ "Electricity", "Gas", "Dual fuel" ] }, "default": [ "ELECTRICITY" ] }, "customerType": { "title": "Customer type", "enum": [ "RESIDENTIAL", "BUSINESS" ], "type": "string", "description": "Residential (home) or small-business plans.", "default": "RESIDENTIAL" }, "planTypes": { "title": "Plan types", "type": "array", "description": "Market offers, standing offers (default offer) or regulated plans. Empty = all.", "items": { "type": "string", "enum": [ "MARKET", "STANDING", "REGULATED" ], "enumTitles": [ "Market offers", "Standing offers", "Regulated" ] }, "default": [] }, "brands": { "title": "Retailers", "type": "array", "description": "Only these retailers: a word of the name (\"agl\", \"origin\", \"red\") or a retailer id from mode \"brands\".", "default": [], "items": { "type": "string" } }, "features": { "title": "Must have", "type": "array", "description": "Keep only plans with all of these. \"No demand charges\" is on by default because the bill estimate cannot price demand charges; remove it to see those plans too.", "items": { "type": "string", "enum": [ "solar", "controlledLoad", "timeOfUse", "singleRate", "greenPower", "noDemandCharges" ], "enumTitles": [ "Solar feed-in tariff", "Controlled load (off-peak hot water)", "Time-of-use prices", "Single (flat) rate", "GreenPower option", "No demand charges" ] }, "default": [ "noDemandCharges" ] }, "annualKwh": { "title": "Electricity use per year (kWh)", "minimum": 0, "type": "number", "description": "About 4,000 kWh for a typical 2-3 person home; your bill shows your own.", "default": 4000 }, "peakShare": { "title": "Peak share", "minimum": 0, "maximum": 1, "type": "number", "description": "Share of your electricity used in peak hours (time-of-use plans). Peak + shoulder + off-peak should be 1.", "default": 0.35 }, "shoulderShare": { "title": "Shoulder share", "minimum": 0, "maximum": 1, "type": "number", "description": "Share of your electricity used in shoulder hours (time-of-use plans).", "default": 0.25 }, "offPeakShare": { "title": "Off-peak share", "minimum": 0, "maximum": 1, "type": "number", "description": "Share of your electricity used off-peak (time-of-use plans).", "default": 0.4 }, "solarExportKwh": { "title": "Solar export per year (kWh)", "minimum": 0, "type": "number", "description": "Electricity your panels send to the grid; credited at the plan's best feed-in tariff.", "default": 0 }, "gasAnnualMj": { "title": "Gas use per year (MJ)", "minimum": 0, "type": "number", "description": "For gas plans. Around 25,000 MJ for a home with gas heating and hot water; 0 = no gas estimate.", "default": 25000 }, "sortBy": { "title": "Sort by", "enum": [ "estimate_asc", "supply_asc", "usage_rate_asc", "fit_desc", "brand" ], "type": "string", "description": "How to order the plans. cheapest mode ranks by the estimated annual bill by default.", "default": "estimate_asc" }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many rows.", "default": 100 }, "changedSince": { "title": "Changed since", "type": "string", "description": "Mode \"changes\": a date (2026-09-01) or \"last-run\". Empty = last 7 days." }, "maxAgeHours": { "title": "Max data age (hours)", "minimum": 0, "type": "integer", "description": "We refresh every plan daily. Older data is still served, with a warning in the run summary.", "default": 36 }, "includeRaw": { "title": "Include raw CDR payload", "type": "boolean", "description": "Add the plan's original CDR JSON (large).", "default": false } } }, "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 } } } } } } } } } }