Skip to contents

List DIP Personen

Usage

dip_bundestag_person_list(
  params = list(),
  safe = TRUE,
  refresh = FALSE,
  flatten = FALSE,
  flatten_mode = "json"
)

Arguments

params

Named list of query parameters. Common keys:

format

Response format ("json" recommended; default set by adapter).

apikey

Optional API key as query parameter (prefer auth header).

fuzzy

Free-text search string (character).

sort

Sort field/order definition (character).

cursor

Cursor for pagination (character).

limit

Page size/maximum number of documents (integer).

safe

Logical; if TRUE (default), apply rate-limiting and cache GET responses to tools::R_user_dir("bunddev", "cache").

refresh

Logical; if TRUE, ignore cached responses and re-fetch from the API (default FALSE).

flatten

Logical; if TRUE, simplify nested list columns according to flatten_mode. Default FALSE keeps list columns as-is.

flatten_mode

How to handle list columns when flatten = TRUE:

"drop"

Remove list columns entirely. Use when nested data is not needed.

"json"

Convert each list element to a JSON string. Preserves all data in a text-queryable format. This is the default.

"unnest"

Expand list columns into multiple rows via tidyr::unnest_longer(). Warning: this can significantly increase the number of rows.

Value

A tibble with one row per Person and columns:

id

Character. Unique person identifier.

nachname

Character. Last name.

vorname

Character. First name.

namenszusatz

Character. Name affix.

typ

Character. Entity type, always "Person".

wahlperiode

Integer. Legislative period of first document.

basisdatum

Character. Date of first associated document.

datum

Character. Date of most recent document.

aktualisiert

Character. Last update timestamp.

titel

Character. Display title with role.

person_roles

List. Roles and alternative names.

Wrapped in a one-row tibble with num_found (integer), cursor (character), and documents (list-column) when not yet unpacked.

Examples

if (FALSE) { # \dontrun{
dip_bundestag_person_list()
} # }