Commands

Every command, argument and option of fragdenstaat 0.0.8, read from the CLI itself.

Global options

These options work with every command.

Option	Description	Default
`-V, --version`	output the version number
`--base-url <url>`	API base URL	`https://fragdenstaat.de`
`--timeout <ms>`	per-request timeout in milliseconds (0..2147483647)
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses
`--max-response-bytes <n>`	cap response body size in bytes (0 = unlimited; default 100 MiB)
`--compact`	print JSON on a single line instead of pretty-printed
`-o, --output <file>`	write output (JSON, or CSV with --csv) to this file
`--force`	with -o, overwrite the output file if it already exists

`fragdenstaat request`

FOI requests (Informationsfreiheitsanfragen) — the central resource

`fragdenstaat request list`

List/filter public FOI requests

fragdenstaat request list [options]

Options

Option	Description	Default
`--status <status>`	filter by lifecycle status Choices: awaiting_user_confirmation, publicbody_needed, awaiting_publicbody_confirmation, awaiting_response, awaiting_classification, asleep, resolved
`--resolution <resolution>`	filter by outcome (resolved requests) Choices: successful, partially_successful, not_held, refused, user_withdrew_costs, user_withdrew
`--jurisdiction <id>`	filter by jurisdiction id
`--law <id>`	filter by FOI law id
`--categories <id>`	filter by category id
`--classification <id>`	filter by public-body classification id
`--campaign <id>`	filter by campaign id
`--public-body <id>`	filter by addressed public-body id
`--tags <tag>`	filter by tag name
`--reference <prefix>`	filter by reference (prefix match)
`--slug <slug>`	filter by exact slug
`--is-foi [bool]`	only genuine FOI requests (true/false)
`--checked [bool]`	only moderator-checked requests (true/false)
`--has-same [bool]`	only requests with identical copies (true/false)
`--costs-min <eur>`	minimum charged costs in EUR
`--costs-max <eur>`	maximum charged costs in EUR
`--created-after <date>`	created on/after this date (YYYY-MM-DD)
`--created-before <date>`	created on/before this date (YYYY-MM-DD)
`--project <id>`	filter by project id
`--user <id>`	filter by requesting user id
`--follower <id>`	filter by follower user id
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat request get`

Get one request by id (includes its message thread)

fragdenstaat request get [options] <id>

Arguments

<id> required

`fragdenstaat request search`

Full-text search over public requests

fragdenstaat request search [options]

Options

Option	Description	Default
`--q <text>`	full-text query
`--jurisdiction <slug>`	restrict to a jurisdiction
`--category <slug>`	restrict to a category
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat request tags`

Autocomplete request tag names

fragdenstaat request tags [options] <query>

Arguments

<query> required: tag name fragment to autocomplete (must be non-empty)

`fragdenstaat publicbody`

Public bodies / authorities (Behörden) that receive FOI requests

`fragdenstaat publicbody list`

List/filter public bodies

fragdenstaat publicbody list [options]

Options

Option	Description	Default
`--q <text>`	full-text query over name/description
`--jurisdiction <id>`	filter by jurisdiction id
`--classification <id>`	filter by classification id (subtree match)
`--classification-id <id>`	filter by exact classification id
`--category <id>`	filter by category id
`--regions <id>`	filter by geo-region id
`--slug <slug>`	filter by exact slug
`--lnglat <lng,lat>`	filter to bodies whose regions contain a lng,lat point (not sorted by distance)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat publicbody get`

Get one public body by id

fragdenstaat publicbody get [options] <id>

Arguments

<id> required

`fragdenstaat publicbody search`

Full-text search over public bodies

fragdenstaat publicbody search [options]

Options

Option	Description	Default
`--q <text>`	full-text query
`--jurisdiction <id>`	restrict to a jurisdiction id
`--classification <id>`	restrict to a classification id
`--category <id>`	restrict to a category id
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat publicbody autocomplete`

Autocomplete public-body names

fragdenstaat publicbody autocomplete [options] <query>

Arguments

<query> required: text to autocomplete (must be non-empty)

`fragdenstaat law`

FOI laws (IFG, UIG, VIG, state transparency acts, local statutes)

`fragdenstaat law list`

List/filter FOI laws

fragdenstaat law list [options]

Options

Option	Description	Default
`--q <text>`	full-text query over name/description
`--jurisdiction <id>`	filter by jurisdiction id
`--mediator <id>`	filter by mediator public-body id
`--meta [bool]`	only meta-laws (combinations) — true/false
`--id <id>`	filter by law id
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat law get`

Get one law by id

fragdenstaat law get [options] <id>

Arguments

<id> required

`fragdenstaat law autocomplete`

Autocomplete law names

fragdenstaat law autocomplete [options] <query>

Arguments

<query> required: text to autocomplete (must be non-empty)

`fragdenstaat jurisdiction`

Jurisdictions (Bund, the 16 Länder, the EU)

`fragdenstaat jurisdiction list`

List jurisdictions

fragdenstaat jurisdiction list [options]

Options

Option	Description	Default
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat jurisdiction get`

