# Regionalatlas
API zum [Regionalatlas Deutschland](https://regionalatlas.statistikportal.de/#) der statistischen Ämter des Bundes und der Länder.
Der Regionalatlas Deutschland der Statistischen Ämter des Bundes und der Länder visualisiert aktuell laut [statistischem Bundesamt](https://www.destatis.de/DE/Service/Statistik-Visualisiert/_inhalt.html) mehr als 160 Indikatoren aus 20 Themenbereichen für Bundesländer, Regierungsbezirke, Kreisfreie Städte und Landkreise. Grundlage des Regionalatlas ist die Regionaldatenbank Deutschland.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python >= 3.6
## Installation & Usage
### pip install
```sh
pip install deutschland[Regionalatlas]
```
### poetry install
```sh
poetry add deutschland -E Regionalatlas
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
## Usage
Import the package:
```python
from deutschland import Regionalatlas
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
from deutschland import Regionalatlas
from pprint import pprint
from deutschland.Regionalatlas.api import default_api
# Defining the host is optional and defaults to https://www.gis-idmz.nrw.de/arcgis/rest/services/stba/regionalatlas/MapServer/dynamicLayer
# See configuration.py for a list of all supported configuration parameters.
configuration = Regionalatlas.Configuration(
host = "https://www.gis-idmz.nrw.de/arcgis/rest/services/stba/regionalatlas/MapServer/dynamicLayer"
)
# Enter a context with an instance of the API client
with Regionalatlas.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)
layer = "%7B%22source%22%3A%7B%22dataSource%22%3A%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22workspaceId%22%3A%22gdb%22%2C%22query%22%3A%22SELECT%20*%20FROM%20verwaltungsgrenzen_gesamt%20LEFT%20OUTER%20JOIN%20ai002_1_5%20ON%20ags%20%3D%20ags2%20and%20jahr%20%3D%20jahr2%20WHERE%20typ%20%3D%201%20AND%20jahr%20%3D%202020%20AND%20(jahr2%20%3D%202020%20OR%20jahr2%20IS%20NULL)%22%2C%22oidFields%22%3A%22id%22%2C%22spatialReference%22%3A%7B%22wkid%22%3A25832%7D%2C%22type%22%3A%22queryTable%22%7D%2C%22type%22%3A%22dataLayer%22%7D%7D" # str | Komplexer Parameter, der im JSON-Format Details der Anfrage spezifiziert. In der Regel stellt enthält der layer-Parameter ein Objekt (in geschweiften Klammern), das seinerseits ein Objekt namens 'source' enthält. Das source-Objekt wiederum enthält ein Objekt, das zum einen das Objekt 'dataSource' und zum anderen ein Datum namens 'type' mit dem Wert 'dataLayer' enthält. In dataSource wird die gewünschte Tabelle spezifiziert (z.B. für Angaben zur Bevölkerungsdichte 'ai002_1_5') - im Folgenden mit dem Platzhalter *tableName* gekennzeichnet. dataSource kann unterschiedlich aufgebaut sein und enthält entweder (a) Daten namens 'dataSourceName' (mit einem Wert wie z.B. 'regionalatlas.*tableName*'), 'workspaceId' (z.B. 'gdb') und 'type' (z.B. 'table') oder (b) Daten namens 'geometryType' (z.B. 'esriGeometryPolygon'), 'workspaceId' (z.B. 'gdb'), 'query' (mit einem SQL-Query, z.B. 'SELECT * FROM verwaltungsgrenzen_gesamt LEFT OUTER JOIN *tableName* ON ags = ags2 and jahr = jahr2 WHERE typ = 3 AND jahr = 2020 AND (jahr2 = 2020 OR jahr2 IS NULL)'), 'oidFields' (z.B. 'id'), 'spatialReference' (mit einem Objekt, das wiederum das Datum 'wkid' mit einem Wert wie 25832 umfasst), und 'type':'queryTable'. Der SQL-Query dürfte für Nutzer*innen des Regionalatlas Deutschland weitgehend selbsterklärend sein, wobei man wissen muss dass die Variable *typ* die gewünschte regionale Ebene spezifiziert: - 1=Bundesländer, - 2=Regierungsbezirke und Statistische Regionen, - 3=Kreise und kreisfreie Städte. Gültige Einträge für die *tableName* werden im Folgenden auszugsweise dargestellt (jeweils mit den enthaltenen Variablen/fields) - Bevölkerungsdichte: ai002_1_5 - - ai0201: Bevölkerungsdichte (EW je qkm) - - ai0202: Bevölkerungsentwicklung im Jahr je 10.000 EW - - ai0208: Anteil der ausländischen Bevölkerung an der Gesamtbevölkerung - - ai0209: Lebendgeborene je 10.000 EW - - ai0210: Gestorbene je 10.000 EW - - ai0211: Geburten-/Gestorbenenüberschuss je 10.000 EW - - ai0212: Wanderungssaldo je 10.000 EW - Altersdurchschnitt: ai002_4_5 - - ai0218: Durchschnittsalter der Bevölkerung - - ai0219: das Durchschnittsalter der Mutter bei der Geburt des 1. Kindes) - Arbeitslosenquote: ai008_1_5 - - ai0801: Arbeitslosenquote - - ai0806: Anteil Arbeitslose 15-24 Jahre an Arbeitslosen insgesamt - - ai0807: Anteil Arbeitslose 55-64 Jahre an Arbeitslosen insgesamt - - ai0808: Anteil Langzeitarbeitslose an Arbeitslosen insgesamt - - ai0809: Anteil der ausl. Arbeitslosen an Arbeitslosen insgesamt - Verfügbares Einkommen je EW: ai_s_01 - SGB-II-Quote: ai_s_04 - BIP je Erwerbstätigem: ai017_1 - Wahlergebnisse Bundestagswahl: ai005' (default to "%7B%22source%22%3A%7B%22dataSource%22%3A%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22workspaceId%22%3A%22gdb%22%2C%22query%22%3A%22SELECT%20*%20FROM%20verwaltungsgrenzen_gesamt%20LEFT%20OUTER%20JOIN%20ai002_1_5%20ON%20ags%20%3D%20ags2%20and%20jahr%20%3D%20jahr2%20WHERE%20typ%20%3D%201%20AND%20jahr%20%3D%202020%20AND%20(jahr2%20%3D%202020%20OR%20jahr2%20IS%20NULL)%22%2C%22oidFields%22%3A%22id%22%2C%22spatialReference%22%3A%7B%22wkid%22%3A25832%7D%2C%22type%22%3A%22queryTable%22%7D%2C%22type%22%3A%22dataLayer%22%7D%7D")
f = "json" # str | Output-Format (z.B. 'json' oder 'html').
return_geometry = False # bool | Boolsche Angabe, ob Angaben zur Geometrie gesendet werden sollen (z.B. 'false').
spatial_rel = "esriSpatialRelIntersects" # str | spational relation (z.B. 'esriSpatialRelIntersects').
where = "1%3D1" # str | Spezifikation einer gewünschten Teilmenge der Daten (z.B.'1=1'' für alle Daten oder 'ags2 = 'DG' and jahr2 = 2020').
out_fields = "*" # str | Auszugebende Variablen/fields (z.B. '*'). (optional)
try:
# publicwebpageplus
api_response = api_instance.query(layer, f, return_geometry, spatial_rel, where, out_fields=out_fields)
pprint(api_response)
except Regionalatlas.ApiException as e:
print("Exception when calling DefaultApi->query: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://www.gis-idmz.nrw.de/arcgis/rest/services/stba/regionalatlas/MapServer/dynamicLayer*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**query**](docs/DefaultApi.md#query) | **GET** /query | publicwebpageplus
## Documentation For Models
## Documentation For Authorization
All endpoints do not require authorization.
## Author
kontakt@bund.dev
## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in Regionalatlas.apis and Regionalatlas.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.Regionalatlas.api.default_api import DefaultApi`
- `from deutschland.Regionalatlas.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 Regionalatlas
from deutschland.Regionalatlas.apis import *
from deutschland.Regionalatlas.models import *
```
Raw data
{
"_id": null,
"home_page": "https://github.com/bundesAPI/regionalatlas-api",
"name": "de-regionalatlas",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Regionalatlas,App,API",
"author": "BundesAPI",
"author_email": "kontakt@bund.dev",
"download_url": "https://files.pythonhosted.org/packages/de/20/2a0c0975bc81ebe8c1724c32c25eb07499fff0585158a5a2b2f75715a3a0/de_regionalatlas-0.1.0.tar.gz",
"platform": null,
"description": "# Regionalatlas\nAPI zum [Regionalatlas Deutschland](https://regionalatlas.statistikportal.de/#) der statistischen \u00c4mter des Bundes und der L\u00e4nder. \n\nDer Regionalatlas Deutschland der Statistischen \u00c4mter des Bundes und der L\u00e4nder visualisiert aktuell laut [statistischem Bundesamt](https://www.destatis.de/DE/Service/Statistik-Visualisiert/_inhalt.html) mehr als 160 Indikatoren aus 20 Themenbereichen f\u00fcr Bundesl\u00e4nder, Regierungsbezirke, Kreisfreie St\u00e4dte und Landkreise. Grundlage des Regionalatlas ist die Regionaldatenbank Deutschland. \n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 0.1.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n### pip install\n\n```sh\npip install deutschland[Regionalatlas]\n```\n\n### poetry install\n\n```sh\npoetry add deutschland -E Regionalatlas\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\n## Usage\n\nImport the package:\n```python\nfrom deutschland import Regionalatlas\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nfrom deutschland import Regionalatlas\nfrom pprint import pprint\nfrom deutschland.Regionalatlas.api import default_api\n# Defining the host is optional and defaults to https://www.gis-idmz.nrw.de/arcgis/rest/services/stba/regionalatlas/MapServer/dynamicLayer\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = Regionalatlas.Configuration(\n host = \"https://www.gis-idmz.nrw.de/arcgis/rest/services/stba/regionalatlas/MapServer/dynamicLayer\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith Regionalatlas.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = default_api.DefaultApi(api_client)\n layer = \"%7B%22source%22%3A%7B%22dataSource%22%3A%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22workspaceId%22%3A%22gdb%22%2C%22query%22%3A%22SELECT%20*%20FROM%20verwaltungsgrenzen_gesamt%20LEFT%20OUTER%20JOIN%20ai002_1_5%20ON%20ags%20%3D%20ags2%20and%20jahr%20%3D%20jahr2%20WHERE%20typ%20%3D%201%20AND%20jahr%20%3D%202020%20AND%20(jahr2%20%3D%202020%20OR%20jahr2%20IS%20NULL)%22%2C%22oidFields%22%3A%22id%22%2C%22spatialReference%22%3A%7B%22wkid%22%3A25832%7D%2C%22type%22%3A%22queryTable%22%7D%2C%22type%22%3A%22dataLayer%22%7D%7D\" # str | Komplexer Parameter, der im JSON-Format Details der Anfrage spezifiziert. In der Regel stellt enth\u00e4lt der layer-Parameter ein Objekt (in geschweiften Klammern), das seinerseits ein Objekt namens 'source' enth\u00e4lt. Das source-Objekt wiederum enth\u00e4lt ein Objekt, das zum einen das Objekt 'dataSource' und zum anderen ein Datum namens 'type' mit dem Wert 'dataLayer' enth\u00e4lt. In dataSource wird die gew\u00fcnschte Tabelle spezifiziert (z.B. f\u00fcr Angaben zur Bev\u00f6lkerungsdichte 'ai002_1_5') - im Folgenden mit dem Platzhalter *tableName* gekennzeichnet. dataSource kann unterschiedlich aufgebaut sein und enth\u00e4lt entweder (a) Daten namens 'dataSourceName' (mit einem Wert wie z.B. 'regionalatlas.*tableName*'), 'workspaceId' (z.B. 'gdb') und 'type' (z.B. 'table') oder (b) Daten namens 'geometryType' (z.B. 'esriGeometryPolygon'), 'workspaceId' (z.B. 'gdb'), 'query' (mit einem SQL-Query, z.B. 'SELECT * FROM verwaltungsgrenzen_gesamt LEFT OUTER JOIN *tableName* ON ags = ags2 and jahr = jahr2 WHERE typ = 3 AND jahr = 2020 AND (jahr2 = 2020 OR jahr2 IS NULL)'), 'oidFields' (z.B. 'id'), 'spatialReference' (mit einem Objekt, das wiederum das Datum 'wkid' mit einem Wert wie 25832 umfasst), und 'type':'queryTable'. Der SQL-Query d\u00fcrfte f\u00fcr Nutzer*innen des Regionalatlas Deutschland weitgehend selbsterkl\u00e4rend sein, wobei man wissen muss dass die Variable *typ* die gew\u00fcnschte regionale Ebene spezifiziert: - 1=Bundesl\u00e4nder, - 2=Regierungsbezirke und Statistische Regionen, - 3=Kreise und kreisfreie St\u00e4dte. G\u00fcltige Eintr\u00e4ge f\u00fcr die *tableName* werden im Folgenden auszugsweise dargestellt (jeweils mit den enthaltenen Variablen/fields) - Bev\u00f6lkerungsdichte: ai002_1_5 - - ai0201: Bev\u00f6lkerungsdichte (EW je qkm) - - ai0202: Bev\u00f6lkerungsentwicklung im Jahr je 10.000 EW - - ai0208: Anteil der ausl\u00e4ndischen Bev\u00f6lkerung an der Gesamtbev\u00f6lkerung - - ai0209: Lebendgeborene je 10.000 EW - - ai0210: Gestorbene je 10.000 EW - - ai0211: Geburten-/Gestorbenen\u00fcberschuss je 10.000 EW - - ai0212: Wanderungssaldo je 10.000 EW - Altersdurchschnitt: ai002_4_5 - - ai0218: Durchschnittsalter der Bev\u00f6lkerung - - ai0219: das Durchschnittsalter der Mutter bei der Geburt des 1. Kindes) - Arbeitslosenquote: ai008_1_5 - - ai0801: Arbeitslosenquote - - ai0806: Anteil Arbeitslose 15-24 Jahre an Arbeitslosen insgesamt - - ai0807: Anteil Arbeitslose 55-64 Jahre an Arbeitslosen insgesamt - - ai0808: Anteil Langzeitarbeitslose an Arbeitslosen insgesamt - - ai0809: Anteil der ausl. Arbeitslosen an Arbeitslosen insgesamt - Verf\u00fcgbares Einkommen je EW: ai_s_01 - SGB-II-Quote: ai_s_04 - BIP je Erwerbst\u00e4tigem: ai017_1 - Wahlergebnisse Bundestagswahl: ai005' (default to \"%7B%22source%22%3A%7B%22dataSource%22%3A%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22workspaceId%22%3A%22gdb%22%2C%22query%22%3A%22SELECT%20*%20FROM%20verwaltungsgrenzen_gesamt%20LEFT%20OUTER%20JOIN%20ai002_1_5%20ON%20ags%20%3D%20ags2%20and%20jahr%20%3D%20jahr2%20WHERE%20typ%20%3D%201%20AND%20jahr%20%3D%202020%20AND%20(jahr2%20%3D%202020%20OR%20jahr2%20IS%20NULL)%22%2C%22oidFields%22%3A%22id%22%2C%22spatialReference%22%3A%7B%22wkid%22%3A25832%7D%2C%22type%22%3A%22queryTable%22%7D%2C%22type%22%3A%22dataLayer%22%7D%7D\")\n f = \"json\" # str | Output-Format (z.B. 'json' oder 'html').\n return_geometry = False # bool | Boolsche Angabe, ob Angaben zur Geometrie gesendet werden sollen (z.B. 'false').\n spatial_rel = \"esriSpatialRelIntersects\" # str | spational relation (z.B. 'esriSpatialRelIntersects').\n where = \"1%3D1\" # str | Spezifikation einer gew\u00fcnschten Teilmenge der Daten (z.B.'1=1'' f\u00fcr alle Daten oder 'ags2 = 'DG' and jahr2 = 2020').\n out_fields = \"*\" # str | Auszugebende Variablen/fields (z.B. '*'). (optional)\n\n try:\n # publicwebpageplus\n api_response = api_instance.query(layer, f, return_geometry, spatial_rel, where, out_fields=out_fields)\n pprint(api_response)\n except Regionalatlas.ApiException as e:\n print(\"Exception when calling DefaultApi->query: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://www.gis-idmz.nrw.de/arcgis/rest/services/stba/regionalatlas/MapServer/dynamicLayer*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**query**](docs/DefaultApi.md#query) | **GET** /query | publicwebpageplus\n\n\n## Documentation For Models\n\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\nkontakt@bund.dev\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in Regionalatlas.apis and Regionalatlas.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from deutschland.Regionalatlas.api.default_api import DefaultApi`\n- `from deutschland.Regionalatlas.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nfrom deutschland import Regionalatlas\nfrom deutschland.Regionalatlas.apis import *\nfrom deutschland.Regionalatlas.models import *\n```\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Regionalatlas-API",
"version": "0.1.0",
"split_keywords": [
"openapi",
"openapi-generator",
"regionalatlas",
"app",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7c9047cfad0d09ce58f15e5d2b5ccf7ef34cb1310788128b1af94fa3af78e7a",
"md5": "0ad4114b33c418e5add1a83f1b061553",
"sha256": "69bfd383ea507361054e707d2f9b48ef419b450453ff0817fc7852a676bf27d7"
},
"downloads": -1,
"filename": "de_regionalatlas-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ad4114b33c418e5add1a83f1b061553",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 45705,
"upload_time": "2023-01-10T19:06:32",
"upload_time_iso_8601": "2023-01-10T19:06:32.078538Z",
"url": "https://files.pythonhosted.org/packages/d7/c9/047cfad0d09ce58f15e5d2b5ccf7ef34cb1310788128b1af94fa3af78e7a/de_regionalatlas-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de202a0c0975bc81ebe8c1724c32c25eb07499fff0585158a5a2b2f75715a3a0",
"md5": "bd8610449e45cf9316e2c70b52a507a5",
"sha256": "d17687da8dea51b3f4caf1d5014b56fc2fcb3102c84a4d11e5c9b42d711196d0"
},
"downloads": -1,
"filename": "de_regionalatlas-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bd8610449e45cf9316e2c70b52a507a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 42284,
"upload_time": "2023-01-10T19:06:33",
"upload_time_iso_8601": "2023-01-10T19:06:33.604500Z",
"url": "https://files.pythonhosted.org/packages/de/20/2a0c0975bc81ebe8c1724c32c25eb07499fff0585158a5a2b2f75715a3a0/de_regionalatlas-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-10 19:06:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "bundesAPI",
"github_project": "regionalatlas-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "de-regionalatlas"
}
JSON
