Skip to contents

Read the bundled API registry

Usage

bunddev_registry()

Value

A tibble with one row per API registry entry:

id

Stable API identifier used throughout bunddev (character).

title

Human-readable API title (character).

provider

API provider or owning institution (character).

spec_url

OpenAPI specification URL (character).

docs_url

Upstream API documentation URL (character).

auth

Authentication type ("none", "api_key", "oauth2").

rate_limit

Declared upstream rate limit text (character or NA).

tags

List-column of taxonomy tags (list of character vectors).

Details

The registry is bundled with the package and contains metadata such as the API title, provider, documentation URL, OpenAPI spec URL, authentication type, and any declared rate limits. The data originates from bund.dev and the bundesAPI registry.

See also

bunddev_list() for filtered listings, bunddev_search() for keyword searches, and bunddev_info() for a single entry.

Other Registry: bunddev_info(), bunddev_list(), bunddev_search()

Examples

registry <- bunddev_registry()
head(registry, 3)
#> # A tibble: 3 × 8
#>   id               title       provider spec_url docs_url auth  rate_limit tags 
#>   <chr>            <chr>       <chr>    <chr>    <chr>    <chr> <chr>      <lis>
#> 1 abfallnavi       Abfallnavi… regio iT https:/… https:/… none  NA         <chr>
#> 2 ausbildungssuche Ausbildung… Bundesa… https:/… https:/… api_… NA         <chr>
#> 3 autobahn         Autobahn A… Autobah… https:/… https:/… none  NA         <chr>