Get one jurisdiction by id

fragdenstaat jurisdiction get [options] <id>

Arguments

<id> required

`fragdenstaat category`

Topical categories (Themen) — a tree

`fragdenstaat category list`

List/filter categories

fragdenstaat category list [options]

Options

Option	Description	Default
`--q <text>`	full-text query
`--name <name>`	filter by exact name
`--parent <id>`	filter to direct children of this category id
`--ancestor <id>`	filter to all descendants of this category id
`--depth <n>`	filter by tree depth
`--is-topic [bool]`	only topic categories (true/false)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat category get`

Get one category by id

fragdenstaat category get [options] <id>

Arguments

<id> required

`fragdenstaat category autocomplete`

Autocomplete category names

fragdenstaat category autocomplete [options] <query>

Arguments

<query> required: text to autocomplete (must be non-empty)

`fragdenstaat classification`

Public-body classifications (Behördentypen) — a tree

`fragdenstaat classification list`

List/filter classifications

fragdenstaat classification list [options]

Options

Option	Description	Default
`--q <text>`	full-text query
`--name <name>`	filter by exact name
`--parent <id>`	filter to direct children of this classification id
`--ancestor <id>`	filter to all descendants of this classification id
`--depth <n>`	filter by tree depth
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat classification get`

Get one classification by id

fragdenstaat classification get [options] <id>

Arguments

<id> required

`fragdenstaat campaign`

Campaigns (Kampagnen) — coordinated mass-request projects

`fragdenstaat campaign list`

List campaigns

fragdenstaat campaign list [options]

Options

Option	Description	Default
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat campaign get`

Get one campaign by id

fragdenstaat campaign get [options] <id>

Arguments

<id> required

`fragdenstaat georegion`

Geographic regions (Regionen): states, districts, municipalities, zip codes

`fragdenstaat georegion list`

List/filter geo-regions

fragdenstaat georegion list [options]

Options

Option	Description	Default
`--q <text>`	full-text query
`--name <name>`	filter by exact name
`--kind <kind>`	filter by region kind Choices: country, state, admin_district, district, admin_cooperation, municipality, borough, zipcode, admin_court_jurisdiction
`--kind-detail <text>`	filter by kind detail label
`--level <n>`	filter by hierarchy level
`--region-identifier <id>`	filter by region identifier
`--slug <slug>`	filter by exact slug
`--ancestor <id>`	filter to descendants of this region id
`--id <id>`	filter by region id
`--latlng <lat,lng>`	point-in-region lookup for a lat,lng point
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat georegion get`

Get one geo-region by id (includes geometry)

fragdenstaat georegion get [options] <id>

Arguments

<id> required

`fragdenstaat georegion autocomplete`

Autocomplete geo-region names

fragdenstaat georegion autocomplete [options] <query>

Arguments

<query> required: text to autocomplete (must be non-empty)

`fragdenstaat message`

Messages (Nachrichten) in the correspondence of FOI requests

`fragdenstaat message list`

List/filter messages (use --request to scope to one request)

fragdenstaat message list [options]

Options

Option	Description	Default
`--request <id>`	filter to one request's correspondence
`--kind <kind>`	filter by transport (email, post, fax, ...) Choices: email, post, fax, upload, phone, visit, import
`--is-response [bool]`	only replies from the authority (true/false)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat message get`

Get one message by id

fragdenstaat message get [options] <id>

Arguments

<id> required

`fragdenstaat document`

Published documents (Dokumente) extracted from FOI responses

`fragdenstaat document list`

List/filter published documents

fragdenstaat document list [options]

Options

Option	Description	Default
`--publicbody <id>`	filter by publishing public-body id
`--foirequest <id>`	filter by source request id
`--collection <id>`	filter by document-collection id
`--portal <id>`	filter by document-portal id
`--directory <id>`	filter by directory id
`--tag <id>`	filter by tag id (numeric)
`--ids <ids>`	filter by a comma-separated list of document ids
`--created-after <date>`	created on/after this date (YYYY-MM-DD)
`--created-before <date>`	created on/before this date (YYYY-MM-DD)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output the server-rendered CSV export instead of JSON

`fragdenstaat document get`

Get one document by id (includes its pages)

fragdenstaat document get [options] <id>

Arguments

<id> required