Examples

The examples/ directory in the repository contains a number of ready-to-run scripts and notebooks.

Table of contents

  1. Scripts
  2. Jupyter Notebooks
  3. Quick Example: List Councillors
  4. Quick Example: Search Speeches
  5. Quick Example: Query the Gever Backend
  6. Quick Example: Plot Voting Results

Scripts

File Description
filter.py Basic filtering by field value
filter_advanced.py Advanced OData filter expressions
filter_query.py Filter with raw OData $filter query strings
glimpse.py Use get_glimpse() to preview a table
list_all_tables_and_properties.py List all tables and their variables
pagination.py Handling large result sets with pagination
slice.py Slicing and indexing a result set
download_votes_in_batches.py Download all votes in batches
visualize_voting.py Plot a National Council seat map
compare_backends.py Compare the OData and OpenParlData backends
openparldata_backend.py Using the OpenParlData backend
gever_backend.py Using the Gever backend of the canton and the city of Zurich

Jupyter Notebooks

Notebook Description
Swiss Parliament API.ipynb Comprehensive walkthrough of the OData API
OpenParlData_vs_OData_Backend.ipynb Side-by-side comparison of both backends

Quick Example: List Councillors 

import swissparlpy as spp

councillors = spp.get_data('MemberCouncil', Language='DE', CantonAbbreviation='ZH')
for c in councillors:
    print(f"{c['FirstName']} {c['LastName']}")

Quick Example: Search Speeches 

import swissparlpy as spp

opd_client = spp.SwissParlClient(backend="openparldata")
response = opd_client.get_data(
    "speeches",
    search_mode="natural",
    search_scope="all",
    search_language="de",
    search="Klimawandel"
)
df = response.to_dataframe()
print(df[["id", "date_start", "text_content_de"]].head())

Quick Example: Query the Gever Backend 

import swissparlpy as spp

# Electoral districts of the canton of Zurich
districts = spp.get_data('wahlkreise', 'inaktiv = false', backend='gever')
for d in districts[:5]:
    print(d['name'])

# Search for a member and explode their mandates into a DataFrame
members = spp.get_data('mitglieder', name='Marti', backend='gever')
mandates = members.explode('behoerdenmandate')
print(mandates.head())

Quick Example: Plot Voting Results 

import swissparlpy as spp
import matplotlib.pyplot as plt

votes = spp.get_data('Voting', Language='DE', IdVote=23458)
spp.plot_voting(votes, theme='scoreboard', result=True)
plt.show()