Class SmardClient

Index

Constructors

Methods

latest series tableData timestamps

Constructors

constructor

new SmardClient(options?: EngineOptions): SmardClient
Parameters
- options: EngineOptions = {}
Returns SmardClient
- Defined in src/client/client.ts:24

Methods

latest

latest(
    filter: number,
    region:
        | "DE"
        | "AT"
        | "LU"
        | "DE-LU"
        | "DE-AT-LU"
        | "50Hertz"
        | "Amprion"
        | "TenneT"
        | "TransnetBW"
        | "APG"
        | "Creos",
    resolution: "hour" | "quarterhour" | "day" | "week" | "month" | "year",
): Promise<SeriesResult>
Convenience: fetch the newest available window's data in one call.
Parameters
- filter: number
- region:
      | "DE"
      | "AT"
      | "LU"
      | "DE-LU"
      | "DE-AT-LU"
      | "50Hertz"
      | "Amprion"
      | "TenneT"
      | "TransnetBW"
      | "APG"
      | "Creos"
- resolution: "hour" | "quarterhour" | "day" | "week" | "month" | "year"
Returns Promise<SeriesResult>
- Defined in src/client/client.ts:66

series

series(
    filter: number,
    region:
        | "DE"
        | "AT"
        | "LU"
        | "DE-LU"
        | "DE-AT-LU"
        | "50Hertz"
        | "Amprion"
        | "TenneT"
        | "TransnetBW"
        | "APG"
        | "Creos",
    resolution: "hour" | "quarterhour" | "day" | "week" | "month" | "year",
    timestamp: number,
): Promise<SeriesResult>
The data file for one window, identified by its timestamp.
Parameters
- filter: number
- region:
      | "DE"
      | "AT"
      | "LU"
      | "DE-LU"
      | "DE-AT-LU"
      | "50Hertz"
      | "Amprion"
      | "TenneT"
      | "TransnetBW"
      | "APG"
      | "Creos"
- resolution: "hour" | "quarterhour" | "day" | "week" | "month" | "year"
- timestamp: number
Returns Promise<SeriesResult>
- Defined in src/client/client.ts:54

tableData

tableData(
    filter: number,
    region:
        | "DE"
        | "AT"
        | "LU"
        | "DE-LU"
        | "DE-AT-LU"
        | "50Hertz"
        | "Amprion"
        | "TenneT"
        | "TransnetBW"
        | "APG"
        | "Creos",
    timestamp: number,
): Promise<TableResult>
Quarter-hour table_data for one window (richer per-point versions).
Parameters
- filter: number
- region:
      | "DE"
      | "AT"
      | "LU"
      | "DE-LU"
      | "DE-AT-LU"
      | "50Hertz"
      | "Amprion"
      | "TenneT"
      | "TransnetBW"
      | "APG"
      | "Creos"
- timestamp: number
Returns Promise<TableResult>
- Defined in src/client/client.ts:79

timestamps

timestamps(
    filter: number,
    region:
        | "DE"
        | "AT"
        | "LU"
        | "DE-LU"
        | "DE-AT-LU"
        | "50Hertz"
        | "Amprion"
        | "TenneT"
        | "TransnetBW"
        | "APG"
        | "Creos",
    resolution: "hour" | "quarterhour" | "day" | "week" | "month" | "year",
): Promise<number[]>
The timestamps (window starts) available for a (filter, region, resolution).
Parameters
- filter: number
- region:
      | "DE"
      | "AT"
      | "LU"
      | "DE-LU"
      | "DE-AT-LU"
      | "50Hertz"
      | "Amprion"
      | "TenneT"
      | "TransnetBW"
      | "APG"
      | "Creos"
- resolution: "hour" | "quarterhour" | "day" | "week" | "month" | "year"
Returns Promise<number[]>
- Defined in src/client/client.ts:29