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

# Cloover's confirmed customers against the market

> Per Bilanzierungsgebiet with customers: what is missing, and whether
that is urgent - at most 14 days before the first supply start, or
after it. ``unvollstaendig`` and ``kein_quellstand`` mean the list is
not complete; never read them as "nothing urgent". Shared between
callers for 5 minutes.



## OpenAPI

````yaml /setup/internal-openapi.json get /v1/mobile/kundenhochlauf
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/kundenhochlauf:
    get:
      tags:
        - mobile
      summary: Cloover's confirmed customers against the market
      description: |-
        Per Bilanzierungsgebiet with customers: what is missing, and whether
        that is urgent - at most 14 days before the first supply start, or
        after it. ``unvollstaendig`` and ``kein_quellstand`` mean the list is
        not complete; never read them as "nothing urgent". Shared between
        callers for 5 minutes.
      operationId: get_kundenhochlauf_v1_mobile_kundenhochlauf_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Kundenhochlauf'
        '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'
        '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'
      security:
        - APIKeyHeader: []
components:
  schemas:
    Kundenhochlauf:
      properties:
        generated_at:
          type: string
          format: date-time
          title: Generated At
        stand:
          anyOf:
            - type: string
            - type: 'null'
          title: Stand
          description: when Cloover's sheet was last updated, YYYY-MM-DD[ HH:MM]
        received_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Received At
        kunden:
          type: integer
          title: Kunden
        kein_quellstand:
          type: boolean
          title: Kein Quellstand
          description: Cloover has sent no snapshot yet
        unvollstaendig:
          type: boolean
          title: Unvollstaendig
          description: >-
            the comparison with the market could not run; the areas are missing,
            not fine
        urgent_count:
          type: integer
          title: Urgent Count
        gebiete:
          items:
            $ref: '#/components/schemas/Gebiet'
          type: array
          title: Gebiete
          description: urgent first
      additionalProperties: false
      type: object
      required:
        - generated_at
        - stand
        - received_at
        - kunden
        - kein_quellstand
        - unvollstaendig
        - urgent_count
        - gebiete
      title: Kundenhochlauf
    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.
    Gebiet:
      properties:
        bilanzierungsgebiet:
          type: string
          title: Bilanzierungsgebiet
        netzbetreiber_mp_id:
          type: string
          title: Netzbetreiber Mp Id
        netzbetreiber:
          type: string
          title: Netzbetreiber
          description: the registry's name, else the MP-ID
        regelzone:
          type: string
          enum:
            - 50Hertz
            - Amprion
            - TenneT
            - TransnetBW
            - unbekannt
          title: Regelzone
        status:
          anyOf:
            - type: string
              enum:
                - rejected
                - pending
                - established
                - complete
                - zugeordnet
                - contacted
                - none
                - ausgenommen
            - type: 'null'
          title: Status
          description: the Netzbetreiber's market communication status
        anzahl:
          type: integer
          title: Anzahl
        erster_lieferbeginn:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Erster Lieferbeginn
        fehlend:
          items:
            type: string
          type: array
          title: Fehlend
          description: Zeitreihentypen not active in time
        ohne_zoe:
          type: boolean
          title: Ohne Zoe
        ohne_typ:
          type: integer
          title: Ohne Typ
          description: customers without a forecast type
        urgent:
          type: boolean
          title: Urgent
          description: >-
            something is missing and the first supply start is at most 14 days
            away, or past
      additionalProperties: false
      type: object
      required:
        - bilanzierungsgebiet
        - netzbetreiber_mp_id
        - netzbetreiber
        - regelzone
        - status
        - anzahl
        - erster_lieferbeginn
        - fehlend
        - ohne_zoe
        - ohne_typ
        - urgent
      title: Gebiet
  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.