{ "openapi": "3.0.1", "info": { "title": "Texas Electricity Plans Scraper", "description": "Get every retail electricity plan for any Texas ZIP code from Power to Choose — plus what no one else offers: each plan's Electricity Facts Label PDF parsed into structured rates (energy charge, base charge, TDU fees, bill credits, ETF) and true monthly cost at your usage level.", "version": "0.0", "x-build-id": "ReGyh5yC3o7Am0YSJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/silentshadow55~electricity-plans-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-silentshadow55-electricity-plans-actor", "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/silentshadow55~electricity-plans-actor/runs": { "post": { "operationId": "runs-sync-silentshadow55-electricity-plans-actor", "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/silentshadow55~electricity-plans-actor/run-sync": { "post": { "operationId": "run-sync-silentshadow55-electricity-plans-actor", "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", "required": [ "zipCodes" ], "properties": { "zipCodes": { "title": "Texas ZIP codes", "type": "array", "description": "One or more Texas ZIP codes in the deregulated ERCOT market (e.g. Dallas 75201, Houston 77002, Laredo 78045). ZIPs served by municipal utilities or co-ops (Austin, San Antonio) return no plans.", "items": { "type": "string" } }, "parseEfl": { "title": "Parse EFL PDFs", "type": "boolean", "description": "Download and parse each plan's Electricity Facts Label PDF into structured rate components (energy charge, base charge, TDU charges, bill credits, termination fee). Turn off for a faster, cheaper run with only the Power to Choose listing data.", "default": true }, "monthlyUsageKwh": { "title": "Your monthly usage (kWh)", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Monthly consumption used to compute the true cost of every plan (cost_at_usage). Texas residential average is about 1,200 kWh.", "default": 1000 }, "rateTypes": { "title": "Rate types", "type": "array", "description": "Only include these rate types. Leave empty for all.", "items": { "type": "string", "enum": [ "Fixed", "Variable", "Indexed" ] } }, "minTermMonths": { "title": "Minimum term (months)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Only include plans with a contract term of at least this many months. 0 = no minimum.", "default": 0 }, "maxTermMonths": { "title": "Maximum term (months)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Only include plans with a contract term of at most this many months. 0 = no maximum.", "default": 0 }, "includePrepaid": { "title": "Include prepaid plans", "type": "boolean", "description": "Include prepaid / pay-as-you-go plans in the results.", "default": true }, "includeTimeOfUse": { "title": "Include time-of-use plans (free nights/weekends)", "type": "boolean", "description": "Include time-of-use plans such as free-nights or free-weekends offers. Their cost estimates always use the official average-price points, since true cost depends on when you use power.", "default": true }, "minRenewablePct": { "title": "Minimum renewable content (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only include plans with at least this renewable percentage.", "default": 0 }, "providers": { "title": "Provider filter", "type": "array", "description": "Only include plans whose retail provider name contains one of these strings (case-insensitive), e.g. \"TXU\", \"Reliant\". Leave empty for all providers.", "items": { "type": "string" } }, "tdus": { "title": "TDU (utility territory) filter", "type": "array", "description": "Only include plans delivered by these TDUs. A ZIP almost always maps to a single TDU, so this mainly matters for split ZIPs and multi-ZIP runs where you want one utility territory only (e.g. Oncor). Leave empty for all TDUs.", "items": { "type": "string", "enum": [ "Oncor", "CenterPoint", "AEP Texas Central", "AEP Texas North", "Texas-New Mexico", "Lubbock" ], "enumTitles": [ "Oncor Electric Delivery (Dallas-Fort Worth, West TX)", "CenterPoint Energy (Houston metro)", "AEP Texas Central (Corpus Christi, Laredo, Rio Grande Valley)", "AEP Texas North (Abilene, San Angelo)", "TNMP — Texas-New Mexico Power (Gulf Coast, West TX pockets)", "Lubbock Power & Light" ] } }, "maxPlansPerZip": { "title": "Max plans per ZIP", "minimum": 0, "type": "integer", "description": "Cap the number of plans processed per ZIP code. 0 = no cap.", "default": 0 }, "includeRawEflText": { "title": "Include raw EFL text", "type": "boolean", "description": "Attach the full extracted EFL text to each item (large). Useful for auditing or feeding to an LLM.", "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 } } }, "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 } } } } } } } } } }