> ## Documentation Index
> Fetch the complete documentation index at: https://docs.energy.nlead.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# A month's forecast, schedule, allocation and reBAP

> The day's series of every day of the month the dashboard covers
(``from`` to ``to``), one quarter-hour after the other, with each day's
totals in ``days``. The first call for a month reads every day and can
take up to a minute; the days are then shared for 5 minutes.


## OpenAPI

````yaml /api-reference/openapi.json get /v1/dashboard/months/{month}
openapi: 3.1.0
info:
  title: n:lead Scheduling Bridge — Data Delivery API
  version: 0.4.0
  description: >-
    API for delivering portfolio data to the n:lead scheduling bridge. Send a
    portfolio forecast per delivery day, or — if no forecast is available — the
    market-location master data, metered data and rolled-out profiles the bridge
    needs to build the consumption forecast for you. Everything downstream
    (positions, trader handoff, schedule submission to the TSOs) is operated by
    n:lead. A read-only status endpoint reports the BRP activation state per
    DSO/MGA, and the dashboard endpoints a day's or a month's forecast,
    schedule, allocation and reBAP for the customer's own screens.
servers:
  - url: https://{host}
    description: Deployed service
    variables:
      host:
        default: api.energy.nlead.ch
        description: >-
          The service hostname - n:lead provides it (see the Base URL on the API
          introduction page)
  - url: http://localhost:8000
    description: Local development
security: []
paths:
  /v1/dashboard/months/{month}:
    get:
      tags:
        - Dashboard
      summary: A month's forecast, schedule, allocation and reBAP
      description: |-
        The day's series of every day of the month the dashboard covers
        (``from`` to ``to``), one quarter-hour after the other, with each day's
        totals in ``days``. The first call for a month reads every day and can
        take up to a minute; the days are then shared for 5 minutes.
      operationId: get_dashboard_month_v1_dashboard_months__month__get
      parameters:
        - name: month
          in: path
          required: true
          schema:
            type: string
            pattern: ^\d{4}-(0[1-9]|1[0-2])$
            description: YYYY-MM
            title: Month
          description: YYYY-MM
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardMonth'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    DashboardMonth:
      properties:
        month:
          type: string
          title: Month
        from:
          type: string
          format: date
          title: From
        to:
          type: string
          format: date
          title: To
        generated_at:
          type: string
          format: date-time
          title: Generated At
        interval_minutes:
          type: integer
          title: Interval Minutes
        interval_count:
          type: integer
          title: Interval Count
        interval_starts_utc:
          items:
            type: string
            format: date-time
          type: array
          title: Interval Starts Utc
        rebap:
          $ref: '#/components/schemas/Rebap'
        germany:
          $ref: '#/components/schemas/MonthZone'
        control_areas:
          items:
            $ref: '#/components/schemas/MonthZone'
          type: array
          title: Control Areas
        days:
          items:
            $ref: '#/components/schemas/MonthDay'
          type: array
          title: Days
      type: object
      required:
        - month
        - from
        - to
        - generated_at
        - interval_minutes
        - interval_count
        - interval_starts_utc
        - rebap
        - germany
        - control_areas
        - days
      title: DashboardMonth
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Rebap:
      properties:
        eur_mwh:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Eur Mwh
        source:
          items:
            anyOf:
              - type: string
                enum:
                  - published_biko
                  - published_netztransparenz
                  - estimated_calculated
                  - estimated_tso_estimator
                  - estimated_forecast
              - type: 'null'
          type: array
          title: Source
      type: object
      required:
        - eur_mwh
        - source
      title: Rebap
    MonthZone:
      properties:
        control_area:
          anyOf:
            - type: string
            - type: 'null'
          title: Control Area
        forecast:
          $ref: '#/components/schemas/Forecast'
        schedule:
          $ref: '#/components/schemas/Series'
        allocation:
          $ref: '#/components/schemas/Series'
        totals_mwh:
          $ref: '#/components/schemas/Totals'
      type: object
      required:
        - control_area
        - forecast
        - schedule
        - allocation
        - totals_mwh
      title: MonthZone
    MonthDay:
      properties:
        delivery_day:
          type: string
          format: date
          title: Delivery Day
        forecast_source:
          anyOf:
            - type: string
              enum:
                - customer
                - generated
                - backup
            - type: 'null'
          title: Forecast Source
        schedule_status:
          type: string
          enum:
            - accepted
            - not_accepted
            - not_sent
          title: Schedule Status
        allocation_status:
          type: string
          enum:
            - settlement
            - preliminary
            - partial
            - none
          title: Allocation Status
        allocation_complete:
          type: boolean
          title: Allocation Complete
        totals_mwh:
          $ref: '#/components/schemas/Totals'
      type: object
      required:
        - delivery_day
        - forecast_source
        - schedule_status
        - allocation_status
        - allocation_complete
        - totals_mwh
      title: MonthDay
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    Forecast:
      properties:
        consumption_mw:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Consumption Mw
        production_mw:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Production Mw
      type: object
      required:
        - consumption_mw
        - production_mw
      title: Forecast
    Series:
      properties:
        consumption_mw:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Consumption Mw
        production_mw:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Production Mw
        net_mw:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Net Mw
          description: consumption minus production
      type: object
      required:
        - consumption_mw
        - production_mw
        - net_mw
      title: Series
    Totals:
      properties:
        forecast_consumption:
          anyOf:
            - type: number
            - type: 'null'
          title: Forecast Consumption
        forecast_production:
          anyOf:
            - type: number
            - type: 'null'
          title: Forecast Production
        schedule_consumption:
          anyOf:
            - type: number
            - type: 'null'
          title: Schedule Consumption
        schedule_production:
          anyOf:
            - type: number
            - type: 'null'
          title: Schedule Production
        schedule_net:
          anyOf:
            - type: number
            - type: 'null'
          title: Schedule Net
        allocation_consumption:
          anyOf:
            - type: number
            - type: 'null'
          title: Allocation Consumption
        allocation_production:
          anyOf:
            - type: number
            - type: 'null'
          title: Allocation Production
        allocation_net:
          anyOf:
            - type: number
            - type: 'null'
          title: Allocation Net
      type: object
      required:
        - forecast_consumption
        - forecast_production
        - schedule_consumption
        - schedule_production
        - schedule_net
        - allocation_consumption
        - allocation_production
        - allocation_net
      title: Totals
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      description: OIDC access token (Auth0 M2M)
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.