> ## 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 schedule against the Ist, with reBAP and cost

> For Germany and per Regelzone the Fahrplan, the Ist from the BK-SZR
(Kategorie A plus B, or A plus C until B arrives), the deviation per
quarter-hour (positive = short), the reBAP from the BIKO's PRICAT 27001
and the cost (deviation MWh times reBAP, positive = to pay), plus the
net series per Kategorie and the Ist per Bilanzierungsgebiet. Where the
Ist is not complete, the sums cover the quarter-hours compared.



## OpenAPI

````yaml /setup/internal-openapi.json get /v1/process/fahrplan-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/process/fahrplan-ist:
    get:
      summary: A delivery day's schedule against the Ist, with reBAP and cost
      description: |-
        For Germany and per Regelzone the Fahrplan, the Ist from the BK-SZR
        (Kategorie A plus B, or A plus C until B arrives), the deviation per
        quarter-hour (positive = short), the reBAP from the BIKO's PRICAT 27001
        and the cost (deviation MWh times reBAP, positive = to pay), plus the
        net series per Kategorie and the Ist per Bilanzierungsgebiet. Where the
        Ist is not complete, the sums cover the quarter-hours compared.
      operationId: get_fahrplan_ist_v1_process_fahrplan_ist_get
      parameters:
        - name: day
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: >-
              the delivery day, default yesterday; 120 days back to the forecast
              horizon
            title: Day
          description: >-
            the delivery day, default yesterday; 120 days back to the forecast
            horizon
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Fahrplan Ist V1 Process Fahrplan Ist Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  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.