{"openapi":"3.1.0","info":{"title":"WattBuy (BYOK) API","version":"0.1.0","description":"WattBuy (BYOK) lets an AI assistant read your own WattBuy data through the WattBuy API with a key you supply (WattBuy API key). Read-only: 6 tools (lookup_utility, list_retail_rates, list_surplus_generation_rates, estimate_usage, estimate_solar, estimate_carbon_footprint). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-wattbuy.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-wattbuy/docs"},"termsOfService":"https://connectorbay.com/byok-wattbuy/terms"},"servers":[{"url":"https://byok-wattbuy.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-wattbuy/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/lookup_utility":{"post":{"operationId":"lookup_utility","summary":"Find the electric utility serving a US ZIP code: name, contact details, outage information, deregulation status and ids.","description":"Find the electric utility serving a US ZIP code: name, contact details, outage information, deregulation status and ids. Use for \"Which electric utility serves ZIP code 75001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zip":{"description":"US 5-digit ZIP code, for example 75001.","maxLength":10,"title":"Zip","type":"string"}},"required":["zip"],"title":"lookup_utilityArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_retail_rates":{"post":{"operationId":"list_retail_rates","summary":"List the tariffs and rates to buy electricity from a US utility in a state: rate name, structure, customer charge, minim","description":"List the tariffs and rates to buy electricity from a US utility in a state: rate name, structure, customer charge, minimum bill and time-of-use prices. Paged. Use for \"What residential electricity rates does utility 44372 charge in Texas\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"utility_id":{"description":"Numeric utility id (EIA utility id for US utilities), as returned by lookup_utility in utility_info.utility_id.","minimum":1,"title":"Utility Id","type":"integer"},"state":{"description":"Two-letter US state code (or Canadian province code), for example 'tx'.","maxLength":2,"title":"State","type":"string"},"baseline_zone":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Baseline allocation zone, mostly for California customers (found on the bill).","title":"Baseline Zone"},"verified_from":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only rates verified since this Unix time in seconds; default is two years ago.","title":"Verified From"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["utility_id","state"],"title":"list_retail_ratesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_surplus_generation_rates":{"post":{"operationId":"list_surplus_generation_rates","summary":"List the rate a US utility pays for surplus (net metering) generation, with netting period and granularity. Use for \"Wha","description":"List the rate a US utility pays for surplus (net metering) generation, with netting period and granularity. Use for \"What does utility 44372 pay for excess solar generation in Texas\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"state":{"description":"Two-letter US state code (or Canadian province code), for example 'tx'.","maxLength":2,"title":"State","type":"string"},"utility_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Numeric utility id (EIA id); leave out for every utility in the state.","title":"Utility Id"}},"required":["state"],"title":"list_surplus_generation_ratesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/estimate_usage":{"post":{"operationId":"estimate_usage","summary":"Estimate a home's yearly electricity use and bill for a US ZIP code, optionally refined by size, age, house type and hea","description":"Estimate a home's yearly electricity use and bill for a US ZIP code, optionally refined by size, age, house type and heating fuel. Modelled value. Use for \"How much electricity does a 3-bedroom house in ZIP 75001 use in a year\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zip":{"description":"US 5-digit ZIP code, for example 75001.","maxLength":10,"title":"Zip","type":"string"},"year_built":{"anyOf":[{"maximum":2100,"minimum":1800,"type":"integer"},{"type":"null"}],"default":null,"description":"Year the home was built, four digits.","title":"Year Built"},"bedrooms":{"anyOf":[{"maximum":30,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of bedrooms.","title":"Bedrooms"},"bathrooms":{"anyOf":[{"maximum":30,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of bathrooms.","title":"Bathrooms"},"sq_ft":{"anyOf":[{"maximum":100000,"minimum":100,"type":"integer"},{"type":"null"}],"default":null,"description":"Floor area in square feet.","title":"Sq Ft"},"stories":{"anyOf":[{"maximum":10,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of stories.","title":"Stories"},"house_type":{"anyOf":[{"enum":["house","apartment"],"type":"string"},{"type":"null"}],"default":null,"description":"house or apartment.","title":"House Type"},"heating_fuel_source":{"anyOf":[{"enum":["Electricity","Fuel Oil","Natural Gas","None","Other Fuel","Propane"],"type":"string"},{"type":"null"}],"default":null,"description":"Main heating fuel.","title":"Heating Fuel Source"}},"required":["zip"],"title":"estimate_usageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/estimate_solar":{"post":{"operationId":"estimate_solar","summary":"Estimate a recommended solar system size, monthly production and savings, cost, payback and incentives for a US ZIP code","description":"Estimate a recommended solar system size, monthly production and savings, cost, payback and incentives for a US ZIP code. Modelled value. Use for \"How big a solar system and what payback would a home in ZIP 75001 get\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zip":{"description":"US 5-digit ZIP code, for example 75001.","maxLength":10,"title":"Zip","type":"string"}},"required":["zip"],"title":"estimate_solarArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/estimate_carbon_footprint":{"post":{"operationId":"estimate_carbon_footprint","summary":"Estimate the annual electricity carbon footprint of a home for a US ZIP code, with baseline usage and the generation mix","description":"Estimate the annual electricity carbon footprint of a home for a US ZIP code, with baseline usage and the generation mix behind it. Modelled value. Use for \"What is the yearly carbon footprint of electricity use in ZIP 75001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zip":{"description":"US 5-digit ZIP code, for example 75001.","maxLength":10,"title":"Zip","type":"string"}},"required":["zip"],"title":"estimate_carbon_footprintArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}