> ## 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 delivery day's forecast against the market's sum time series

> Per Regelzone and for Germany the forecast the day ran on and the Ist
from the activated sum time series (BK-SZR categories A, B and C), as
quarter-hour means in MW, with how complete the Ist is and - once it
is - the deviation. No Zählpunkt. Shared between callers for 5
minutes.



## OpenAPI

````yaml /setup/internal-openapi.json get /v1/mobile/plan-ist
openapi: 3.1.0
info:
  title: n:lead Scheduling Bridge — Internal API
  version: 0.4.0
  description: >-
    Internal API of the n:lead scheduling bridge: the process endpoints that
    drive the day-ahead pipeline (aggregate, publish the open position, submit
    schedules, generate forecasts, orchestrate), the operator console endpoints,
    and the read-only operator-app endpoints under /v1/mobile. The process and
    console endpoints require the process API key, /v1/mobile a device key of
    the mobile scope; not for customer use.
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/mobile/plan-ist:
    get:
      tags:
        - mobile
      summary: A delivery day's forecast against the market's sum time series
      description: |-
        Per Regelzone and for Germany the forecast the day ran on and the Ist
        from the activated sum time series (BK-SZR categories A, B and C), as
        quarter-hour means in MW, with how complete the Ist is and - once it
        is - the deviation. No Zählpunkt. Shared between callers for 5
        minutes.
      operationId: get_plan_ist_v1_mobile_plan_ist_get
      parameters:
        - name: day
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: the delivery day, default yesterday; at most 120 days back
            title: Day
          description: the delivery day, default yesterday; at most 120 days back
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanIst'
        '401':
          description: Missing or unknown device key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileError'
        '403':
          description: A valid key of another scope - only device keys open /v1/mobile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileError'
        '422':
          description: A parameter out of range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileError'
        '429':
          description: Rate limit exceeded; wait the seconds in `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileError'
        '503':
          description: MakoFlow could not be read; try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MobileError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    PlanIst:
      properties:
        delivery_day:
          type: string
          format: date
          title: Delivery Day
        generated_at:
          type: string
          format: date-time
          title: Generated At
        interval_count:
          type: integer
          enum:
            - 92
            - 96
            - 100
          title: Interval Count
        interval_starts_local:
          items:
            type: string
          type: array
          title: Interval Starts Local
        home_area:
          type: string
          enum:
            - 50Hertz
            - Amprion
            - TenneT
            - TransnetBW
          title: Home Area
        has_plan:
          type: boolean
          title: Has Plan
        total:
          $ref: '#/components/schemas/PlanIstArea'
        areas:
          items:
            $ref: '#/components/schemas/PlanIstArea'
          type: array
          title: Areas
      additionalProperties: false
      type: object
      required:
        - delivery_day
        - generated_at
        - interval_count
        - interval_starts_local
        - home_area
        - has_plan
        - total
        - areas
      title: PlanIst
    MobileError:
      properties:
        error:
          type: string
          enum:
            - unauthorized
            - forbidden
            - invalid_request
            - rate_limited
            - upstream_unavailable
            - internal
          title: Error
      additionalProperties: false
      type: object
      required:
        - error
      title: MobileError
      description: |-
        Every error under /v1/mobile: a code, nothing else - no detail text,
        no echo of the request.
    PlanIstArea:
      properties:
        control_area:
          anyOf:
            - type: string
              enum:
                - 50Hertz
                - Amprion
                - TenneT
                - TransnetBW
            - type: 'null'
          title: Control Area
          description: 'null: Germany, the sum of the Regelzonen'
        plan_consumption_mw:
          anyOf:
            - items:
                type: number
              type: array
            - type: 'null'
          title: Plan Consumption Mw
          description: the forecast the day ran on, per quarter-hour; null without one
        plan_production_mw:
          anyOf:
            - items:
                type: number
              type: array
            - type: 'null'
          title: Plan Production Mw
        ist_consumption_mw:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Ist Consumption Mw
          description: from the sum time series; null where a series lacks the quarter-hour
        ist_production_mw:
          items:
            anyOf:
              - type: number
              - type: 'null'
          type: array
          title: Ist Production Mw
        plan_consumption_mwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Plan Consumption Mwh
        plan_production_mwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Plan Production Mwh
        ist_consumption_mwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Ist Consumption Mwh
          description: only when complete
        ist_production_mwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Ist Production Mwh
        covered:
          type: integer
          title: Covered
          description: quarter-hours with every Ist value there
        complete:
          type: boolean
          title: Complete
        status:
          type: string
          enum:
            - leer
            - keine_werte
            - teilweise
            - vorlaeufig
            - abrechnung
          title: Status
          description: >-
            leer: nothing planned or activated; teilweise: some series lack
            values (the Netzbetreiber's monthly ones, typically); vorlaeufig:
            complete on the ÜNB's daily values; abrechnung: complete on the
            monthly ones
        deviation_mwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Deviation Mwh
          description: >-
            Ist minus plan, consumption minus production; positive: short. Only
            when complete
        short_mwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Short Mwh
        long_mwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Long Mwh
        max_deviation_index:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Deviation Index
        max_deviation_mw:
          anyOf:
            - type: number
            - type: 'null'
          title: Max Deviation Mw
        series:
          items:
            $ref: '#/components/schemas/PlanIstSeries'
          type: array
          title: Series
      additionalProperties: false
      type: object
      required:
        - control_area
        - plan_consumption_mw
        - plan_production_mw
        - ist_consumption_mw
        - ist_production_mw
        - plan_consumption_mwh
        - plan_production_mwh
        - ist_consumption_mwh
        - ist_production_mwh
        - covered
        - complete
        - status
        - deviation_mwh
        - short_mwh
        - long_mwh
        - max_deviation_index
        - max_deviation_mw
        - series
      title: PlanIstArea
    PlanIstSeries:
      properties:
        kategorie:
          type: string
          enum:
            - A
            - B
            - C
          title: Kategorie
          description: >-
            BK-SZR category (MaBiS): A by the Netzbetreiber, monthly; B by the
            ÜNB, monthly; C by the ÜNB, daily and preliminary
        art:
          type: string
          enum:
            - verbrauch
            - erzeugung
          title: Art
        zeitreihentyp:
          type: string
          title: Zeitreihentyp
        werte:
          type: integer
          title: Werte
          description: quarter-hours of the day with a value
      additionalProperties: false
      type: object
      required:
        - kategorie
        - art
        - zeitreihentyp
        - werte
      title: PlanIstSeries
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

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