openapi: 3.0.3 info: title: 'Tekoa API Documentation' description: '' version: 1.0.0 servers: - url: 'https://tekoa.farbcode.net' tags: - name: Basics description: "\nThese endpoints provide basic information about address data by their keys." - name: Utils description: "\nThese endpoints are utility functions for fetching address-related data based on incomplete information, such as a zip code. They are designed to assist in address validation and auto-completion features in forms." components: securitySchemes: default: type: http scheme: bearer description: 'Api Tokens can only be provided by a System Administrator. Please contact your administrator if you need an API token.' security: - default: [] paths: '/api/cities/{key}': get: summary: 'GET city by key' operationId: gETCityByKey description: "The key is NOT the \"AGS\" but a unique key that is used in the address data.\nIt consists of 8 numbers and can contain leading zeros (e.g. '00052500')." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart properties: data: type: object properties: key: type: string example: '58727000' name: type: string example: Stuttgart additional: type: string example: null nullable: true ags: type: string example: '08111000' short_name: type: string example: Stuttgart tags: - Basics security: [] parameters: - in: path name: key description: 'Optional parameter. The unique key of the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '58727000' '/api/cities/{city_key}/districts/{key}': get: summary: 'GET district by keys' operationId: gETDistrictByKeys description: "The city key is a unique key that is used in the address data.\nIt consists of 8 numbers and can contain leading zeros (e.g. '00052500').\n\nThe district key is an additional 3-digit key that is used to identify a\nspecific district within a city. It can also contain leading zeros (e.g. '001')." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: key: '051' name: Vaihingen city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart properties: data: type: object properties: key: type: string example: '051' name: type: string example: Vaihingen city: type: object properties: key: type: string example: '58727000' name: type: string example: Stuttgart additional: type: string example: null nullable: true ags: type: string example: '08111000' short_name: type: string example: Stuttgart tags: - Basics security: [] parameters: - in: path name: city_key description: 'Optional parameter. The unique key of the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '58727000' - in: path name: key description: 'Optional parameter. The additional key of the district within the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '051' '/api/cities/{city_key}/zipAreas/{zip}': get: summary: 'GET zip area by keys' operationId: gETZipAreaByKeys description: "A Zip Area is a specific area defined by a zip code and a city.\nIt is identifiable via a city key and the zip code. Multiple zip areas\ncan share the same zip code but not within the same city." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: zip: '70563' zip_de: 70563 postbox_numbers_from: null postbox_numbers_to: null city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart properties: data: type: object properties: zip: type: string example: '70563' zip_de: type: integer example: 70563 postbox_numbers_from: type: string example: null nullable: true postbox_numbers_to: type: string example: null nullable: true city: type: object properties: key: type: string example: '58727000' name: type: string example: Stuttgart additional: type: string example: null nullable: true ags: type: string example: '08111000' short_name: type: string example: Stuttgart tags: - Basics security: [] parameters: - in: path name: city_key description: 'Optional parameter. The unique key of the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '58727000' - in: path name: zip description: 'Optional parameter. The zip code of the specific zip area.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '70563' '/api/cities/{city_key}/zipAreas/{zipArea_zip}/streets': get: summary: 'GET streets in zip area' operationId: gETStreetsInZipArea description: "This endpoint retrieves all streets associated with a specific zip area within a city.\nIt is used to provide detailed information about the streets in a given zip code,\nwhich can be useful for address validation and auto-completion features in forms." parameters: - in: query name: query description: 'Optional search query to filter streets by name. :Attribute darf maximal 255 Zeichen haben. :Attribute muss mindestens 2 Zeichen lang sein.' example: meitnerstrasse required: false schema: type: string description: 'Optional search query to filter streets by name. :Attribute darf maximal 255 Zeichen haben. :Attribute muss mindestens 2 Zeichen lang sein.' example: meitnerstrasse nullable: true - in: query name: limit description: 'Optional limit for the number of streets returned. :Attribute muss mindestens 1 sein.' example: 10 required: false schema: type: integer description: 'Optional limit for the number of streets returned. :Attribute muss mindestens 1 sein.' example: 10 nullable: true responses: 200: description: '' content: application/json: schema: type: object example: data: - key: '07439100004' name: Meitnerstr. short_name: Meitnerstr. properties: data: type: array example: - key: '07439100004' name: Meitnerstr. short_name: Meitnerstr. items: type: object properties: key: type: string example: '07439100004' name: type: string example: Meitnerstr. short_name: type: string example: Meitnerstr. tags: - Basics security: [] parameters: - in: path name: city_key description: 'Optional parameter. The unique key of the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '58727000' - in: path name: zipArea_zip description: 'Optional parameter. The zip code of the specific zip area.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '70563' '/api/cities/{city_key}/zipAreas/{zipArea_zip}/streets/{key}': get: summary: 'GET street by keys' operationId: gETStreetByKeys description: 'This endpoint retrieves a specific street based on its unique identifier (key) within a zip area and city.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: key: '07439100004' name: Meitnerstr. short_name: Meitnerstr. city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart zip: zip: '70563' zip_de: 70563 postbox_numbers_from: null postbox_numbers_to: null properties: data: type: object properties: key: type: string example: '07439100004' name: type: string example: Meitnerstr. short_name: type: string example: Meitnerstr. city: type: object properties: key: type: string example: '58727000' name: type: string example: Stuttgart additional: type: string example: null nullable: true ags: type: string example: '08111000' short_name: type: string example: Stuttgart zip: type: object properties: zip: type: string example: '70563' zip_de: type: integer example: 70563 postbox_numbers_from: type: string example: null nullable: true postbox_numbers_to: type: string example: null nullable: true tags: - Basics security: [] parameters: - in: path name: city_key description: 'Optional parameter. The unique key of the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '58727000' - in: path name: zipArea_zip description: 'Optional parameter. The zip code of the specific zip area.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '70563' - in: path name: key description: 'Optional parameter. The unique key of the street.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '07439100004' '/api/utils/cities/{city_key}/zipAreas/{zipArea_zip}/postboxes/check': post: summary: 'POST check postbox validity' operationId: pOSTCheckPostboxValidity description: "Checks the validity of a postbox number for a given zip area.\nIf the zip area has no postboxes defined, all numbers are considered valid.\nOtherwise, the provided number must fall within the range of at least one defined\npostbox range for the zip area to be considered valid." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: valid: true properties: valid: type: boolean example: true tags: - Utils requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: 'The postbox number to check.' example: '700111' required: - number security: [] parameters: - in: path name: city_key description: 'Optional parameter. The unique key of the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '58727000' - in: path name: zipArea_zip description: 'Optional parameter. The zip code of the specific zip area.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '70571' '/api/utils/cities/{city_key}/zipAreas/{zipArea_zip}/streets/{street_key}/numbers/check': post: summary: 'POST check house number validity' operationId: pOSTCheckHouseNumberValidity description: "Checks the validity of a house number for a given street.\nThe house number is valid if it falls within the range of\nthe street's house numbers and matches the parity (odd/even) of the type." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: valid: true district: Vaihingen district_key: '051' properties: valid: type: boolean example: true district: type: string example: Vaihingen district_key: type: string example: '051' tags: - Utils requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: 'The house number to check.' example: '10' required: - number security: [] parameters: - in: path name: city_key description: 'Optional parameter. The unique key of the city.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '58727000' - in: path name: zipArea_zip description: 'Optional parameter. The zip code of the specific zip area.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '70563' - in: path name: street_key description: 'Optional parameter. The unique key of the street.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '07439100004' '/api/utils/zipCodes/{zipCode}/zipAreas': get: summary: 'GET suggested zip areas' operationId: gETSuggestedZipAreas description: "This endpoint is used to retrieve all relevant information for a given zip code, which can be used for address validation and auto-completion in forms.\nThe response includes the zip area details, associated streets, postboxes, and city information.\n\nThe data is cached for 24 hours to improve performance for frequently requested zip codes." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: - zip: '70563' zip_de: 70563 postbox_numbers_from: null postbox_numbers_to: null city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart streets: - key: '00046000005' name: Ackermannstr. short_name: Ackermannstr. - key: '00110200002' name: Albblick short_name: Albblick - key: '00126600001' name: Albigenserweg short_name: Albigenserweg - key: '00165700003' name: Allmandstr. short_name: Allmandstr. - key: '00176000009' name: Alpenrosenstr. short_name: Alpenrosenstr. - key: '00446900001' name: 'Am Feldrand' short_name: 'Am Feldrand' - key: '00440100001' name: 'Am Föhrenwald' short_name: 'Am Föhrenwald' - key: '00585000001' name: 'Am Hopfenrain' short_name: 'Am Hopfenrain' - key: '01002100004' name: 'Am Wallgraben' short_name: 'Am Wallgraben' - key: '01055200001' name: Amadeusweg short_name: Amadeusweg - key: '01070700147' name: Amselweg short_name: Amselweg - key: '01306300001' name: 'Anweiler Weg' short_name: 'Anweiler Weg' - key: '01593100126' name: Bachstr. short_name: Bachstr. - key: '01616300001' name: 'Bahnhof Vaihingen' short_name: 'Bahnhof Vaihingen' - key: '01672100004' name: Bassermannstr. short_name: Bassermannstr. - key: '01763300001' name: 'Beim Römerhaus' short_name: 'Beim Römerhaus' - key: '01828000001' name: Bergnelkenstr. short_name: Bergnelkenstr. - key: '01879100001' name: Betzweilerstr. short_name: Betzweilerstr. - key: '01957600005' name: Bischoffstr. short_name: Bischoffstr. - key: '02012500001' name: Blümleweg short_name: Blümleweg - key: '02209500001' name: Brommerstr. short_name: Brommerstr. - key: '02261500026' name: Brühlstr. short_name: Brühlstr. - key: '02276900018' name: Buchfinkenweg short_name: Buchfinkenweg - key: '02400500001' name: 'Büsnauer Str.' short_name: 'Büsnauer Str.' - key: '02456200002' name: Champignystr. short_name: Champignystr. - key: '02535100012' name: Curiestr. short_name: Curiestr. - key: '02644900002' name: Demetriusweg short_name: Demetriusweg - key: '02753000003' name: Don-Carlos-Str. short_name: Don-Carlos-Str. - key: '02551900004' name: Döringstr. short_name: Döringstr. - key: '02857100136' name: Drosselweg short_name: Drosselweg - key: '02872600001' name: Dumontweg short_name: Dumontweg - key: '02878600001' name: Dusestr. short_name: Dusestr. - key: '02971100001' name: Egmontweg short_name: Egmontweg - key: '03030200001' name: Eisbärenstr. short_name: Eisbärenstr. - key: '03111200025' name: Emilienstr. short_name: Emilienstr. - key: '03128000013' name: 'Enge Str.' short_name: 'Enge Str.' - key: '03175400001' name: Erich-Ponto-Weg short_name: Erich-Ponto-Weg - key: '03189600004' name: Erlkönigstr. short_name: Erlkönigstr. - key: '03205600001' name: Ernst-Kachel-Str. short_name: Ernst-Kachel-Str. - key: '03320500001' name: Fanny-Leicht-Str. short_name: Fanny-Leicht-Str. - key: '03333100008' name: Fauststr. short_name: Fauststr. - key: '03361500001' name: 'Felldorfer Str.' short_name: 'Felldorfer Str.' - key: '03396800001' name: Filderhofstr. short_name: Filderhofstr. - key: '03457200001' name: Florathweg short_name: Florathweg - key: '03552600005' name: Freibadstr. short_name: Freibadstr. - key: '03563900001' name: Fremdstr. short_name: Fremdstr. - key: '03577700002' name: Friedemannweg short_name: Friedemannweg - key: '03673100018' name: Fuggerstr. short_name: Fuggerstr. - key: '03762700202' name: Gartenstr. short_name: Gartenstr. - key: '03804500001' name: Geiwitzstr. short_name: Geiwitzstr. - key: '03866600018' name: Germanenstr. short_name: Germanenstr. - key: '03908600001' name: Giesekingstr. short_name: Giesekingstr. - key: '03943800002' name: Glockenblumenstr. short_name: Glockenblumenstr. - key: '41230300002' name: Gropiusplatz short_name: Gropiusplatz - key: '04172700002' name: Gründgensstr. short_name: Gründgensstr. - key: '04185400001' name: 'Grüntaler Weg' short_name: 'Grüntaler Weg' - key: '04248900003' name: 'Gültsteiner Str.' short_name: 'Gültsteiner Str.' - key: '04328000002' name: Haeberlinstr. short_name: Haeberlinstr. - key: '05176600006' name: Häfnerstr. short_name: Häfnerstr. - key: '04355600004' name: Hahnenweg short_name: Hahnenweg - key: '04373300001' name: 'Halde, Gewann' short_name: 'Halde, Gewann' - key: '04395500002' name: Hamletstr. short_name: Hamletstr. - key: '04524300001' name: Haugstr. short_name: Haugstr. - key: '04529200139' name: Hauptstr. short_name: Hauptstr. - key: '04575100026' name: Heerstr. short_name: Heerstr. - key: '04808500004' name: 'Herrenberger Str.' short_name: 'Herrenberger Str.' - key: '04271700001' name: Höhenrandstr. short_name: Höhenrandstr. - key: '05040300001' name: Holderbuschweg short_name: Holderbuschweg - key: '05065100092' name: Holunderweg short_name: Holunderweg - key: '05070700006' name: 'Holzhauser Str.' short_name: 'Holzhauser Str.' - key: '05086300001' name: Honigwiesenstr. short_name: Honigwiesenstr. - key: '05090400001' name: 'Hopfauer Str.' short_name: 'Hopfauer Str.' - key: '05132000001' name: Huckebeinweg short_name: Huckebeinweg - key: '05222900008' name: Ifflandstr. short_name: Ifflandstr. - key: '05303800003' name: 'Im Finkenschlag' short_name: 'Im Finkenschlag' - key: '05361200001' name: 'Im Johannesgraben' short_name: 'Im Johannesgraben' - key: '05468200001' name: 'Im Sommerwind' short_name: 'Im Sommerwind' - key: '05475100001' name: 'Im Steinengarten' short_name: 'Im Steinengarten' - key: '05595200001' name: 'In der Lüsse' short_name: 'In der Lüsse' - key: '05694100001' name: Janningsstr. short_name: Janningsstr. - key: '05885600001' name: Kainzweg short_name: Kainzweg - key: '05911200001' name: 'Kaltentaler Str.' short_name: 'Kaltentaler Str.' - key: '06047000001' name: Katzenbachstr. short_name: Katzenbachstr. - key: '06076900001' name: Kelterberg short_name: Kelterberg - key: '06175200001' name: Klöpferweg short_name: Klöpferweg - key: '06471400001' name: Koppenhöferweg short_name: Koppenhöferweg - key: '06529800001' name: Krehlstr. short_name: Krehlstr. - key: '06552600092' name: Kreuzstr. short_name: Kreuzstr. - key: '06633400001' name: 'Kuppinger Str.' short_name: 'Kuppinger Str.' - key: '06957500002' name: Liasweg short_name: Liasweg - key: '07005000162' name: Lindenstr. short_name: Lindenstr. - key: '07072000001' name: 'Lombacher Str.' short_name: 'Lombacher Str.' - key: '07077800002' name: Loosweg short_name: Loosweg - key: '07084400001' name: 'Loßburger Str.' short_name: 'Loßburger Str.' - key: '07147600003' name: Lutherweg short_name: Lutherweg - key: '07149700001' name: Lutzweg short_name: Lutzweg - key: '07259500025' name: Malvenweg short_name: Malvenweg - key: '07283200009' name: Margueritenweg short_name: Margueritenweg - key: '07294700001' name: Marienau short_name: Marienau - key: '07439100004' name: Meitnerstr. short_name: Meitnerstr. - key: '07496200001' name: Mezgerstr. short_name: Mezgerstr. - key: '07541500001' name: Mitterwurzerstr. short_name: Mitterwurzerstr. - key: '07197900001' name: 'Möhringer Landstr.' short_name: 'Möhringer Landstr.' - key: '07213700001' name: Mößnerstr. short_name: Mößnerstr. - key: '07710300001' name: Nathanstr. short_name: Nathanstr. - key: '07744400002' name: Nestroyweg short_name: Nestroyweg - key: '07912700001' name: 'Nufringer Str.' short_name: 'Nufringer Str.' - key: '07970400001' name: 'Oberer Grundweg' short_name: 'Oberer Grundweg' - key: '58483500001' name: Oscar-Schopp-Weg short_name: Oscar-Schopp-Weg - key: '09110500001' name: 'Österfeld, Gewann' short_name: 'Österfeld, Gewann' - key: '09110600001' name: Österfeldstr. short_name: Österfeldstr. - key: '08154900002' name: Othellostr. short_name: Othellostr. - key: '08233200003' name: Paradiesplatz short_name: Paradiesplatz - key: '08233300011' name: Paradiesstr. short_name: Paradiesstr. - key: '08315400119' name: Pestalozzistr. short_name: Pestalozzistr. - key: '08371600004' name: Pfarrhausstr. short_name: Pfarrhausstr. - key: '08374600010' name: Pfauenstr. short_name: Pfauenstr. - key: '08642000007' name: Raimundstr. short_name: Raimundstr. - key: '08668100040' name: Rathausplatz short_name: Rathausplatz - key: '08807200001' name: 'Rexinger Weg' short_name: 'Rexinger Weg' - key: '08905500121' name: Robert-Koch-Str. short_name: Robert-Koch-Str. - key: '08906400001' name: Robert-Leicht-Str. short_name: Robert-Leicht-Str. - key: '08985800005' name: Rosentalstr. short_name: Rosentalstr. - key: '09024200008' name: 'Rottweiler Str.' short_name: 'Rottweiler Str.' - key: '09213500002' name: Sauerweg short_name: Sauerweg - key: '09244700002' name: Schaberweg short_name: Schaberweg - key: '09580200001' name: Schädleweg short_name: Schädleweg - key: '31672300006' name: Schafsgasse short_name: Schafsgasse - key: '09273700001' name: Scharrstr. short_name: Scharrstr. - key: '09318900001' name: Schexweg short_name: Schexweg - key: '09329200001' name: Schießmauerstr. short_name: Schießmauerstr. - key: '09342200001' name: Schillerpassage short_name: Schillerpassage - key: '09476100002' name: 'Schopflocher Str.' short_name: 'Schopflocher Str.' - key: '46463700001' name: Schwabenplatz short_name: Schwabenplatz - key: '09553700002' name: Schwarzäckerstr. short_name: Schwarzäckerstr. - key: '09566100003' name: 'Schwenninger Str.' short_name: 'Schwenninger Str.' - key: '09631400005' name: Seerosenstr. short_name: Seerosenstr. - key: '09703900028' name: Siedlerstr. short_name: Siedlerstr. - key: '09730400001' name: Sigmundtstr. short_name: Sigmundtstr. - key: '32850700005' name: Sommerfeldweg short_name: Sommerfeldweg - key: '09806900001' name: Sormaweg short_name: Sormaweg - key: '10016100001' name: Stellaweg short_name: Stellaweg - key: '10035100001' name: 'Sternecker Str.' short_name: 'Sternecker Str.' - key: '10059200010' name: 'Stiller Winkel' short_name: 'Stiller Winkel' - key: '10087400001' name: Stoßäckerstr. short_name: Stoßäckerstr. - key: '10197000001' name: 'Sulzauer Str.' short_name: 'Sulzauer Str.' - key: '10217400003' name: Syringenweg short_name: Syringenweg - key: '10390900002' name: Tigerstr. short_name: Tigerstr. - key: '10604000001' name: 'Unterer Grund' short_name: 'Unterer Grund' - key: '10659200001' name: 'Vaihinger Markt' short_name: 'Vaihinger Markt' - key: '10676300074' name: Veilchenweg short_name: Veilchenweg - key: '10731100004' name: Vischerstr. short_name: Vischerstr. - key: '10762000001' name: Vollmoellerstr. short_name: Vollmoellerstr. - key: '10893000003' name: Waldburgstr. short_name: Waldburgstr. - key: '10938900001' name: Walter-Heller-Str. short_name: Walter-Heller-Str. - key: '10959100025' name: Wankelstr. short_name: Wankelstr. - key: '11020000001' name: Wegländerstr. short_name: Wegländerstr. - key: '11403400001' name: Wolfmahdenstr. short_name: Wolfmahdenstr. - key: '10861600049' name: Wörthstr. short_name: Wörthstr. - key: '11519000010' name: Zilleweg short_name: Zilleweg - key: '11550100004' name: 'Zu den Tannen' short_name: 'Zu den Tannen' - key: '11608800001' name: 'Zum Lauchwald' short_name: 'Zum Lauchwald' - key: '11716200003' name: Zürnstr. short_name: Zürnstr. postboxes: [] properties: data: type: array example: - zip: '70563' zip_de: 70563 postbox_numbers_from: null postbox_numbers_to: null city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart streets: - key: '00046000005' name: Ackermannstr. short_name: Ackermannstr. - key: '00110200002' name: Albblick short_name: Albblick - key: '00126600001' name: Albigenserweg short_name: Albigenserweg - key: '00165700003' name: Allmandstr. short_name: Allmandstr. - key: '00176000009' name: Alpenrosenstr. short_name: Alpenrosenstr. - key: '00446900001' name: 'Am Feldrand' short_name: 'Am Feldrand' - key: '00440100001' name: 'Am Föhrenwald' short_name: 'Am Föhrenwald' - key: '00585000001' name: 'Am Hopfenrain' short_name: 'Am Hopfenrain' - key: '01002100004' name: 'Am Wallgraben' short_name: 'Am Wallgraben' - key: '01055200001' name: Amadeusweg short_name: Amadeusweg - key: '01070700147' name: Amselweg short_name: Amselweg - key: '01306300001' name: 'Anweiler Weg' short_name: 'Anweiler Weg' - key: '01593100126' name: Bachstr. short_name: Bachstr. - key: '01616300001' name: 'Bahnhof Vaihingen' short_name: 'Bahnhof Vaihingen' - key: '01672100004' name: Bassermannstr. short_name: Bassermannstr. - key: '01763300001' name: 'Beim Römerhaus' short_name: 'Beim Römerhaus' - key: '01828000001' name: Bergnelkenstr. short_name: Bergnelkenstr. - key: '01879100001' name: Betzweilerstr. short_name: Betzweilerstr. - key: '01957600005' name: Bischoffstr. short_name: Bischoffstr. - key: '02012500001' name: Blümleweg short_name: Blümleweg - key: '02209500001' name: Brommerstr. short_name: Brommerstr. - key: '02261500026' name: Brühlstr. short_name: Brühlstr. - key: '02276900018' name: Buchfinkenweg short_name: Buchfinkenweg - key: '02400500001' name: 'Büsnauer Str.' short_name: 'Büsnauer Str.' - key: '02456200002' name: Champignystr. short_name: Champignystr. - key: '02535100012' name: Curiestr. short_name: Curiestr. - key: '02644900002' name: Demetriusweg short_name: Demetriusweg - key: '02753000003' name: Don-Carlos-Str. short_name: Don-Carlos-Str. - key: '02551900004' name: Döringstr. short_name: Döringstr. - key: '02857100136' name: Drosselweg short_name: Drosselweg - key: '02872600001' name: Dumontweg short_name: Dumontweg - key: '02878600001' name: Dusestr. short_name: Dusestr. - key: '02971100001' name: Egmontweg short_name: Egmontweg - key: '03030200001' name: Eisbärenstr. short_name: Eisbärenstr. - key: '03111200025' name: Emilienstr. short_name: Emilienstr. - key: '03128000013' name: 'Enge Str.' short_name: 'Enge Str.' - key: '03175400001' name: Erich-Ponto-Weg short_name: Erich-Ponto-Weg - key: '03189600004' name: Erlkönigstr. short_name: Erlkönigstr. - key: '03205600001' name: Ernst-Kachel-Str. short_name: Ernst-Kachel-Str. - key: '03320500001' name: Fanny-Leicht-Str. short_name: Fanny-Leicht-Str. - key: '03333100008' name: Fauststr. short_name: Fauststr. - key: '03361500001' name: 'Felldorfer Str.' short_name: 'Felldorfer Str.' - key: '03396800001' name: Filderhofstr. short_name: Filderhofstr. - key: '03457200001' name: Florathweg short_name: Florathweg - key: '03552600005' name: Freibadstr. short_name: Freibadstr. - key: '03563900001' name: Fremdstr. short_name: Fremdstr. - key: '03577700002' name: Friedemannweg short_name: Friedemannweg - key: '03673100018' name: Fuggerstr. short_name: Fuggerstr. - key: '03762700202' name: Gartenstr. short_name: Gartenstr. - key: '03804500001' name: Geiwitzstr. short_name: Geiwitzstr. - key: '03866600018' name: Germanenstr. short_name: Germanenstr. - key: '03908600001' name: Giesekingstr. short_name: Giesekingstr. - key: '03943800002' name: Glockenblumenstr. short_name: Glockenblumenstr. - key: '41230300002' name: Gropiusplatz short_name: Gropiusplatz - key: '04172700002' name: Gründgensstr. short_name: Gründgensstr. - key: '04185400001' name: 'Grüntaler Weg' short_name: 'Grüntaler Weg' - key: '04248900003' name: 'Gültsteiner Str.' short_name: 'Gültsteiner Str.' - key: '04328000002' name: Haeberlinstr. short_name: Haeberlinstr. - key: '05176600006' name: Häfnerstr. short_name: Häfnerstr. - key: '04355600004' name: Hahnenweg short_name: Hahnenweg - key: '04373300001' name: 'Halde, Gewann' short_name: 'Halde, Gewann' - key: '04395500002' name: Hamletstr. short_name: Hamletstr. - key: '04524300001' name: Haugstr. short_name: Haugstr. - key: '04529200139' name: Hauptstr. short_name: Hauptstr. - key: '04575100026' name: Heerstr. short_name: Heerstr. - key: '04808500004' name: 'Herrenberger Str.' short_name: 'Herrenberger Str.' - key: '04271700001' name: Höhenrandstr. short_name: Höhenrandstr. - key: '05040300001' name: Holderbuschweg short_name: Holderbuschweg - key: '05065100092' name: Holunderweg short_name: Holunderweg - key: '05070700006' name: 'Holzhauser Str.' short_name: 'Holzhauser Str.' - key: '05086300001' name: Honigwiesenstr. short_name: Honigwiesenstr. - key: '05090400001' name: 'Hopfauer Str.' short_name: 'Hopfauer Str.' - key: '05132000001' name: Huckebeinweg short_name: Huckebeinweg - key: '05222900008' name: Ifflandstr. short_name: Ifflandstr. - key: '05303800003' name: 'Im Finkenschlag' short_name: 'Im Finkenschlag' - key: '05361200001' name: 'Im Johannesgraben' short_name: 'Im Johannesgraben' - key: '05468200001' name: 'Im Sommerwind' short_name: 'Im Sommerwind' - key: '05475100001' name: 'Im Steinengarten' short_name: 'Im Steinengarten' - key: '05595200001' name: 'In der Lüsse' short_name: 'In der Lüsse' - key: '05694100001' name: Janningsstr. short_name: Janningsstr. - key: '05885600001' name: Kainzweg short_name: Kainzweg - key: '05911200001' name: 'Kaltentaler Str.' short_name: 'Kaltentaler Str.' - key: '06047000001' name: Katzenbachstr. short_name: Katzenbachstr. - key: '06076900001' name: Kelterberg short_name: Kelterberg - key: '06175200001' name: Klöpferweg short_name: Klöpferweg - key: '06471400001' name: Koppenhöferweg short_name: Koppenhöferweg - key: '06529800001' name: Krehlstr. short_name: Krehlstr. - key: '06552600092' name: Kreuzstr. short_name: Kreuzstr. - key: '06633400001' name: 'Kuppinger Str.' short_name: 'Kuppinger Str.' - key: '06957500002' name: Liasweg short_name: Liasweg - key: '07005000162' name: Lindenstr. short_name: Lindenstr. - key: '07072000001' name: 'Lombacher Str.' short_name: 'Lombacher Str.' - key: '07077800002' name: Loosweg short_name: Loosweg - key: '07084400001' name: 'Loßburger Str.' short_name: 'Loßburger Str.' - key: '07147600003' name: Lutherweg short_name: Lutherweg - key: '07149700001' name: Lutzweg short_name: Lutzweg - key: '07259500025' name: Malvenweg short_name: Malvenweg - key: '07283200009' name: Margueritenweg short_name: Margueritenweg - key: '07294700001' name: Marienau short_name: Marienau - key: '07439100004' name: Meitnerstr. short_name: Meitnerstr. - key: '07496200001' name: Mezgerstr. short_name: Mezgerstr. - key: '07541500001' name: Mitterwurzerstr. short_name: Mitterwurzerstr. - key: '07197900001' name: 'Möhringer Landstr.' short_name: 'Möhringer Landstr.' - key: '07213700001' name: Mößnerstr. short_name: Mößnerstr. - key: '07710300001' name: Nathanstr. short_name: Nathanstr. - key: '07744400002' name: Nestroyweg short_name: Nestroyweg - key: '07912700001' name: 'Nufringer Str.' short_name: 'Nufringer Str.' - key: '07970400001' name: 'Oberer Grundweg' short_name: 'Oberer Grundweg' - key: '58483500001' name: Oscar-Schopp-Weg short_name: Oscar-Schopp-Weg - key: '09110500001' name: 'Österfeld, Gewann' short_name: 'Österfeld, Gewann' - key: '09110600001' name: Österfeldstr. short_name: Österfeldstr. - key: '08154900002' name: Othellostr. short_name: Othellostr. - key: '08233200003' name: Paradiesplatz short_name: Paradiesplatz - key: '08233300011' name: Paradiesstr. short_name: Paradiesstr. - key: '08315400119' name: Pestalozzistr. short_name: Pestalozzistr. - key: '08371600004' name: Pfarrhausstr. short_name: Pfarrhausstr. - key: '08374600010' name: Pfauenstr. short_name: Pfauenstr. - key: '08642000007' name: Raimundstr. short_name: Raimundstr. - key: '08668100040' name: Rathausplatz short_name: Rathausplatz - key: '08807200001' name: 'Rexinger Weg' short_name: 'Rexinger Weg' - key: '08905500121' name: Robert-Koch-Str. short_name: Robert-Koch-Str. - key: '08906400001' name: Robert-Leicht-Str. short_name: Robert-Leicht-Str. - key: '08985800005' name: Rosentalstr. short_name: Rosentalstr. - key: '09024200008' name: 'Rottweiler Str.' short_name: 'Rottweiler Str.' - key: '09213500002' name: Sauerweg short_name: Sauerweg - key: '09244700002' name: Schaberweg short_name: Schaberweg - key: '09580200001' name: Schädleweg short_name: Schädleweg - key: '31672300006' name: Schafsgasse short_name: Schafsgasse - key: '09273700001' name: Scharrstr. short_name: Scharrstr. - key: '09318900001' name: Schexweg short_name: Schexweg - key: '09329200001' name: Schießmauerstr. short_name: Schießmauerstr. - key: '09342200001' name: Schillerpassage short_name: Schillerpassage - key: '09476100002' name: 'Schopflocher Str.' short_name: 'Schopflocher Str.' - key: '46463700001' name: Schwabenplatz short_name: Schwabenplatz - key: '09553700002' name: Schwarzäckerstr. short_name: Schwarzäckerstr. - key: '09566100003' name: 'Schwenninger Str.' short_name: 'Schwenninger Str.' - key: '09631400005' name: Seerosenstr. short_name: Seerosenstr. - key: '09703900028' name: Siedlerstr. short_name: Siedlerstr. - key: '09730400001' name: Sigmundtstr. short_name: Sigmundtstr. - key: '32850700005' name: Sommerfeldweg short_name: Sommerfeldweg - key: '09806900001' name: Sormaweg short_name: Sormaweg - key: '10016100001' name: Stellaweg short_name: Stellaweg - key: '10035100001' name: 'Sternecker Str.' short_name: 'Sternecker Str.' - key: '10059200010' name: 'Stiller Winkel' short_name: 'Stiller Winkel' - key: '10087400001' name: Stoßäckerstr. short_name: Stoßäckerstr. - key: '10197000001' name: 'Sulzauer Str.' short_name: 'Sulzauer Str.' - key: '10217400003' name: Syringenweg short_name: Syringenweg - key: '10390900002' name: Tigerstr. short_name: Tigerstr. - key: '10604000001' name: 'Unterer Grund' short_name: 'Unterer Grund' - key: '10659200001' name: 'Vaihinger Markt' short_name: 'Vaihinger Markt' - key: '10676300074' name: Veilchenweg short_name: Veilchenweg - key: '10731100004' name: Vischerstr. short_name: Vischerstr. - key: '10762000001' name: Vollmoellerstr. short_name: Vollmoellerstr. - key: '10893000003' name: Waldburgstr. short_name: Waldburgstr. - key: '10938900001' name: Walter-Heller-Str. short_name: Walter-Heller-Str. - key: '10959100025' name: Wankelstr. short_name: Wankelstr. - key: '11020000001' name: Wegländerstr. short_name: Wegländerstr. - key: '11403400001' name: Wolfmahdenstr. short_name: Wolfmahdenstr. - key: '10861600049' name: Wörthstr. short_name: Wörthstr. - key: '11519000010' name: Zilleweg short_name: Zilleweg - key: '11550100004' name: 'Zu den Tannen' short_name: 'Zu den Tannen' - key: '11608800001' name: 'Zum Lauchwald' short_name: 'Zum Lauchwald' - key: '11716200003' name: Zürnstr. short_name: Zürnstr. postboxes: [] items: type: object properties: zip: type: string example: '70563' zip_de: type: integer example: 70563 postbox_numbers_from: type: string example: null nullable: true postbox_numbers_to: type: string example: null nullable: true city: type: object properties: key: type: string example: '58727000' name: type: string example: Stuttgart additional: type: string example: null nullable: true ags: type: string example: '08111000' short_name: type: string example: Stuttgart streets: type: array example: - key: '00046000005' name: Ackermannstr. short_name: Ackermannstr. - key: '00110200002' name: Albblick short_name: Albblick - key: '00126600001' name: Albigenserweg short_name: Albigenserweg - key: '00165700003' name: Allmandstr. short_name: Allmandstr. - key: '00176000009' name: Alpenrosenstr. short_name: Alpenrosenstr. - key: '00446900001' name: 'Am Feldrand' short_name: 'Am Feldrand' - key: '00440100001' name: 'Am Föhrenwald' short_name: 'Am Föhrenwald' - key: '00585000001' name: 'Am Hopfenrain' short_name: 'Am Hopfenrain' - key: '01002100004' name: 'Am Wallgraben' short_name: 'Am Wallgraben' - key: '01055200001' name: Amadeusweg short_name: Amadeusweg - key: '01070700147' name: Amselweg short_name: Amselweg - key: '01306300001' name: 'Anweiler Weg' short_name: 'Anweiler Weg' - key: '01593100126' name: Bachstr. short_name: Bachstr. - key: '01616300001' name: 'Bahnhof Vaihingen' short_name: 'Bahnhof Vaihingen' - key: '01672100004' name: Bassermannstr. short_name: Bassermannstr. - key: '01763300001' name: 'Beim Römerhaus' short_name: 'Beim Römerhaus' - key: '01828000001' name: Bergnelkenstr. short_name: Bergnelkenstr. - key: '01879100001' name: Betzweilerstr. short_name: Betzweilerstr. - key: '01957600005' name: Bischoffstr. short_name: Bischoffstr. - key: '02012500001' name: Blümleweg short_name: Blümleweg - key: '02209500001' name: Brommerstr. short_name: Brommerstr. - key: '02261500026' name: Brühlstr. short_name: Brühlstr. - key: '02276900018' name: Buchfinkenweg short_name: Buchfinkenweg - key: '02400500001' name: 'Büsnauer Str.' short_name: 'Büsnauer Str.' - key: '02456200002' name: Champignystr. short_name: Champignystr. - key: '02535100012' name: Curiestr. short_name: Curiestr. - key: '02644900002' name: Demetriusweg short_name: Demetriusweg - key: '02753000003' name: Don-Carlos-Str. short_name: Don-Carlos-Str. - key: '02551900004' name: Döringstr. short_name: Döringstr. - key: '02857100136' name: Drosselweg short_name: Drosselweg - key: '02872600001' name: Dumontweg short_name: Dumontweg - key: '02878600001' name: Dusestr. short_name: Dusestr. - key: '02971100001' name: Egmontweg short_name: Egmontweg - key: '03030200001' name: Eisbärenstr. short_name: Eisbärenstr. - key: '03111200025' name: Emilienstr. short_name: Emilienstr. - key: '03128000013' name: 'Enge Str.' short_name: 'Enge Str.' - key: '03175400001' name: Erich-Ponto-Weg short_name: Erich-Ponto-Weg - key: '03189600004' name: Erlkönigstr. short_name: Erlkönigstr. - key: '03205600001' name: Ernst-Kachel-Str. short_name: Ernst-Kachel-Str. - key: '03320500001' name: Fanny-Leicht-Str. short_name: Fanny-Leicht-Str. - key: '03333100008' name: Fauststr. short_name: Fauststr. - key: '03361500001' name: 'Felldorfer Str.' short_name: 'Felldorfer Str.' - key: '03396800001' name: Filderhofstr. short_name: Filderhofstr. - key: '03457200001' name: Florathweg short_name: Florathweg - key: '03552600005' name: Freibadstr. short_name: Freibadstr. - key: '03563900001' name: Fremdstr. short_name: Fremdstr. - key: '03577700002' name: Friedemannweg short_name: Friedemannweg - key: '03673100018' name: Fuggerstr. short_name: Fuggerstr. - key: '03762700202' name: Gartenstr. short_name: Gartenstr. - key: '03804500001' name: Geiwitzstr. short_name: Geiwitzstr. - key: '03866600018' name: Germanenstr. short_name: Germanenstr. - key: '03908600001' name: Giesekingstr. short_name: Giesekingstr. - key: '03943800002' name: Glockenblumenstr. short_name: Glockenblumenstr. - key: '41230300002' name: Gropiusplatz short_name: Gropiusplatz - key: '04172700002' name: Gründgensstr. short_name: Gründgensstr. - key: '04185400001' name: 'Grüntaler Weg' short_name: 'Grüntaler Weg' - key: '04248900003' name: 'Gültsteiner Str.' short_name: 'Gültsteiner Str.' - key: '04328000002' name: Haeberlinstr. short_name: Haeberlinstr. - key: '05176600006' name: Häfnerstr. short_name: Häfnerstr. - key: '04355600004' name: Hahnenweg short_name: Hahnenweg - key: '04373300001' name: 'Halde, Gewann' short_name: 'Halde, Gewann' - key: '04395500002' name: Hamletstr. short_name: Hamletstr. - key: '04524300001' name: Haugstr. short_name: Haugstr. - key: '04529200139' name: Hauptstr. short_name: Hauptstr. - key: '04575100026' name: Heerstr. short_name: Heerstr. - key: '04808500004' name: 'Herrenberger Str.' short_name: 'Herrenberger Str.' - key: '04271700001' name: Höhenrandstr. short_name: Höhenrandstr. - key: '05040300001' name: Holderbuschweg short_name: Holderbuschweg - key: '05065100092' name: Holunderweg short_name: Holunderweg - key: '05070700006' name: 'Holzhauser Str.' short_name: 'Holzhauser Str.' - key: '05086300001' name: Honigwiesenstr. short_name: Honigwiesenstr. - key: '05090400001' name: 'Hopfauer Str.' short_name: 'Hopfauer Str.' - key: '05132000001' name: Huckebeinweg short_name: Huckebeinweg - key: '05222900008' name: Ifflandstr. short_name: Ifflandstr. - key: '05303800003' name: 'Im Finkenschlag' short_name: 'Im Finkenschlag' - key: '05361200001' name: 'Im Johannesgraben' short_name: 'Im Johannesgraben' - key: '05468200001' name: 'Im Sommerwind' short_name: 'Im Sommerwind' - key: '05475100001' name: 'Im Steinengarten' short_name: 'Im Steinengarten' - key: '05595200001' name: 'In der Lüsse' short_name: 'In der Lüsse' - key: '05694100001' name: Janningsstr. short_name: Janningsstr. - key: '05885600001' name: Kainzweg short_name: Kainzweg - key: '05911200001' name: 'Kaltentaler Str.' short_name: 'Kaltentaler Str.' - key: '06047000001' name: Katzenbachstr. short_name: Katzenbachstr. - key: '06076900001' name: Kelterberg short_name: Kelterberg - key: '06175200001' name: Klöpferweg short_name: Klöpferweg - key: '06471400001' name: Koppenhöferweg short_name: Koppenhöferweg - key: '06529800001' name: Krehlstr. short_name: Krehlstr. - key: '06552600092' name: Kreuzstr. short_name: Kreuzstr. - key: '06633400001' name: 'Kuppinger Str.' short_name: 'Kuppinger Str.' - key: '06957500002' name: Liasweg short_name: Liasweg - key: '07005000162' name: Lindenstr. short_name: Lindenstr. - key: '07072000001' name: 'Lombacher Str.' short_name: 'Lombacher Str.' - key: '07077800002' name: Loosweg short_name: Loosweg - key: '07084400001' name: 'Loßburger Str.' short_name: 'Loßburger Str.' - key: '07147600003' name: Lutherweg short_name: Lutherweg - key: '07149700001' name: Lutzweg short_name: Lutzweg - key: '07259500025' name: Malvenweg short_name: Malvenweg - key: '07283200009' name: Margueritenweg short_name: Margueritenweg - key: '07294700001' name: Marienau short_name: Marienau - key: '07439100004' name: Meitnerstr. short_name: Meitnerstr. - key: '07496200001' name: Mezgerstr. short_name: Mezgerstr. - key: '07541500001' name: Mitterwurzerstr. short_name: Mitterwurzerstr. - key: '07197900001' name: 'Möhringer Landstr.' short_name: 'Möhringer Landstr.' - key: '07213700001' name: Mößnerstr. short_name: Mößnerstr. - key: '07710300001' name: Nathanstr. short_name: Nathanstr. - key: '07744400002' name: Nestroyweg short_name: Nestroyweg - key: '07912700001' name: 'Nufringer Str.' short_name: 'Nufringer Str.' - key: '07970400001' name: 'Oberer Grundweg' short_name: 'Oberer Grundweg' - key: '58483500001' name: Oscar-Schopp-Weg short_name: Oscar-Schopp-Weg - key: '09110500001' name: 'Österfeld, Gewann' short_name: 'Österfeld, Gewann' - key: '09110600001' name: Österfeldstr. short_name: Österfeldstr. - key: '08154900002' name: Othellostr. short_name: Othellostr. - key: '08233200003' name: Paradiesplatz short_name: Paradiesplatz - key: '08233300011' name: Paradiesstr. short_name: Paradiesstr. - key: '08315400119' name: Pestalozzistr. short_name: Pestalozzistr. - key: '08371600004' name: Pfarrhausstr. short_name: Pfarrhausstr. - key: '08374600010' name: Pfauenstr. short_name: Pfauenstr. - key: '08642000007' name: Raimundstr. short_name: Raimundstr. - key: '08668100040' name: Rathausplatz short_name: Rathausplatz - key: '08807200001' name: 'Rexinger Weg' short_name: 'Rexinger Weg' - key: '08905500121' name: Robert-Koch-Str. short_name: Robert-Koch-Str. - key: '08906400001' name: Robert-Leicht-Str. short_name: Robert-Leicht-Str. - key: '08985800005' name: Rosentalstr. short_name: Rosentalstr. - key: '09024200008' name: 'Rottweiler Str.' short_name: 'Rottweiler Str.' - key: '09213500002' name: Sauerweg short_name: Sauerweg - key: '09244700002' name: Schaberweg short_name: Schaberweg - key: '09580200001' name: Schädleweg short_name: Schädleweg - key: '31672300006' name: Schafsgasse short_name: Schafsgasse - key: '09273700001' name: Scharrstr. short_name: Scharrstr. - key: '09318900001' name: Schexweg short_name: Schexweg - key: '09329200001' name: Schießmauerstr. short_name: Schießmauerstr. - key: '09342200001' name: Schillerpassage short_name: Schillerpassage - key: '09476100002' name: 'Schopflocher Str.' short_name: 'Schopflocher Str.' - key: '46463700001' name: Schwabenplatz short_name: Schwabenplatz - key: '09553700002' name: Schwarzäckerstr. short_name: Schwarzäckerstr. - key: '09566100003' name: 'Schwenninger Str.' short_name: 'Schwenninger Str.' - key: '09631400005' name: Seerosenstr. short_name: Seerosenstr. - key: '09703900028' name: Siedlerstr. short_name: Siedlerstr. - key: '09730400001' name: Sigmundtstr. short_name: Sigmundtstr. - key: '32850700005' name: Sommerfeldweg short_name: Sommerfeldweg - key: '09806900001' name: Sormaweg short_name: Sormaweg - key: '10016100001' name: Stellaweg short_name: Stellaweg - key: '10035100001' name: 'Sternecker Str.' short_name: 'Sternecker Str.' - key: '10059200010' name: 'Stiller Winkel' short_name: 'Stiller Winkel' - key: '10087400001' name: Stoßäckerstr. short_name: Stoßäckerstr. - key: '10197000001' name: 'Sulzauer Str.' short_name: 'Sulzauer Str.' - key: '10217400003' name: Syringenweg short_name: Syringenweg - key: '10390900002' name: Tigerstr. short_name: Tigerstr. - key: '10604000001' name: 'Unterer Grund' short_name: 'Unterer Grund' - key: '10659200001' name: 'Vaihinger Markt' short_name: 'Vaihinger Markt' - key: '10676300074' name: Veilchenweg short_name: Veilchenweg - key: '10731100004' name: Vischerstr. short_name: Vischerstr. - key: '10762000001' name: Vollmoellerstr. short_name: Vollmoellerstr. - key: '10893000003' name: Waldburgstr. short_name: Waldburgstr. - key: '10938900001' name: Walter-Heller-Str. short_name: Walter-Heller-Str. - key: '10959100025' name: Wankelstr. short_name: Wankelstr. - key: '11020000001' name: Wegländerstr. short_name: Wegländerstr. - key: '11403400001' name: Wolfmahdenstr. short_name: Wolfmahdenstr. - key: '10861600049' name: Wörthstr. short_name: Wörthstr. - key: '11519000010' name: Zilleweg short_name: Zilleweg - key: '11550100004' name: 'Zu den Tannen' short_name: 'Zu den Tannen' - key: '11608800001' name: 'Zum Lauchwald' short_name: 'Zum Lauchwald' - key: '11716200003' name: Zürnstr. short_name: Zürnstr. items: type: object properties: key: type: string example: '00046000005' name: type: string example: Ackermannstr. short_name: type: string example: Ackermannstr. postboxes: type: array example: [] tags: - Utils security: [] parameters: - in: path name: zipCode description: 'Optional parameter. The zip code to fetch the associated zip area information for.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: '70563' /api/utils/suggestions/zipAreas: get: summary: 'GET suggested zip areas by search query' operationId: gETSuggestedZipAreasBySearchQuery description: "This endpoint allows you to fetch suggestions for zip areas based on a provided zip code and/or city name.\nIt is useful for auto-completing address forms and validating user input.\n\nThe best way to use this endpoint is to provide autocompletion for a given zip code/city input and after selection\nof a specific zip area, use the api/cities/{city_key}/zipAreas/{zipArea_zip}/streets endpoint to fetch the streets for the selected zip area." parameters: - in: query name: query description: 'The search query for zip code and/or city name. :Attribute darf maximal 255 Zeichen haben.' example: '70563 Stuttgart' required: true schema: type: string description: 'The search query for zip code and/or city name. :Attribute darf maximal 255 Zeichen haben.' example: '70563 Stuttgart' - in: query name: mode description: "Optional mode to filter results by zip areas that have either streets or postboxes. Allowed values are 'streets' and 'postboxes'." example: streets required: false schema: type: string description: "Optional mode to filter results by zip areas that have either streets or postboxes. Allowed values are 'streets' and 'postboxes'." example: streets - in: query name: limit description: 'Optional limit for the number of zip areas returned. :Attribute muss mindestens 1 sein. :Attribute darf maximal 100 sein.' example: 10 required: false schema: type: integer description: 'Optional limit for the number of zip areas returned. :Attribute muss mindestens 1 sein. :Attribute darf maximal 100 sein.' example: 10 responses: 200: description: '' content: application/json: schema: type: object example: data: - zip: '70563' zip_de: 70563 postbox_numbers_from: null postbox_numbers_to: null city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart properties: data: type: array example: - zip: '70563' zip_de: 70563 postbox_numbers_from: null postbox_numbers_to: null city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart items: type: object properties: zip: type: string example: '70563' zip_de: type: integer example: 70563 postbox_numbers_from: type: string example: null nullable: true postbox_numbers_to: type: string example: null nullable: true city: type: object properties: key: type: string example: '58727000' name: type: string example: Stuttgart additional: type: string example: null nullable: true ags: type: string example: '08111000' short_name: type: string example: Stuttgart tags: - Utils security: [] /api/utils/suggestions/addresses: get: summary: 'GET check complete address' operationId: gETCheckCompleteAddress description: "This endpoint can determine if a given manually entered address is a valid street or postbox address based on the\nprovided zip code, city name, street name, and house/postbox number.\n\nIf valid it will return the\ncorresponding address details with their respective keys. These keys should be stored to make further requests for\nthe same address more efficient, as they can be used to directly fetch the address without needing to match the input again." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: key: '07439100004' name: Meitnerstr. short_name: Meitnerstr. city: key: '58727000' name: Stuttgart additional: null ags: '08111000' short_name: Stuttgart zip: zip: '70563' zip_de: 70563 postbox_numbers_from: null postbox_numbers_to: null number: '10' properties: data: type: object properties: key: type: string example: '07439100004' name: type: string example: Meitnerstr. short_name: type: string example: Meitnerstr. city: type: object properties: key: type: string example: '58727000' name: type: string example: Stuttgart additional: type: string example: null nullable: true ags: type: string example: '08111000' short_name: type: string example: Stuttgart zip: type: object properties: zip: type: string example: '70563' zip_de: type: integer example: 70563 postbox_numbers_from: type: string example: null nullable: true postbox_numbers_to: type: string example: null nullable: true number: type: string example: '10' tags: - Utils requestBody: required: false content: application/json: schema: type: object properties: city: type: string description: 'A city name to check against. :Attribute muss mindestens 2 Zeichen lang sein. :Attribute darf maximal 255 Zeichen haben.' example: Stuttgart nullable: true zip: type: string description: 'A zip code to check against. :Attribute muss mindestens 2 Zeichen lang sein. :Attribute darf maximal 255 Zeichen haben.' example: '70563' nullable: true street: type: string description: 'A street name to check against. :Attribute muss mindestens 2 Zeichen lang sein. :Attribute darf maximal 255 Zeichen haben.' example: Meitnerstraße nullable: true mode: type: string description: "An optional mode to specify whether the address is a street or postbox address. Allowed values are 'streets' and 'postboxes'. Defaults to streets." example: streets number: type: string description: 'A house number or postbox number to check against. :Attribute darf maximal 255 Zeichen haben.' example: '10' nullable: true security: []