@maschinenlesbar.org/pegel-online-cli
    Preparing search index...

    Interface StationListParams

    Parameters for the stations listing.

    interface StationListParams {
        fuzzyId?: string;
        ids?: string[];
        includeCharacteristicValues?: boolean;
        includeCurrentMeasurement?: boolean;
        includeForecastTimeseries?: boolean;
        includeTimeseries?: boolean;
        waters?: string;
    }
    Index
    fuzzyId? ids? includeCharacteristicValues? includeCurrentMeasurement? includeForecastTimeseries? includeTimeseries? waters?
    fuzzyId?: string

    Fuzzy id match; not blank.

    ids?: string[]

    Station identifiers (uuid/number/shortname/longname); sent comma-separated. At least one, none blank. A name may match more than one station (NEUSTADT: LEINE and OSTSEE) and an unknown one matches none, silently: stationListNotes reports both.

    includeCharacteristicValues?: boolean

    Embed the gauge marks inside each timeseries. Implies includeTimeseries like the above.

    includeCurrentMeasurement?: boolean

    Embed the current measurement inside each timeseries. Implies includeTimeseries: true unless that is set explicitly: the API drops the measurement without the timeseries list.

    includeForecastTimeseries?: boolean

    Also list the forecast series (WV, see TimeseriesInfo.start) in each station's timeseries list; the API leaves them out otherwise. Implies includeTimeseries like the above.

    includeTimeseries?: boolean

    Embed each station's timeseries list.

    waters?: string

    Water shortname filter; not blank.

    Settings
    Member Visibility

    On This Page
    Properties