Bayou Energy

Bayou Energy provides a utility-bill and usage-data API that lets companies collect their customers' utility account, bill, and interval meter data from US utilities. Customers link their utility credentials through a hosted onboarding flow, and Bayou continuously fetches the full bill and interval history, exposing it through a REST API secured with HTTP Basic authentication.

5 APIs 0 Features

Utility DataEnergyUtility BillsInterval DataMetering

APIs

Bayou Energy Customers API

Create and manage customers, generate a hosted onboarding link for the customer to connect their utility credentials, and poll customer status fields such as has_filled_credenti...

Bayou Energy Bills API

Retrieve a customer's utility bills with account numbers, meters, tariffs, billing periods, consumption, and itemized delivery and supply charges; upload, update, and unlock bil...

Bayou Energy Intervals API

Retrieve a customer's interval meter data organized by meter, returned at 15-minute, hourly, or daily granularity depending on the utility, covering the customer's available usa...

Bayou Energy Meters API

Surface meter details across a customer's bills and intervals, and look up supported utilities and their coverage, availability, and performance through the utilities endpoints.

Bayou Energy Webhooks API

Subscribe to event notifications - customer_has_filled_credentials, customer_must_reauthenticate, new_bill, updated_bill, new_unparsed_bill, bills_ready, and intervals_ready - s...

Collections

Bayou Energy API

OPEN

Pricing Plans

Bayou Energy Plans Pricing

2 plans

PLANS

Rate Limits

Bayou Energy Rate Limits

1 limits

RATE LIMITS

FinOps

Bayou Energy Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: Bayou Energy API
  version: '2.0'
request:
  auth:
    type: basic
    username: '{{apiKey}}'
    password: ''
items:
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: List customers
      type: http
    http:
      method: GET
      url: https://bayou.energy/api/v2/customers
    docs: Retrieve the list of customers created on your account.
  - info:
      name: Create a customer
      type: http
    http:
      method: POST
      url: https://bayou.energy/api/v2/customers
      body:
        type: json
        data: "{\n  \"utility\": \"speculoos_power\",\n  \"email\": \"customer@example.com\"\n}"
    docs: Create a customer for a given utility; the response includes an onboarding link.
  - info:
      name: Retrieve a customer
      type: http
    http:
      method: GET
      url: https://bayou.energy/api/v2/customers/{id}
    docs: Retrieve a customer, including has_filled_credentials, bills_are_ready, and intervals_are_ready.
  - info:
      name: Update a customer
      type: http
    http:
      method: PATCH
      url: https://bayou.energy/api/v2/customers/{id}
      body:
        type: json
        data: "{\n  \"email\": \"customer@example.com\"\n}"
    docs: Update a customer's attributes.
- info:
    name: Bills
    type: folder
  items:
  - info:
      name: Retrieve a customer's bills
      type: http
    http:
      method: GET
      url: https://bayou.energy/api/v2/customers/{id}/bills
    docs: Retrieve all bills discovered for a customer.
  - info:
      name: Upload a bill
      type: http
    http:
      method: POST
      url: https://bayou.energy/api/v2/bills
      body:
        type: json
        data: '{}'
    docs: Upload a new bill for processing.
  - info:
      name: Retrieve a bill
      type: http
    http:
      method: GET
      url: https://bayou.energy/api/v2/bills/{id}
    docs: Retrieve a specific bill by its identifier.
  - info:
      name: Update a bill
      type: http
    http:
      method: PATCH
      url: https://bayou.energy/api/v2/bills/{id}
      body:
        type: json
        data: '{}'
    docs: Update a specific bill by its identifier.
  - info:
      name: Unlock a bill
      type: http
    http:
      method: POST
      url: https://bayou.energy/api/v2/bills/{id}/unlock
    docs: Unlock a bill's data, entirely or partially.
- info:
    name: Intervals
    type: folder
  items:
  - info:
      name: Retrieve a customer's interval data
      type: http
    http:
      method: GET
      url: https://bayou.energy/api/v2/customers/{id}/intervals
    docs: Retrieve interval meter data for a customer, organized by meter.
- info:
    name: Utilities
    type: folder
  items:
  - info:
      name: List supported utilities
      type: http
    http:
      method: GET
      url: https://bayou.energy/api/v2/utilities
    docs: Retrieve all supported utilities, including coverage, availability, and performance.
  - info:
      name: Retrieve a utility
      type: http
    http:
      method: GET
      url: https://bayou.energy/api/v2/utilities/{id}
    docs: Retrieve details for a specific supported utility.