koala-nowcast-api

The public data access layer for KOALA: the API contract for the election-nowcast data products, plus thin R and Python clients built on top of it.

Status: skeleton. The pipeline that produces the data lives in KOALA-LMU/koala-nowcast. This repo defines how to consume it.

Path	Contents
spec/	API contract — endpoint/JSON schema definitions (OpenAPI)
r/	R client, package koala.nowcast.api
python/	Python client, distribution koala-nowcast-api (import koala_nowcast_api)

Data products served: pooled poll time series, simulated seat distributions, threshold-crossing ("Hürde") probabilities and coalition probabilities — current snapshot and historical series, per election (Bundestag and Landtage).

Planned interface (draft)

library(koala.nowcast.api)
koala_elections()                        # available elections
koala_coalitions("btw")                  # current coalition probabilities
koala_coalitions("btw", history = TRUE)  # time series
koala_seats("ltw_st")                    # simulated seat distribution

import koala_nowcast_api as koala
koala.elections()
koala.coalitions("btw")
koala.coalitions("btw", history=True)
koala.seats("ltw_st")

Naming

The Python distribution is koala-nowcast-api; the R package is koala.nowcast.api, since CRAN package names may not contain hyphens.

License

MIT — see LICENSE.