{"templateId":"markdown","versions":[{"version":"latest","label":"latest","link":"/guides/search/latest/textsearch","default":false,"active":true,"folderId":"e17c1af6"},{"version":"v1.0","label":"v1.0","link":"/guides/search/v1.0/textsearch","default":true,"active":false,"folderId":"e17c1af6"}],"sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Text Search","description":"Digime Map is the groundbreaking API that allows you to search places, navigate between points, highlight street attributes and raster tile.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"text-search","__idx":0},"children":["Text Search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This search API is typically used when the input is a full address."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request","__idx":1},"children":["Request"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"endpoint","__idx":2},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://dplace-api.themap.world/maps/api/place/textsearch/json\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-params","__idx":3},"children":["Query params"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Param"},"children":["Param"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The search text, for example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"lotte phu thuy\""]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["radius"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search radius around the focus point, in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["meters"]},", max ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["50000"]},", for example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5000"]}," (= 5km)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results returned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["has_deprecated_admin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if you want to return old_formatted_address, old_address_components"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example","__idx":4},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://dplace-api.themap.world/maps/api/place/textsearch/json?query=75 Trương Công Định, Phường Phú Lợi, Thành phố Cần Thơ&has_deprecated_admin=true&radius=5000&key=YOUR_API_KEY'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":5},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["textsearch/json"]}," wraps the response in the following top-level fields:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When present"},"children":["When present"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Content"},"children":["Content"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OK"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ZERO_RESULTS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVALID_REQUEST"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNKNOWN_ERROR"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["results"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of place objects (empty array on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ZERO_RESULTS"]}," / errors)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVALID_REQUEST"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNKNOWN_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["error description"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["html_attributions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}," — no third-party attribution data"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"status","__idx":6},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["success, results found"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ZERO_RESULTS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["success but no results matched"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVALID_REQUEST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["missing or invalid parameter (HTTP 400)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNKNOWN_ERROR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["server-side error: timeout, backend unreachable (HTTP 502/500)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"results","__idx":7},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["results"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each item in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["results"]}," is a place object with the fields shown in the example response body above:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When present"},"children":["When present"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Content"},"children":["Content"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["place_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unique identifier for the place"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["distance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["focus.point.lat/lon"]}," is passed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["distance from the focus point, in km"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["place name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["formatted_address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["standardized full address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["old_formatted_address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["address before an administrative merge, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"\""]}," if none"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["geometry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["location"]}," (lat/lng) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["viewport"]}," (northeast/southwest bounds)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["types"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["always"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of place type classifications"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"error_message","__idx":8},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_message"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the request has an invalid parameter, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["textsearch/json"]}," still returns HTTP 200 with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: \"INVALID_REQUEST\""]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"status\": \"INVALID_REQUEST\",\n  \"error_message\": \"query is required\",\n  \"results\": [],\n  \"html_attributions\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On a server-side failure, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNKNOWN_ERROR"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"status\": \"UNKNOWN_ERROR\",\n  \"error_message\": \"backend unreachable\",\n  \"results\": [],\n  \"html_attributions\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-1","__idx":9},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"status\": \"OK\",\n  \"results\": [\n    {\n      \"place_id\": \"1:address:d2a3105720e541a49c5f3140c0fa19ab\",\n      \"name\": \"75 Trương Công Định\",\n      \"address_components\": [\n        {\n          \"long_name\": \"75\",\n          \"short_name\": \"75\",\n          \"types\": [\n            \"street_number\"\n          ]\n        },\n        {\n          \"long_name\": \"Trương Công Định\",\n          \"short_name\": \"Trương Công Định\",\n          \"types\": [\n            \"route\"\n          ]\n        },\n        {\n          \"long_name\": \"Phường Phú Lợi\",\n          \"short_name\": \"Phường Phú Lợi\",\n          \"types\": [\n            \"administrative_area_level_2\"\n          ]\n        },\n        {\n          \"long_name\": \"Thành phố Cần Thơ\",\n          \"short_name\": \"Thành phố Cần Thơ\",\n          \"types\": [\n            \"administrative_area_level_1\"\n          ]\n        },\n        {\n          \"long_name\": \"Việt Nam\",\n          \"short_name\": \"VN\",\n          \"types\": [\n            \"country\"\n          ]\n        }\n      ],\n      \"formatted_address\": \"75 Trương Công Định, Phường Phú Lợi, Thành phố Cần Thơ, Việt Nam\",\n      \"old_address_components\": [\n        {\n          \"long_name\": \"75\",\n          \"short_name\": \"75\",\n          \"types\": [\n            \"street_number\"\n          ]\n        },\n        {\n          \"long_name\": \"Trương Công Định\",\n          \"short_name\": \"Trương Công Định\",\n          \"types\": [\n            \"route\"\n          ]\n        },\n        {\n          \"long_name\": \"Phường 2\",\n          \"short_name\": \"Phường 2\",\n          \"types\": [\n            \"administrative_area_level_3\"\n          ]\n        },\n        {\n          \"long_name\": \"Thành phố Sóc Trăng\",\n          \"short_name\": \"Thành phố Sóc Trăng\",\n          \"types\": [\n            \"administrative_area_level_2\"\n          ]\n        },\n        {\n          \"long_name\": \"Tỉnh Sóc Trăng\",\n          \"short_name\": \"Tỉnh Sóc Trăng\",\n          \"types\": [\n            \"administrative_area_level_1\"\n          ]\n        },\n        {\n          \"long_name\": \"Việt Nam\",\n          \"short_name\": \"VN\",\n          \"types\": [\n            \"country\"\n          ]\n        }\n      ],\n      \"old_formatted_address\": \"75 Trương Công Định, Phường 2, Thành phố Sóc Trăng, Tỉnh Sóc Trăng, Việt Nam\",\n      \"geometry\": {\n        \"location\": {\n          \"lat\": 9.6029245,\n          \"lng\": 105.9675911\n        },\n        \"viewport\": {\n          \"northeast\": {\n            \"lat\": 9.6038245,\n            \"lng\": 105.9687911\n          },\n          \"southwest\": {\n            \"lat\": 9.6020245,\n            \"lng\": 105.96639110000001\n          }\n        }\n      },\n      \"types\": [\n        \"street_address\"\n      ]\n    }\n  ],\n  \"html_attributions\": []\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Text Search","id":"text-search","depth":2},{"value":"Request","id":"request","depth":3},{"value":"Endpoint","id":"endpoint","depth":4},{"value":"Query params","id":"query-params","depth":4},{"value":"Example","id":"example","depth":4},{"value":"Response","id":"response","depth":3},{"value":"status","id":"status","depth":4},{"value":"results","id":"results","depth":4},{"value":"error_message","id":"error_message","depth":4},{"value":"Example:","id":"example-1","depth":4}],"frontmatter":{"seo":{"title":"Text Search"}},"lastModified":"2026-09-14T02:30:47.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/search/latest/textsearch","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}