Commands

Every command, argument and option of smard 0.5.1, read from the CLI itself.

Global options

These options work with every command.

OptionDescriptionDefault
-V, --version output the version number
--base-url <url> API base URL https://www.smard.de
--timeout <ms> time limit per request in milliseconds, whole response included (0 = no timeout) 30000
--user-agent <ua> User-Agent header value
--max-retries <n> retries for transient 429/503 responses and reset connections (0..10; each backs off linearly, or waits the server's Retry-After when longer, up to 30 s) 2
--max-response-bytes <n> cap response body size in bytes (0 = unlimited; default 100 MiB)
--log-format <format> how errors, warnings and notes are written to stderr: text (log4j style: time, level, [topic], message) or jsonl (one JSON object per line: ts, level, topic, msg); default text
--compact print JSON on a single line instead of pretty-printed

smard timestamps

List the available window timestamps for a series

smard timestamps [options] <filter> <region> <resolution>

Arguments

<filter> required
<region> required
<resolution> required

smard series

Get one window's data (timestamp from `timestamps`)

smard series [options] <filter> <region> <resolution> <timestamp>

Arguments

<filter> required
<region> required
<resolution> required
<timestamp> required

smard latest

Get the newest available window's data in one call

smard latest [options] <filter> <region> <resolution>

Arguments

<filter> required
<region> required
<resolution> required

smard table

Get quarter-hour table_data for one window (SMARD has none for windows from late 2024 on: expect a 404)

smard table [options] <filter> <region> <timestamp>

Arguments

<filter> required
<region> required
<timestamp> required

smard filters

List the documented chart-data filter ids

smard filters [options]

Options

OptionDescriptionDefault
--group <group> only show one group: generation|consumption|price|forecast

smard regions

List the valid region codes

smard regions [options]