API Search
Cho phép tìm kiếm thông tin toạ độ địa lý, thông tin chi tiết từ địa chỉ
GET https://apis.wemap.asia/geocode-1/search?text={TRUY_VẤN}&key={API_KEY_CỦA_BẠN}
| Thông số bắt buộc |
Kiểu giá trị |
Miêu tả |
text |
string |
Truy vấn tìm kiếm |
key |
string |
API key của bạn. Cách khởi tạo một API key xem tại đây. |
| Thông số tuỳ chọn |
Kiểu giá trị |
Miêu tả |
Mặc định |
location.lat |
floating point number |
Vĩ độ của điểm ưu tiên kết quả tìm kiếm theo vị trí. |
Không |
location.lon |
floating point number |
Kinh độ của điểm ưu tiên kết quả tìm kiếm theo vị trí. |
Không |
bbox.min_lon |
floating point number |
Tối ưu tìm kiếm theo vùng. Giới hạn vĩ độ dưới. |
Không |
bbox.max_lon |
floating point number |
Tối ưu tìm kiếm theo vùng. Giới hạn vĩ độ trên. |
Không |
bbox.min_lat |
floating point number |
Tối ưu tìm kiếm theo vùng. Giới hạn kinh độ dưới. |
Không |
bbox.max_lat |
floating point number |
Tối ưu tìm kiếm theo vùng. Giới hạn kinh độ trên. |
Không |
size |
integer |
Giới hạn số lượng kết quả. Nằm trong khoảng từ 1 đến 25. |
10 |
boundary.gid |
integer |
ID của vùng giới hạn kết quả tìm kiếm. |
Không |
categories |
string |
Giới hạn tìm kiếm theo loại địa điểm. Danh sách loại địa điểm được hỗ trợ: transport (thuộc vận tải), recreation (thuộc giải trí), religion (thuộc tôn giáo), education (thuộc giáo dục), entertainment (thuộc vui chơi giải trí), nightlife (thuộc hoạt động ban đêm), food (thuộc ẩm thực), government (thuộc chính phủ), professional (thuộc tổ chức chuyên nghiệp), finance (thuộc tài chính), health (thuộc sức khỏe), retail (thuộc bán lẻ), accommodation (thuộc nhà ở), industry (thuộc công nghiệp), natural (thuộc tự nhiên). |
Không |
Ví dụ tìm kiếm một địa điểm
# Tìm kiếm địa chỉ '135 Cầu Giấy', ưu tiên những vị trí gần địa điểm có vĩ độ 21.02466500456443 và kinh độ 105.79323291778566, giới hạn 10 kết quả
$ curl "https://apis.wemap.asia/geocode-1/search?text=135 cầu giấy&location.lat=21.02466500456443&location.lon=105.79323291778566&size=10&key={API_KEY_CỦA_BẠN}"
# Tìm kiếm địa chỉ 'Trường Đại học Sư phạm', giới hạn kết quả tại thành phố Hà Nội (mã vùng 18410000), giới hạn 10 kết quả
# Vui lòng liên hệ với nhóm phát triển để biết thêm thông tin về mã vùng.
$ curl "https://apis.wemap.asia/geocode-1/search?text=Trường Đại học Sư Phạm&boundary.gid=18410000&size=10&key={API_KEY_CỦA_BẠN}"
# Tìm kiếm địa chỉ 'Nhà D1', thuộc lĩnh vực giáo dục ở thành phố Hà Nội (mã vùng 18410000), ưu tiên những vị trí gần địa điểm có vĩ độ 21.02466500456443 và kinh độ 105.79323291778566, giới hạn 10 kết quả
$ curl "https://apis.wemap.asia/geocode-1/search?text=Nhà D1&categories=education&boundary.gid=18410000&location.lat=21.02466500456443&location.lon=105.79323291778566&size=10&key={API_KEY_CỦA_BẠN}"
Phản hồi
Phản hồi là danh sách các kết quả phù hợp với truy vấn ở định dạng JSON.
| Trường |
Kiểu dữ liệu |
Miêu tả |
features |
Mảng |
Danh sách các kết quả tìm kiếm theo định dạng FeatureCollection |
type |
Chuỗi |
Kiểu dữ liệu trả về. Hiện tại FeatureCollection |
{
"geocoding":{
"version":"0.2",
"attribution":"http://over.wemap.vn:3100/attribution",
"query":{
"text":"135 cầu giấy",
"size":10,
"private":false,
"location.lat":21.02466500456443,
"location.lon":105.79323291778566,
"lang":{
"name":"English",
"iso6391":"en",
"iso6393":"eng",
"via":"header",
"defaulted":false
},
"querySize":20,
"parser":"libpostal",
"parsed_text":{
"housenumber":"135",
"street":"cầu giấy"
}
},
"warnings":[
"Invalid Parameter: limit",
"Invalid Parameter: key"
],
"engine":{
"name":"WeMap",
"author":"WeMap",
"version":"1.0"
},
"timestamp":1604393461152
},
"type":"FeatureCollection",
"features":[
{
"type":"Feature",
"geometry":{
"type":"Point",
"coordinates":[
105.799508,
21.031772
]
},
"properties":{
"id":"node/4875015",
"gid":"openstreetmap:address:node/4875015",
"layer":"address",
"source":"openstreetmap",
"source_id":"node/4875015",
"name":"135 Đường Cầu Giấy",
"housenumber":"135",
"street":"Đường Cầu Giấy",
"confidence":1,
"match_type":"exact",
"distance":1.025,
"accuracy":"point",
"country":"Vietnam",
"country_gid":"whosonfirst:country:18400000",
"country_a":"VNM",
"region":"Ha Noi",
"region_gid":"whosonfirst:region:18410000",
"region_a":"HN",
"county":"Cau Giay",
"county_gid":"whosonfirst:county:18411300",
"locality":"Quan Hoa",
"locality_gid":"whosonfirst:locality:18411306",
"continent":"Asia",
"continent_gid":"whosonfirst:continent:10000000",
"label":"135 Đường Cầu Giấy, Quan Hoa, Vietnam"
}
},
{
"type":"Feature",
"geometry":{
"type":"Point",
"coordinates":[
105.774537,
21.040128
]
},
"properties":{
"id":"node/4852248",
"gid":"openstreetmap:address:node/4852248",
"layer":"address",
"source":"openstreetmap",
"source_id":"node/4852248",
"name":"135 Mai Dịch Cầu Giấy",
"housenumber":"135",
"street":"Mai Dịch Cầu Giấy",
"confidence":1,
"match_type":"exact",
"distance":2.595,
"accuracy":"point",
"country":"Vietnam",
"country_gid":"whosonfirst:country:18400000",
"country_a":"VNM",
"region":"Ha Noi",
"region_gid":"whosonfirst:region:18410000",
"region_a":"HN",
"county":"Cau Giay",
"county_gid":"whosonfirst:county:18411300",
"locality":"Mai Dich",
"locality_gid":"whosonfirst:locality:18411309",
"continent":"Asia",
"continent_gid":"whosonfirst:continent:10000000",
"label":"135 Mai Dịch Cầu Giấy, Mai Dich, Vietnam"
}
}
],
"bbox":[
105.774537,
21.031772,
105.799508,
21.040128
]
}
Các mã lỗi của API Search
Trường message trong phần thân phản hồi |
Mã lỗi HTTP |
Miêu tả |
Lỗi xác thực - Thiếu API key |
401 |
Thông số key là bắt buộc |
Lỗi xác thực - Sai API key |
401 |
Kiểm tra lại thông số key |