ISO New England Hbregulationoffer API

openapi: 3.2.0
info:
  title: ISO New England Web Services API v1.1 Hbregulationoffer API
  version: '1.1'
  description: RESTful interface to ISO New England energy and market data.
  contact:
    name: ISO New England Ask ISO
    url: https://askiso.iso-ne.com/s/
  x-provenance:
    method: derived
    derived_by: API Evangelist enrichment pipeline
    derived_on: '2026-07-27'
    sources:
    - https://webservices.iso-ne.com/docs/v1.1/
    - https://webservices.iso-ne.com/docs/v1.1/ns0.xsd
    - https://webservices.iso-ne.com/docs/v1.1/ns1.xsd
    - https://www.iso-ne.com/participate/support/web-services-data
    not_provider_published: true
    note: Derived from provider-published HTML documentation and XSDs. Not an ISO New England artifact.
servers:
- url: https://webservices.iso-ne.com/api/v1.1
  description: Production base path (HTTP Basic over SSL)
security:
- basicAuth: []
tags:
- name: hbregulationoffer
  description: 4 path template(s) under /hbregulationoffer in the published ISO New England Web Services API v1.1 documentation.
paths:
  /hbregulationoffer:
    get:
      operationId: getHbregulationoffer
      summary: Default resource
      description: Default resource. Redirects to HbRegulationOffer Info.
      tags:
      - hbregulationoffer
      responses:
        '200':
          description: Successful response.
          content:
            application/xml:
              schema:
                description: Response payload is not described in the published documentation.
            application/json:
              schema:
                description: Response payload is not described in the published documentation.
        '401':
          description: Unauthorized - HTTP Basic credentials from an ISO Express account are required. Verified by anonymous probe on 2026-07-27.
      x-evidence:
        source: https://webservices.iso-ne.com/docs/v1.1/rest.hbregulationoffer.html
        harvested: '2026-07-27'
  /hbregulationoffer/current:
    get:
      operationId: getHbregulationofferCurrent
      summary: GET /hbregulationoffer/current
      description: (no documentation provided)
      tags:
      - hbregulationoffer
      responses:
        '200':
          description: Successful response.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/HbRegulationOffers'
            application/json:
              schema:
                $ref: '#/components/schemas/HbRegulationOffers'
        '401':
          description: Unauthorized - HTTP Basic credentials from an ISO Express account are required. Verified by anonymous probe on 2026-07-27.
      x-evidence:
        source: https://webservices.iso-ne.com/docs/v1.1/rest.hbregulationoffer.current.html
        harvested: '2026-07-27'
      x-xml-element: HbRegulationOffers
  /hbregulationoffer/day/{day}:
    get:
      operationId: getHbregulationofferDayByDay
      summary: Get an entire days HbDayAheadRegulationOffers
      description: Get an entire days HbDayAheadRegulationOffers.
      tags:
      - hbregulationoffer
      responses:
        '200':
          description: a HbRegulationOfferElement containing the HbRegulationOffers.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/HbRegulationOffers'
            application/json:
              schema:
                $ref: '#/components/schemas/HbRegulationOffers'
        '401':
          description: Unauthorized - HTTP Basic credentials from an ISO Express account are required. Verified by anonymous probe on 2026-07-27.
      x-evidence:
        source: https://webservices.iso-ne.com/docs/v1.1/rest.hbregulationoffer.day.day.html
        harvested: '2026-07-27'
      x-xml-element: HbRegulationOffers
      parameters:
      - name: day
        in: path
        required: true
        schema:
          type: string
        description: The day to retrieve data for (YYYYMMDD)
  /hbregulationoffer/info:
    get:
      operationId: getHbregulationofferInfo
      summary: Get the Service Info for HbRegulationOffers
      description: Get the Service Info for HbRegulationOffers.
      tags:
      - hbregulationoffer
      responses:
        '200':
          description: the ServiceInfoElement for HbRegulationOffers.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ServiceInfo'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceInfo'
        '401':
          description: Unauthorized - HTTP Basic credentials from an ISO Express account are required. Verified by anonymous probe on 2026-07-27.
      x-evidence:
        source: https://webservices.iso-ne.com/docs/v1.1/rest.hbregulationoffer.info.html
        harvested: '2026-07-27'
      x-xml-element: ServiceInfo
components:
  schemas:
    HbRegulationOffers:
      type: object
      properties:
        HbRegulationOffer:
          type: array
          items:
            $ref: '#/components/schemas/HbRegulationOffer'
      x-xsd-source: schemas/iso-new-england-web-services-ns0.xsd#type_HbRegulationOffers
    HbRegulationOffer:
      type: object
      properties:
        BeginDate:
          type: string
          format: date-time
        MaskedParticipantId:
          type: integer
        MaskedAssetId:
          type: integer
        RegulationCapability:
          type: number
        RegulationOfferPrice:
          type: number
        SelfScheduledRegulation:
          type: number
        RegulationLowLimit:
          type: number
        RegulationHighLimit:
          type: number
        RegulationStatus:
          type: string
          enum:
          - AVAILABLE
          - UNAVAILABLE
        AutomaticResponseRate:
          type: number
        RegulationServiceOfferPrice:
          type: number
        RegulationCapacityOfferPrice:
          type: number
        IntertemporalOpportunityCost:
          type: number
      x-xsd-source: schemas/iso-new-england-web-services-ns0.xsd#type_HbRegulationOffer
    ServiceInfo:
      type: object
      properties:
        LatestBeginDate:
          type: string
          format: date-time
        CreationDate:
          type: string
          format: date-time
      required:
      - LatestBeginDate
      - CreationDate
      x-xsd-source: schemas/iso-new-england-web-services-ns0.xsd#type_ServiceInfo
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication over SSL. Credentials come from a free, self-serve ISO Express account; ISO New England states that ISO Express account holders are automatically granted access to the public data feeds. See https://www.iso-ne.com/participate/applications-status-changes/access-software-systems