> ## 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.

# Contracts with the market partners, recorded and expected

> Every contract recorded in the console or expected from what exists:
the Bilanzkreisvertrag per active Regelzone, the
Lieferantenrahmenvertrag and the Zuordnungsvereinbarung per
Netzbetreiber with customers (the latter also wherever we granted a
ZOE). ``status`` is ``angefragt``, ``aktiv``, ``gekuendigt`` or
``fehlt``; ``quelle`` says where it comes from - ``eintrag`` (recorded
here), ``rahmenvertrag`` (the Quittungs-Nachfass' ledger) or
``lieferantenrahmenvertrag`` (a Zuordnungsvereinbarung carried by it,
BK6-20-160). ``zaehler`` counts per type and state.



## OpenAPI

````yaml /setup/internal-openapi.json get /v1/process/vertraege
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/vertraege:
    get:
      summary: Contracts with the market partners, recorded and expected
      description: |-
        Every contract recorded in the console or expected from what exists:
        the Bilanzkreisvertrag per active Regelzone, the
        Lieferantenrahmenvertrag and the Zuordnungsvereinbarung per
        Netzbetreiber with customers (the latter also wherever we granted a
        ZOE). ``status`` is ``angefragt``, ``aktiv``, ``gekuendigt`` or
        ``fehlt``; ``quelle`` says where it comes from - ``eintrag`` (recorded
        here), ``rahmenvertrag`` (the Quittungs-Nachfass' ledger) or
        ``lieferantenrahmenvertrag`` (a Zuordnungsvereinbarung carried by it,
        BK6-20-160). ``zaehler`` counts per type and state.
      operationId: get_vertraege_v1_process_vertraege_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Vertraege V1 Process Vertraege Get
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  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.