destatis

October 9, 2021 ยท View on GitHub

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bundesAPI/deutschland.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bundesAPI/deutschland.git)

Then import the package:

from deutschland import destatis

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

from deutschland import destatis

Getting Started

Please follow the installation procedure and then run the following:


import time
from deutschland import destatis
from pprint import pprint
from deutschland.destatis.api import default_api
# Defining the host is optional and defaults to https://www-genesis.destatis.de/genesisWS/rest/2020
# See configuration.py for a list of all supported configuration parameters.
configuration = destatis.Configuration(
    host = "https://www-genesis.destatis.de/genesisWS/rest/2020"
)



# Enter a context with an instance of the API client
with destatis.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    username = "GAST" # str |  (optional) (default to "GAST")
password = "GAST" # str |  (optional) (default to "GAST")
name = "name_example" # str |  (optional)
area = "free" # str |  (optional) (default to "free")
charttype = "0" # str |  (optional) (default to "0")
drawpoints = "false" # str |  (optional) (default to "false")
zoom = "2" # str |  (optional) (default to "2")
focus = "false" # str |  (optional) (default to "false")
tops = "false" # str |  (optional) (default to "false")
format = "png" # str |  (optional) (default to "png")
language = "de" # str |  (optional) (default to "de")

    try:
        api_instance.chart2result(username=username, password=password, name=name, area=area, charttype=charttype, drawpoints=drawpoints, zoom=zoom, focus=focus, tops=tops, format=format, language=language)
    except destatis.ApiException as e:
        print("Exception when calling DefaultApi->chart2result: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://www-genesis.destatis.de/genesisWS/rest/2020

ClassMethodHTTP requestDescription
DefaultApichart2resultGET /data/chart2result
DefaultApichart2tableGET /data/chart2table
DefaultApichart2timeseriesGET /data/chart2timeseries
DefaultApicubeGET /data/cube
DefaultApicube_metaGET /metadata/cube
DefaultApicubefileGET /data/cubefile
DefaultApicubesGET /catalogue/cubes
DefaultApicubes2statisticGET /catalogue/cubes2statistic
DefaultApicubes2variableGET /catalogue/cubes2variable
DefaultApifindGET /find/find
DefaultApijobsGET /catalogue/jobs
DefaultApilogincheckGET /helloworld/logincheck
DefaultApimap2resultGET /data/map2result
DefaultApimap2tableGET /data/map2table
DefaultApimap2timeseriesGET /data/map2timeseries
DefaultApimodifieddataGET /catalogue/modifieddata
DefaultApipasswordGET /profile/password
DefaultApiqualitysignsGET /catalogue/qualitysigns
DefaultApiremove_resultGET /profile/removeResult
DefaultApiresultGET /data/result
DefaultApiresultfileGET /data/resultfile
DefaultApiresultsGET /catalogue/results
DefaultApistatisticGET /metadata/statistic
DefaultApistatisticsGET /catalogue/statistics
DefaultApistatistics2variableGET /catalogue/statistics2variable
DefaultApitableGET /data/table
DefaultApitable_metaGET /metadata/table
DefaultApitablefileGET /data/tablefile
DefaultApitablesGET /catalogue/tables
DefaultApitables2statisticGET /catalogue/tables2statistic
DefaultApitables2variableGET /catalogue/tables2variable
DefaultApitermsGET /catalogue/terms
DefaultApitimeseriesGET /catalogue/timeseries
DefaultApitimeseries2statisticGET /catalogue/timeseries2statistic
DefaultApitimeseries2variableGET /catalogue/timeseries2variable
DefaultApitimeseries_dataGET /data/timeseries
DefaultApitimeseries_metaGET /metadata/timeseries
DefaultApitimeseriesfileGET /data/timeseriesfile
DefaultApivalueGET /metadata/value
DefaultApivaluesGET /catalogue/values
DefaultApivalues2variableGET /catalogue/values2variable
DefaultApivariableGET /metadata/variable
DefaultApivariablesGET /catalogue/variables
DefaultApivariables2statisticGET /catalogue/variables2statistic
DefaultApiwhoamiGET /helloworld/whoami

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in destatis.apis and destatis.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from deutschland.destatis.api.default_api import DefaultApi
  • from deutschland.destatis.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
from deutschland import destatis
from deutschland.destatis.apis import *
from deutschland.destatis.models import *