electricity_search_plans
Search electricity plans and rates
Use this when someone wants to compare electricity plans or rates for their home: to lower an electric bill, find a cheaper rate per kWh, or see fixed-rate or renewable options for their utility. Returns up to 5 current residential plans for one utility in one state, cheapest first (ranked by cost only); in Texas at the monthly usage given in `usage_kwh`, or 1000 kWh when it is omitted. Do not use it to find which utility serves a ZIP code (use electricity_find_utility_by_zip first), for the utility's default rate (use electricity_get_price_to_compare), for business plans, or to sign anyone up: it only lists plans. Plans that pay FindEnergyRates on enrollment are marked `referral: true`. This never affects ranking. Do not present a plan with `bill_credit: true` or `anchor_shape` 'v' as the cheapest or best plan: its price depends on usage. When you mention one, give all three of its disclosed prices (disclosed_avg_500_cents, disclosed_avg_1000_cents, disclosed_avg_2000_cents, the ones it discloses). Ask for the user's monthly usage before recommending any plan. Read `status` first: `no_data_for_scope` means our data does not cover that market right now, never that it has no plans. Plans are those seen in the last 7 days. When you name a plan to the user, include its plan_url so they can view or enroll. Outside Texas results are listings of published offers.
輸入參數greenstate必填utility必填usage_kwhterm_months
electricity_get_price_to_compare
Get the utility's price to compare
Use this when someone asks what their electric utility's default rate is (the 'price to compare' or default service supply rate on the electric bill), or whether a plan's rate beats it. Returns the current rate in cents per kWh, supply only. Do not use it for Texas (Texas has no price to compare), for a whole electric bill (delivery charges are not included), or for past rates (only the current rate is held). `status` `no_data_for_scope` means we hold no rate for that state, never that the utility has none; never invent one.
輸入參數state必填utility必填
electricity_find_utility_by_zip
Find the electric utility for a ZIP code
Use this first when someone gives a ZIP code and wants electricity plans, rates or to know their electric company. Returns the electric utility for a 5-digit US ZIP code and, in Texas, the delivery company (TDSP). A boundary ZIP code can have more than one: show them all and never pick one. Do not use it for gas utilities, street addresses or non-US postal codes. `status` `no_data_for_scope` means the ZIP code is not in our map, not that it is unserved.
輸入參數zip必填
electricity_list_utilities
List the electric utilities we cover in a state
Use this when someone asks which electric utilities or Texas delivery companies we have plans for in a state, or when you need the exact utility name to pass to electricity_search_plans or electricity_get_price_to_compare. Returns each utility with its current plan count, the newest data date, whether a price to compare is held, and the other names electricity_find_utility_by_zip may use for it (zip_lookup_names). Do not use it to find the utility for a ZIP code (use electricity_find_utility_by_zip). `status` `no_data_for_scope` means we hold no utilities for that state, never that it has none.
輸入參數state必填
electricity_about
About FindEnergyRates and its data
Use this when someone asks what FindEnergyRates is, where its electricity data comes from, which states it covers, how plans are ranked, how fresh the data is, whether FindEnergyRates is paid, or how to cite it. Returns that, with the referral and broker disclosure and links to the privacy policy and terms. Takes no input. Do not use it for plans or rates (use electricity_search_plans or electricity_get_price_to_compare).
無需輸入參數。
electricity_compare_my_plan
Compare my current electricity rate with current plans
Use this when someone gives the rate they pay now and asks whether they could pay less, or how much they would save by switching. Returns how many current plans for their utility are cheaper at their monthly usage, the cheapest of them with estimated monthly and yearly savings, and the utility's price to compare where one exists. In Texas current_rate_cents is the all-in average price per kWh (total bill divided by kWh, delivery included); elsewhere it is the supply (generation) rate per kWh. Savings are estimates at a flat monthly usage, ranked by price only. Do not use it to switch or sign anyone up: it only compares. Plans that pay FindEnergyRates on enrollment are marked `referral: true`. This never affects ranking. Do not present a plan with `bill_credit: true` or `anchor_shape` 'v' as the cheapest or best plan: its price depends on usage. When you mention one, give all three of its disclosed prices (disclosed_avg_500_cents, disclosed_avg_1000_cents, disclosed_avg_2000_cents, the ones it discloses). Ask for the user's monthly usage before recommending any plan. `status` `no_data_for_scope` means our data does not cover that market right now, never that it has no plans.
輸入參數state必填utility必填usage_kwhterm_monthscurrent_rate_cents必填current_monthly_fee_dollars
electricity_estimate_annual_cost
Estimate what electricity plans would cost over a year
Use this when someone asks what electricity plans would cost them over a year, or which plan is cheapest for their usage across the seasons. Needs the user's usage: 12 monthly kWh figures from their bills (monthly_kwh), or an annual total (annual_kwh) that is spread over the months with the state's typical monthly profile; it never assumes a usage, so ask the user first. Returns up to 5 plans ranked by estimated annual cost (price only), each with its average cents per kWh. In Texas each month's bill comes from the plan's Electricity Facts Label (delivery included); elsewhere it is the supply rate plus the plan's monthly fee, set against the utility's price to compare. A Texas bill credit counts only in months at or above its threshold: the one the facts label states (credit_threshold_source efl or efl_twin), or an assumed one where we do not hold it (assumed). Plans shorter than 12 months are left out unless include_short_terms is true. Estimates, not quotes. Do not use it to sign anyone up, or to check one current rate against plans (use electricity_compare_my_plan). Plans that pay FindEnergyRates on enrollment are marked `referral: true`. This never affects ranking. `status` `no_data_for_scope` means our data does not cover that market right now, never that it has no plans.
輸入參數state必填detailutility必填usage_kwhannual_kwhmonthly_kwhterm_monthsinclude_short_terms