{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/tekoa.farbcode.net" } ], "info": { "name": "Tekoa API Documentation", "_postman_id": "07356e50-8b24-4cb8-b16c-3da8ac0b1f11", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Basics", "description": "\nThese endpoints provide basic information about address data by their keys.", "item": [ { "name": "GET city by key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:key", "query": [], "raw": "{{baseUrl}}\/api\/cities\/:key", "variable": [ { "id": "key", "key": "key", "value": "58727000", "description": "The unique key of the city." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "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').", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"key\": \"58727000\",\n \"name\": \"Stuttgart\",\n \"additional\": null,\n \"ags\": \"08111000\",\n \"short_name\": \"Stuttgart\"\n }\n}\n", "name": "" } ] }, { "name": "GET district by keys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:city_key\/districts\/:key", "query": [], "raw": "{{baseUrl}}\/api\/cities\/:city_key\/districts\/:key", "variable": [ { "id": "city_key", "key": "city_key", "value": "58727000", "description": "The unique key of the city." }, { "id": "key", "key": "key", "value": "051", "description": "The additional key of the district within the city." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "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').", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"key\": \"051\",\n \"name\": \"Vaihingen\",\n \"city\": {\n \"key\": \"58727000\",\n \"name\": \"Stuttgart\",\n \"additional\": null,\n \"ags\": \"08111000\",\n \"short_name\": \"Stuttgart\"\n }\n }\n}\n", "name": "" } ] }, { "name": "GET zip area by keys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:city_key\/zipAreas\/:zip", "query": [], "raw": "{{baseUrl}}\/api\/cities\/:city_key\/zipAreas\/:zip", "variable": [ { "id": "city_key", "key": "city_key", "value": "58727000", "description": "The unique key of the city." }, { "id": "zip", "key": "zip", "value": "70563", "description": "The zip code of the specific zip area." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "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.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"zip\": \"70563\",\n \"zip_de\": 70563,\n \"postbox_numbers_from\": null,\n \"postbox_numbers_to\": null,\n \"city\": {\n \"key\": \"58727000\",\n \"name\": \"Stuttgart\",\n \"additional\": null,\n \"ags\": \"08111000\",\n \"short_name\": \"Stuttgart\"\n }\n }\n}\n", "name": "" } ] }, { "name": "GET streets in zip area", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:city_key\/zipAreas\/:zipArea_zip\/streets", "query": [ { "key": "query", "value": "meitnerstrasse", "description": "Optional search query to filter streets by name. :Attribute darf maximal 255 Zeichen haben. :Attribute muss mindestens 2 Zeichen lang sein.", "disabled": false }, { "key": "limit", "value": "10", "description": "Optional limit for the number of streets returned. :Attribute muss mindestens 1 sein.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cities\/:city_key\/zipAreas\/:zipArea_zip\/streets?query=meitnerstrasse&limit=10", "variable": [ { "id": "city_key", "key": "city_key", "value": "58727000", "description": "The unique key of the city." }, { "id": "zipArea_zip", "key": "zipArea_zip", "value": "70563", "description": "The zip code of the specific zip area." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "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.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"key\": \"07439100004\",\n \"name\": \"Meitnerstr.\",\n \"short_name\": \"Meitnerstr.\"\n }\n ]\n}\n", "name": "" } ] }, { "name": "GET street by keys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:city_key\/zipAreas\/:zipArea_zip\/streets\/:key", "query": [], "raw": "{{baseUrl}}\/api\/cities\/:city_key\/zipAreas\/:zipArea_zip\/streets\/:key", "variable": [ { "id": "city_key", "key": "city_key", "value": "58727000", "description": "The unique key of the city." }, { "id": "zipArea_zip", "key": "zipArea_zip", "value": "70563", "description": "The zip code of the specific zip area." }, { "id": "key", "key": "key", "value": "07439100004", "description": "The unique key of the street." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific street based on its unique identifier (key) within a zip area and city.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"key\": \"07439100004\",\n \"name\": \"Meitnerstr.\",\n \"short_name\": \"Meitnerstr.\",\n \"city\": {\n \"key\": \"58727000\",\n \"name\": \"Stuttgart\",\n \"additional\": null,\n \"ags\": \"08111000\",\n \"short_name\": \"Stuttgart\"\n },\n \"zip\": {\n \"zip\": \"70563\",\n \"zip_de\": 70563,\n \"postbox_numbers_from\": null,\n \"postbox_numbers_to\": null\n }\n }\n}\n", "name": "" } ] } ] }, { "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.", "item": [ { "name": "POST check postbox validity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/utils\/cities\/:city_key\/zipAreas\/:zipArea_zip\/postboxes\/check", "query": [], "raw": "{{baseUrl}}\/api\/utils\/cities\/:city_key\/zipAreas\/:zipArea_zip\/postboxes\/check", "variable": [ { "id": "city_key", "key": "city_key", "value": "58727000", "description": "The unique key of the city." }, { "id": "zipArea_zip", "key": "zipArea_zip", "value": "70571", "description": "The zip code of the specific zip area." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"number\":\"700111\"}" }, "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.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"valid\": true\n}\n", "name": "" } ] }, { "name": "POST check house number validity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/utils\/cities\/:city_key\/zipAreas\/:zipArea_zip\/streets\/:street_key\/numbers\/check", "query": [], "raw": "{{baseUrl}}\/api\/utils\/cities\/:city_key\/zipAreas\/:zipArea_zip\/streets\/:street_key\/numbers\/check", "variable": [ { "id": "city_key", "key": "city_key", "value": "58727000", "description": "The unique key of the city." }, { "id": "zipArea_zip", "key": "zipArea_zip", "value": "70563", "description": "The zip code of the specific zip area." }, { "id": "street_key", "key": "street_key", "value": "07439100004", "description": "The unique key of the street." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"number\":\"10\"}" }, "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.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"valid\": true,\n \"district\": \"Vaihingen\",\n \"district_key\": \"051\"\n}\n", "name": "" } ] }, { "name": "GET suggested zip areas", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/utils\/zipCodes\/:zipCode\/zipAreas", "query": [], "raw": "{{baseUrl}}\/api\/utils\/zipCodes\/:zipCode\/zipAreas", "variable": [ { "id": "zipCode", "key": "zipCode", "value": "70563", "description": "The zip code to fetch the associated zip area information for." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "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.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"zip\": \"70563\",\n \"zip_de\": 70563,\n \"postbox_numbers_from\": null,\n \"postbox_numbers_to\": null,\n \"city\": {\n \"key\": \"58727000\",\n \"name\": \"Stuttgart\",\n \"additional\": null,\n \"ags\": \"08111000\",\n \"short_name\": \"Stuttgart\"\n },\n \"streets\": [\n {\n \"key\": \"00046000005\",\n \"name\": \"Ackermannstr.\",\n \"short_name\": \"Ackermannstr.\"\n },\n {\n \"key\": \"00110200002\",\n \"name\": \"Albblick\",\n \"short_name\": \"Albblick\"\n },\n {\n \"key\": \"00126600001\",\n \"name\": \"Albigenserweg\",\n \"short_name\": \"Albigenserweg\"\n },\n {\n \"key\": \"00165700003\",\n \"name\": \"Allmandstr.\",\n \"short_name\": \"Allmandstr.\"\n },\n {\n \"key\": \"00176000009\",\n \"name\": \"Alpenrosenstr.\",\n \"short_name\": \"Alpenrosenstr.\"\n },\n {\n \"key\": \"00446900001\",\n \"name\": \"Am Feldrand\",\n \"short_name\": \"Am Feldrand\"\n },\n {\n \"key\": \"00440100001\",\n \"name\": \"Am F\u00f6hrenwald\",\n \"short_name\": \"Am F\u00f6hrenwald\"\n },\n {\n \"key\": \"00585000001\",\n \"name\": \"Am Hopfenrain\",\n \"short_name\": \"Am Hopfenrain\"\n },\n {\n \"key\": \"01002100004\",\n \"name\": \"Am Wallgraben\",\n \"short_name\": \"Am Wallgraben\"\n },\n {\n \"key\": \"01055200001\",\n \"name\": \"Amadeusweg\",\n \"short_name\": \"Amadeusweg\"\n },\n {\n \"key\": \"01070700147\",\n \"name\": \"Amselweg\",\n \"short_name\": \"Amselweg\"\n },\n {\n \"key\": \"01306300001\",\n \"name\": \"Anweiler Weg\",\n \"short_name\": \"Anweiler Weg\"\n },\n {\n \"key\": \"01593100126\",\n \"name\": \"Bachstr.\",\n \"short_name\": \"Bachstr.\"\n },\n {\n \"key\": \"01616300001\",\n \"name\": \"Bahnhof Vaihingen\",\n \"short_name\": \"Bahnhof Vaihingen\"\n },\n {\n \"key\": \"01672100004\",\n \"name\": \"Bassermannstr.\",\n \"short_name\": \"Bassermannstr.\"\n },\n {\n \"key\": \"01763300001\",\n \"name\": \"Beim R\u00f6merhaus\",\n \"short_name\": \"Beim R\u00f6merhaus\"\n },\n {\n \"key\": \"01828000001\",\n \"name\": \"Bergnelkenstr.\",\n \"short_name\": \"Bergnelkenstr.\"\n },\n {\n \"key\": \"01879100001\",\n \"name\": \"Betzweilerstr.\",\n \"short_name\": \"Betzweilerstr.\"\n },\n {\n \"key\": \"01957600005\",\n \"name\": \"Bischoffstr.\",\n \"short_name\": \"Bischoffstr.\"\n },\n {\n \"key\": \"02012500001\",\n \"name\": \"Bl\u00fcmleweg\",\n \"short_name\": \"Bl\u00fcmleweg\"\n },\n {\n \"key\": \"02209500001\",\n \"name\": \"Brommerstr.\",\n \"short_name\": \"Brommerstr.\"\n },\n {\n \"key\": \"02261500026\",\n \"name\": \"Br\u00fchlstr.\",\n \"short_name\": \"Br\u00fchlstr.\"\n },\n {\n \"key\": \"02276900018\",\n \"name\": \"Buchfinkenweg\",\n \"short_name\": \"Buchfinkenweg\"\n },\n {\n \"key\": \"02400500001\",\n \"name\": \"B\u00fcsnauer Str.\",\n \"short_name\": \"B\u00fcsnauer Str.\"\n },\n {\n \"key\": \"02456200002\",\n \"name\": \"Champignystr.\",\n \"short_name\": \"Champignystr.\"\n },\n {\n \"key\": \"02535100012\",\n \"name\": \"Curiestr.\",\n \"short_name\": \"Curiestr.\"\n },\n {\n \"key\": \"02644900002\",\n \"name\": \"Demetriusweg\",\n \"short_name\": \"Demetriusweg\"\n },\n {\n \"key\": \"02753000003\",\n \"name\": \"Don-Carlos-Str.\",\n \"short_name\": \"Don-Carlos-Str.\"\n },\n {\n \"key\": \"02551900004\",\n \"name\": \"D\u00f6ringstr.\",\n \"short_name\": \"D\u00f6ringstr.\"\n },\n {\n \"key\": \"02857100136\",\n \"name\": \"Drosselweg\",\n \"short_name\": \"Drosselweg\"\n },\n {\n \"key\": \"02872600001\",\n \"name\": \"Dumontweg\",\n \"short_name\": \"Dumontweg\"\n },\n {\n \"key\": \"02878600001\",\n \"name\": \"Dusestr.\",\n \"short_name\": \"Dusestr.\"\n },\n {\n \"key\": \"02971100001\",\n \"name\": \"Egmontweg\",\n \"short_name\": \"Egmontweg\"\n },\n {\n \"key\": \"03030200001\",\n \"name\": \"Eisb\u00e4renstr.\",\n \"short_name\": \"Eisb\u00e4renstr.\"\n },\n {\n \"key\": \"03111200025\",\n \"name\": \"Emilienstr.\",\n \"short_name\": \"Emilienstr.\"\n },\n {\n \"key\": \"03128000013\",\n \"name\": \"Enge Str.\",\n \"short_name\": \"Enge Str.\"\n },\n {\n \"key\": \"03175400001\",\n \"name\": \"Erich-Ponto-Weg\",\n \"short_name\": \"Erich-Ponto-Weg\"\n },\n {\n \"key\": \"03189600004\",\n \"name\": \"Erlk\u00f6nigstr.\",\n \"short_name\": \"Erlk\u00f6nigstr.\"\n },\n {\n \"key\": \"03205600001\",\n \"name\": \"Ernst-Kachel-Str.\",\n \"short_name\": \"Ernst-Kachel-Str.\"\n },\n {\n \"key\": \"03320500001\",\n \"name\": \"Fanny-Leicht-Str.\",\n \"short_name\": \"Fanny-Leicht-Str.\"\n },\n {\n \"key\": \"03333100008\",\n \"name\": \"Fauststr.\",\n \"short_name\": \"Fauststr.\"\n },\n {\n \"key\": \"03361500001\",\n \"name\": \"Felldorfer Str.\",\n \"short_name\": \"Felldorfer Str.\"\n },\n {\n \"key\": \"03396800001\",\n \"name\": \"Filderhofstr.\",\n \"short_name\": \"Filderhofstr.\"\n },\n {\n \"key\": \"03457200001\",\n \"name\": \"Florathweg\",\n \"short_name\": \"Florathweg\"\n },\n {\n \"key\": \"03552600005\",\n \"name\": \"Freibadstr.\",\n \"short_name\": \"Freibadstr.\"\n },\n {\n \"key\": \"03563900001\",\n \"name\": \"Fremdstr.\",\n \"short_name\": \"Fremdstr.\"\n },\n {\n \"key\": \"03577700002\",\n \"name\": \"Friedemannweg\",\n \"short_name\": \"Friedemannweg\"\n },\n {\n \"key\": \"03673100018\",\n \"name\": \"Fuggerstr.\",\n \"short_name\": \"Fuggerstr.\"\n },\n {\n \"key\": \"03762700202\",\n \"name\": \"Gartenstr.\",\n \"short_name\": \"Gartenstr.\"\n },\n {\n \"key\": \"03804500001\",\n \"name\": \"Geiwitzstr.\",\n \"short_name\": \"Geiwitzstr.\"\n },\n {\n \"key\": \"03866600018\",\n \"name\": \"Germanenstr.\",\n \"short_name\": \"Germanenstr.\"\n },\n {\n \"key\": \"03908600001\",\n \"name\": \"Giesekingstr.\",\n \"short_name\": \"Giesekingstr.\"\n },\n {\n \"key\": \"03943800002\",\n \"name\": \"Glockenblumenstr.\",\n \"short_name\": \"Glockenblumenstr.\"\n },\n {\n \"key\": \"41230300002\",\n \"name\": \"Gropiusplatz\",\n \"short_name\": \"Gropiusplatz\"\n },\n {\n \"key\": \"04172700002\",\n \"name\": \"Gr\u00fcndgensstr.\",\n \"short_name\": \"Gr\u00fcndgensstr.\"\n },\n {\n \"key\": \"04185400001\",\n \"name\": \"Gr\u00fcntaler Weg\",\n \"short_name\": \"Gr\u00fcntaler Weg\"\n },\n {\n \"key\": \"04248900003\",\n \"name\": \"G\u00fcltsteiner Str.\",\n \"short_name\": \"G\u00fcltsteiner Str.\"\n },\n {\n \"key\": \"04328000002\",\n \"name\": \"Haeberlinstr.\",\n \"short_name\": \"Haeberlinstr.\"\n },\n {\n \"key\": \"05176600006\",\n \"name\": \"H\u00e4fnerstr.\",\n \"short_name\": \"H\u00e4fnerstr.\"\n },\n {\n \"key\": \"04355600004\",\n \"name\": \"Hahnenweg\",\n \"short_name\": \"Hahnenweg\"\n },\n {\n \"key\": \"04373300001\",\n \"name\": \"Halde, Gewann\",\n \"short_name\": \"Halde, Gewann\"\n },\n {\n \"key\": \"04395500002\",\n \"name\": \"Hamletstr.\",\n \"short_name\": \"Hamletstr.\"\n },\n {\n \"key\": \"04524300001\",\n \"name\": \"Haugstr.\",\n \"short_name\": \"Haugstr.\"\n },\n {\n \"key\": \"04529200139\",\n \"name\": \"Hauptstr.\",\n \"short_name\": \"Hauptstr.\"\n },\n {\n \"key\": \"04575100026\",\n \"name\": \"Heerstr.\",\n \"short_name\": \"Heerstr.\"\n },\n {\n \"key\": \"04808500004\",\n \"name\": \"Herrenberger Str.\",\n \"short_name\": \"Herrenberger Str.\"\n },\n {\n \"key\": \"04271700001\",\n \"name\": \"H\u00f6henrandstr.\",\n \"short_name\": \"H\u00f6henrandstr.\"\n },\n {\n \"key\": \"05040300001\",\n \"name\": \"Holderbuschweg\",\n \"short_name\": \"Holderbuschweg\"\n },\n {\n \"key\": \"05065100092\",\n \"name\": \"Holunderweg\",\n \"short_name\": \"Holunderweg\"\n },\n {\n \"key\": \"05070700006\",\n \"name\": \"Holzhauser Str.\",\n \"short_name\": \"Holzhauser Str.\"\n },\n {\n \"key\": \"05086300001\",\n \"name\": \"Honigwiesenstr.\",\n \"short_name\": \"Honigwiesenstr.\"\n },\n {\n \"key\": \"05090400001\",\n \"name\": \"Hopfauer Str.\",\n \"short_name\": \"Hopfauer Str.\"\n },\n {\n \"key\": \"05132000001\",\n \"name\": \"Huckebeinweg\",\n \"short_name\": \"Huckebeinweg\"\n },\n {\n \"key\": \"05222900008\",\n \"name\": \"Ifflandstr.\",\n \"short_name\": \"Ifflandstr.\"\n },\n {\n \"key\": \"05303800003\",\n \"name\": \"Im Finkenschlag\",\n \"short_name\": \"Im Finkenschlag\"\n },\n {\n \"key\": \"05361200001\",\n \"name\": \"Im Johannesgraben\",\n \"short_name\": \"Im Johannesgraben\"\n },\n {\n \"key\": \"05468200001\",\n \"name\": \"Im Sommerwind\",\n \"short_name\": \"Im Sommerwind\"\n },\n {\n \"key\": \"05475100001\",\n \"name\": \"Im Steinengarten\",\n \"short_name\": \"Im Steinengarten\"\n },\n {\n \"key\": \"05595200001\",\n \"name\": \"In der L\u00fcsse\",\n \"short_name\": \"In der L\u00fcsse\"\n },\n {\n \"key\": \"05694100001\",\n \"name\": \"Janningsstr.\",\n \"short_name\": \"Janningsstr.\"\n },\n {\n \"key\": \"05885600001\",\n \"name\": \"Kainzweg\",\n \"short_name\": \"Kainzweg\"\n },\n {\n \"key\": \"05911200001\",\n \"name\": \"Kaltentaler Str.\",\n \"short_name\": \"Kaltentaler Str.\"\n },\n {\n \"key\": \"06047000001\",\n \"name\": \"Katzenbachstr.\",\n \"short_name\": \"Katzenbachstr.\"\n },\n {\n \"key\": \"06076900001\",\n \"name\": \"Kelterberg\",\n \"short_name\": \"Kelterberg\"\n },\n {\n \"key\": \"06175200001\",\n \"name\": \"Kl\u00f6pferweg\",\n \"short_name\": \"Kl\u00f6pferweg\"\n },\n {\n \"key\": \"06471400001\",\n \"name\": \"Koppenh\u00f6ferweg\",\n \"short_name\": \"Koppenh\u00f6ferweg\"\n },\n {\n \"key\": \"06529800001\",\n \"name\": \"Krehlstr.\",\n \"short_name\": \"Krehlstr.\"\n },\n {\n \"key\": \"06552600092\",\n \"name\": \"Kreuzstr.\",\n \"short_name\": \"Kreuzstr.\"\n },\n {\n \"key\": \"06633400001\",\n \"name\": \"Kuppinger Str.\",\n \"short_name\": \"Kuppinger Str.\"\n },\n {\n \"key\": \"06957500002\",\n \"name\": \"Liasweg\",\n \"short_name\": \"Liasweg\"\n },\n {\n \"key\": \"07005000162\",\n \"name\": \"Lindenstr.\",\n \"short_name\": \"Lindenstr.\"\n },\n {\n \"key\": \"07072000001\",\n \"name\": \"Lombacher Str.\",\n \"short_name\": \"Lombacher Str.\"\n },\n {\n \"key\": \"07077800002\",\n \"name\": \"Loosweg\",\n \"short_name\": \"Loosweg\"\n },\n {\n \"key\": \"07084400001\",\n \"name\": \"Lo\u00dfburger Str.\",\n \"short_name\": \"Lo\u00dfburger Str.\"\n },\n {\n \"key\": \"07147600003\",\n \"name\": \"Lutherweg\",\n \"short_name\": \"Lutherweg\"\n },\n {\n \"key\": \"07149700001\",\n \"name\": \"Lutzweg\",\n \"short_name\": \"Lutzweg\"\n },\n {\n \"key\": \"07259500025\",\n \"name\": \"Malvenweg\",\n \"short_name\": \"Malvenweg\"\n },\n {\n \"key\": \"07283200009\",\n \"name\": \"Margueritenweg\",\n \"short_name\": \"Margueritenweg\"\n },\n {\n \"key\": \"07294700001\",\n \"name\": \"Marienau\",\n \"short_name\": \"Marienau\"\n },\n {\n \"key\": \"07439100004\",\n \"name\": \"Meitnerstr.\",\n \"short_name\": \"Meitnerstr.\"\n },\n {\n \"key\": \"07496200001\",\n \"name\": \"Mezgerstr.\",\n \"short_name\": \"Mezgerstr.\"\n },\n {\n \"key\": \"07541500001\",\n \"name\": \"Mitterwurzerstr.\",\n \"short_name\": \"Mitterwurzerstr.\"\n },\n {\n \"key\": \"07197900001\",\n \"name\": \"M\u00f6hringer Landstr.\",\n \"short_name\": \"M\u00f6hringer Landstr.\"\n },\n {\n \"key\": \"07213700001\",\n \"name\": \"M\u00f6\u00dfnerstr.\",\n \"short_name\": \"M\u00f6\u00dfnerstr.\"\n },\n {\n \"key\": \"07710300001\",\n \"name\": \"Nathanstr.\",\n \"short_name\": \"Nathanstr.\"\n },\n {\n \"key\": \"07744400002\",\n \"name\": \"Nestroyweg\",\n \"short_name\": \"Nestroyweg\"\n },\n {\n \"key\": \"07912700001\",\n \"name\": \"Nufringer Str.\",\n \"short_name\": \"Nufringer Str.\"\n },\n {\n \"key\": \"07970400001\",\n \"name\": \"Oberer Grundweg\",\n \"short_name\": \"Oberer Grundweg\"\n },\n {\n \"key\": \"58483500001\",\n \"name\": \"Oscar-Schopp-Weg\",\n \"short_name\": \"Oscar-Schopp-Weg\"\n },\n {\n \"key\": \"09110500001\",\n \"name\": \"\u00d6sterfeld, Gewann\",\n \"short_name\": \"\u00d6sterfeld, Gewann\"\n },\n {\n \"key\": \"09110600001\",\n \"name\": \"\u00d6sterfeldstr.\",\n \"short_name\": \"\u00d6sterfeldstr.\"\n },\n {\n \"key\": \"08154900002\",\n \"name\": \"Othellostr.\",\n \"short_name\": \"Othellostr.\"\n },\n {\n \"key\": \"08233200003\",\n \"name\": \"Paradiesplatz\",\n \"short_name\": \"Paradiesplatz\"\n },\n {\n \"key\": \"08233300011\",\n \"name\": \"Paradiesstr.\",\n \"short_name\": \"Paradiesstr.\"\n },\n {\n \"key\": \"08315400119\",\n \"name\": \"Pestalozzistr.\",\n \"short_name\": \"Pestalozzistr.\"\n },\n {\n \"key\": \"08371600004\",\n \"name\": \"Pfarrhausstr.\",\n \"short_name\": \"Pfarrhausstr.\"\n },\n {\n \"key\": \"08374600010\",\n \"name\": \"Pfauenstr.\",\n \"short_name\": \"Pfauenstr.\"\n },\n {\n \"key\": \"08642000007\",\n \"name\": \"Raimundstr.\",\n \"short_name\": \"Raimundstr.\"\n },\n {\n \"key\": \"08668100040\",\n \"name\": \"Rathausplatz\",\n \"short_name\": \"Rathausplatz\"\n },\n {\n \"key\": \"08807200001\",\n \"name\": \"Rexinger Weg\",\n \"short_name\": \"Rexinger Weg\"\n },\n {\n \"key\": \"08905500121\",\n \"name\": \"Robert-Koch-Str.\",\n \"short_name\": \"Robert-Koch-Str.\"\n },\n {\n \"key\": \"08906400001\",\n \"name\": \"Robert-Leicht-Str.\",\n \"short_name\": \"Robert-Leicht-Str.\"\n },\n {\n \"key\": \"08985800005\",\n \"name\": \"Rosentalstr.\",\n \"short_name\": \"Rosentalstr.\"\n },\n {\n \"key\": \"09024200008\",\n \"name\": \"Rottweiler Str.\",\n \"short_name\": \"Rottweiler Str.\"\n },\n {\n \"key\": \"09213500002\",\n \"name\": \"Sauerweg\",\n \"short_name\": \"Sauerweg\"\n },\n {\n \"key\": \"09244700002\",\n \"name\": \"Schaberweg\",\n \"short_name\": \"Schaberweg\"\n },\n {\n \"key\": \"09580200001\",\n \"name\": \"Sch\u00e4dleweg\",\n \"short_name\": \"Sch\u00e4dleweg\"\n },\n {\n \"key\": \"31672300006\",\n \"name\": \"Schafsgasse\",\n \"short_name\": \"Schafsgasse\"\n },\n {\n \"key\": \"09273700001\",\n \"name\": \"Scharrstr.\",\n \"short_name\": \"Scharrstr.\"\n },\n {\n \"key\": \"09318900001\",\n \"name\": \"Schexweg\",\n \"short_name\": \"Schexweg\"\n },\n {\n \"key\": \"09329200001\",\n \"name\": \"Schie\u00dfmauerstr.\",\n \"short_name\": \"Schie\u00dfmauerstr.\"\n },\n {\n \"key\": \"09342200001\",\n \"name\": \"Schillerpassage\",\n \"short_name\": \"Schillerpassage\"\n },\n {\n \"key\": \"09476100002\",\n \"name\": \"Schopflocher Str.\",\n \"short_name\": \"Schopflocher Str.\"\n },\n {\n \"key\": \"46463700001\",\n \"name\": \"Schwabenplatz\",\n \"short_name\": \"Schwabenplatz\"\n },\n {\n \"key\": \"09553700002\",\n \"name\": \"Schwarz\u00e4ckerstr.\",\n \"short_name\": \"Schwarz\u00e4ckerstr.\"\n },\n {\n \"key\": \"09566100003\",\n \"name\": \"Schwenninger Str.\",\n \"short_name\": \"Schwenninger Str.\"\n },\n {\n \"key\": \"09631400005\",\n \"name\": \"Seerosenstr.\",\n \"short_name\": \"Seerosenstr.\"\n },\n {\n \"key\": \"09703900028\",\n \"name\": \"Siedlerstr.\",\n \"short_name\": \"Siedlerstr.\"\n },\n {\n \"key\": \"09730400001\",\n \"name\": \"Sigmundtstr.\",\n \"short_name\": \"Sigmundtstr.\"\n },\n {\n \"key\": \"32850700005\",\n \"name\": \"Sommerfeldweg\",\n \"short_name\": \"Sommerfeldweg\"\n },\n {\n \"key\": \"09806900001\",\n \"name\": \"Sormaweg\",\n \"short_name\": \"Sormaweg\"\n },\n {\n \"key\": \"10016100001\",\n \"name\": \"Stellaweg\",\n \"short_name\": \"Stellaweg\"\n },\n {\n \"key\": \"10035100001\",\n \"name\": \"Sternecker Str.\",\n \"short_name\": \"Sternecker Str.\"\n },\n {\n \"key\": \"10059200010\",\n \"name\": \"Stiller Winkel\",\n \"short_name\": \"Stiller Winkel\"\n },\n {\n \"key\": \"10087400001\",\n \"name\": \"Sto\u00df\u00e4ckerstr.\",\n \"short_name\": \"Sto\u00df\u00e4ckerstr.\"\n },\n {\n \"key\": \"10197000001\",\n \"name\": \"Sulzauer Str.\",\n \"short_name\": \"Sulzauer Str.\"\n },\n {\n \"key\": \"10217400003\",\n \"name\": \"Syringenweg\",\n \"short_name\": \"Syringenweg\"\n },\n {\n \"key\": \"10390900002\",\n \"name\": \"Tigerstr.\",\n \"short_name\": \"Tigerstr.\"\n },\n {\n \"key\": \"10604000001\",\n \"name\": \"Unterer Grund\",\n \"short_name\": \"Unterer Grund\"\n },\n {\n \"key\": \"10659200001\",\n \"name\": \"Vaihinger Markt\",\n \"short_name\": \"Vaihinger Markt\"\n },\n {\n \"key\": \"10676300074\",\n \"name\": \"Veilchenweg\",\n \"short_name\": \"Veilchenweg\"\n },\n {\n \"key\": \"10731100004\",\n \"name\": \"Vischerstr.\",\n \"short_name\": \"Vischerstr.\"\n },\n {\n \"key\": \"10762000001\",\n \"name\": \"Vollmoellerstr.\",\n \"short_name\": \"Vollmoellerstr.\"\n },\n {\n \"key\": \"10893000003\",\n \"name\": \"Waldburgstr.\",\n \"short_name\": \"Waldburgstr.\"\n },\n {\n \"key\": \"10938900001\",\n \"name\": \"Walter-Heller-Str.\",\n \"short_name\": \"Walter-Heller-Str.\"\n },\n {\n \"key\": \"10959100025\",\n \"name\": \"Wankelstr.\",\n \"short_name\": \"Wankelstr.\"\n },\n {\n \"key\": \"11020000001\",\n \"name\": \"Wegl\u00e4nderstr.\",\n \"short_name\": \"Wegl\u00e4nderstr.\"\n },\n {\n \"key\": \"11403400001\",\n \"name\": \"Wolfmahdenstr.\",\n \"short_name\": \"Wolfmahdenstr.\"\n },\n {\n \"key\": \"10861600049\",\n \"name\": \"W\u00f6rthstr.\",\n \"short_name\": \"W\u00f6rthstr.\"\n },\n {\n \"key\": \"11519000010\",\n \"name\": \"Zilleweg\",\n \"short_name\": \"Zilleweg\"\n },\n {\n \"key\": \"11550100004\",\n \"name\": \"Zu den Tannen\",\n \"short_name\": \"Zu den Tannen\"\n },\n {\n \"key\": \"11608800001\",\n \"name\": \"Zum Lauchwald\",\n \"short_name\": \"Zum Lauchwald\"\n },\n {\n \"key\": \"11716200003\",\n \"name\": \"Z\u00fcrnstr.\",\n \"short_name\": \"Z\u00fcrnstr.\"\n }\n ],\n \"postboxes\": []\n }\n ]\n}\n", "name": "" } ] }, { "name": "GET suggested zip areas by search query", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/utils\/suggestions\/zipAreas", "query": [ { "key": "query", "value": "70563+Stuttgart", "description": "The search query for zip code and\/or city name. :Attribute darf maximal 255 Zeichen haben.", "disabled": false }, { "key": "mode", "value": "streets", "description": "Optional mode to filter results by zip areas that have either streets or postboxes. Allowed values are 'streets' and 'postboxes'.", "disabled": false }, { "key": "limit", "value": "10", "description": "Optional limit for the number of zip areas returned. :Attribute muss mindestens 1 sein. :Attribute darf maximal 100 sein.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/utils\/suggestions\/zipAreas?query=70563+Stuttgart&mode=streets&limit=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "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.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"zip\": \"70563\",\n \"zip_de\": 70563,\n \"postbox_numbers_from\": null,\n \"postbox_numbers_to\": null,\n \"city\": {\n \"key\": \"58727000\",\n \"name\": \"Stuttgart\",\n \"additional\": null,\n \"ags\": \"08111000\",\n \"short_name\": \"Stuttgart\"\n }\n }\n ]\n}\n", "name": "" } ] }, { "name": "GET check complete address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/utils\/suggestions\/addresses", "query": [], "raw": "{{baseUrl}}\/api\/utils\/suggestions\/addresses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"city\":\"Stuttgart\",\"zip\":\"70563\",\"street\":\"Meitnerstra\u00dfe\",\"mode\":\"streets\",\"number\":\"10\"}" }, "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.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"key\": \"07439100004\",\n \"name\": \"Meitnerstr.\",\n \"short_name\": \"Meitnerstr.\",\n \"city\": {\n \"key\": \"58727000\",\n \"name\": \"Stuttgart\",\n \"additional\": null,\n \"ags\": \"08111000\",\n \"short_name\": \"Stuttgart\"\n },\n \"zip\": {\n \"zip\": \"70563\",\n \"zip_de\": 70563,\n \"postbox_numbers_from\": null,\n \"postbox_numbers_to\": null\n },\n \"number\": \"10\"\n }\n}\n", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }