Nearby Search

API Nearby Search GTEL MAPS cho phép tìm kiếm địa điểm xung quanh một vị trí cho trước.

---

Dịch vụ Nearby Search

Loading...

Tham số

Tham số bắt buộc	Kiểu dữ liệu	Mô tả
location	string	Vĩ độ và kinh độ để tìm kiếm xung quanh, theo định dạng lat,lng. Ví dụ: 21.0245,105.8412.
types	string	Loại địa điểm cần tìm kiếm, có thể là một hoặc nhiều giá trị phân cách bằng dấu phẩy. Ví dụ: hospital,restaurant. Xem danh sách đầy đủ tại loại địa điểm.

Tham số tuỳ chọn	Kiểu dữ liệu	Mô tả
bbox	string	Một hộp giới hạn để giới hạn vùng tìm kiếm, theo định dạng top_left_lat,top_left_lng,bottom_right_lat,bottom_right_lng. Nếu được cung cấp, radius sẽ bị bỏ qua.
keyword	string	Từ khoá tìm kiếm, ưu tiên tìm kiếm các địa điểm theo loại địa điểm từ đó tìm kiếm theo từ khóa. Ví dụ: Bệnh viện.
radius	integer	Bán kính tìm kiếm tính bằng mét. Bỏ qua nếu bbox được cung cấp. Mặc định là 10000.
size	integer	Số lượng kết quả trả về nếu không được cung cấp mặc định là 10.
pageToken	string	Token được sử dụng để gọi tải thêm (load more) khi phân trang cho các lần gửi yêu cầu tiếp theo.Token cho trang tiếp theo sẽ được trả về tại meta.pagination.nextPageToken hoặc nằm trong trường pageToken của từng mục (item) trong dữ liệu.

Headers

Header	Kiểu dữ liệu	Mô tả
app-version	string	Bắt buộc. Phiên bản API: 1.1

Cấu trúc phản hồi

Root (response)

Trường	Kiểu dữ liệu	Mô tả
statusCode	number	Mã trạng thái HTTP. 200 khi thành công.
data	object[]	Mảng kết quả địa điểm.
meta.pagination.nextPageToken	string	Token phân trang. Truyền vào tham số pageToken để lấy trang tiếp theo.
licence	string	Giấy phép dữ liệu: "© GTEL Maps".

Data (response.data[])

Thuộc tính	Kiểu dữ liệu	Mô tả
id	string	ID của địa điểm.
types	string[]	Phân loại kết quả. Ví dụ: ["street_address"], ["hospital"]. Xem loại địa điểm.
formattedAddress	string	Địa chỉ định dạng đầy đủ.
nationalPhoneNumber	string	Số điện thoại nội địa.
internationalPhoneNumber	string	Số điện thoại quốc tế.
websiteUri	string	Website (nếu có).
email	string	Địa chỉ email.
distance	number	Khoảng cách từ vị trí tìm kiếm (tính bằng mét).
pageToken	string	Mã phân trang cho mục (item).
addressComponents	object[]	Thành phần địa chỉ phân tách. Xem định nghĩa đầy đủ tại trường address_components.
plusCode.compoundCode	string	Mã địa phương.
plusCode.globalCode	string	Mã toàn cầu.
location.latitude	number	Vĩ độ.
location.longitude	number	Kinh độ.
geometry.type	string	Loại hình học (ví dụ "Point").
geometry.coordinates	number[]	Tọa độ dạng [longitude, latitude].
viewport.low.latitude	number	Vĩ độ của điểm thấp nhất.
viewport.low.longitude	number	Kinh độ của điểm thấp nhất.
viewport.high.latitude	number	Vĩ độ của điểm cao nhất.
viewport.high.longitude	number	Kinh độ của điểm cao nhất.
displayName.text	string	Tên địa điểm hiển thị.
displayName.languageCode	string	Mã ngôn ngữ của tên hiển thị.

Xử lý lỗi

Mã HTTP	Tình huống	Nguyên nhân
401 Unauthorized	Thiếu apikey	Không truyền tham số apikey hoặc giá trị không hợp lệ.
400 Bad Request	Thiếu location	Không truyền location hoặc định dạng không đúng (lat,lng).
400 Bad Request	Thiếu types	Không truyền tham số types.
400 Bad Request	Sai thứ tự bbox	top nhỏ hơn bottom. Truyền theo thứ tự min_lat,min_lon,max_lat,max_lon.

Yêu cầu và phản hồi mẫu

Loading API request...

{
  "statusCode": 200,
  "data": [
    {
      "id": "gm:poi:537ba758-6c6b-4108-9663-1731b47ed684",
      "types": ["company"],
      "nationalPhoneNumber": "",
      "internationalPhoneNumber": "",
      "formattedAddress": "22 Phương Mai, Phường Kim Liên, Thành phố Hà Nội, Việt Nam",
      "addressComponents": [
        {
          "longText": "22",
          "shortText": "22",
          "types": ["street_number"]
        },
        {
          "longText": "Phương Mai",
          "shortText": "Phương Mai",
          "types": ["route"]
        },
        {
          "longText": "Phường Kim Liên",
          "shortText": "Kim Liên",
          "adminCode": "00229",
          "adminLevel": "Phường",
          "types": ["administrative_area_level_2"]
        },
        {
          "longText": "Thành phố Hà Nội",
          "shortText": "Hà Nội",
          "adminCode": "01",
          "adminLevel": "Thành phố",
          "types": ["administrative_area_level_1"]
        },
        {
          "longText": "",
          "shortText": "",
          "types": ["postal_code"]
        },
        {
          "longText": "Việt Nam",
          "shortText": "vn",
          "types": ["country"]
        }
      ],
      "plusCode": {
        "globalCode": "7PH72R4Q+CM",
        "compoundCode": "2R4Q+CM, Phường Kim Liên, Thành phố Hà Nội, Việt Nam"
      },
      "location": {
        "latitude": 21.006089,
        "longitude": 105.839208
      },
      "geometry": {
        "type": "Point",
        "coordinates": [105.839208, 21.006089]
      },
      "viewport": {
        "low": {
          "latitude": 21.002495755300036,
          "longitude": 105.8353589568875
        },
        "high": {
          "latitude": 21.009682244699963,
          "longitude": 105.8430570431125
        }
      },
      "websiteUri": "",
      "email": "",
      "adrFormatAddress": "",
      "displayName": {
        "text": "công ty cô phân chăm soc sưc khoe Nam Viêt",
        "languageCode": "vi"
      },
      "timeZone": {
        "id": "Asia/Ho_Chi_Minh"
      },
      "extras": {},
      "distance": 0.05737568765516521,
      "pageToken": "WzAuMDU3Mzc1Njg3NjU1MTY1MjEsIjUzN2JhNzU4LTZjNmItNDEwOC05NjYzLTE3MzFiNDdlZDY4NCJd"
    },
    {
      "id": "gm:poi:54a22c69-622b-4477-9c61-eee76e86e6d2",
      "types": ["company"],
      "nationalPhoneNumber": "",
      "internationalPhoneNumber": "",
      "formattedAddress": "38/4B- D20 Phương Mai, Phường Kim Liên, Thành phố Hà Nội, Việt Nam",
      "addressComponents": [
        {
          "longText": "38/4B- D20",
          "shortText": "38/4B- D20",
          "types": ["street_number"]
        },
        {
          "longText": "Phương Mai",
          "shortText": "Phương Mai",
          "types": ["route"]
        },
        {
          "longText": "Phường Kim Liên",
          "shortText": "Kim Liên",
          "adminCode": "00229",
          "adminLevel": "Phường",
          "types": ["administrative_area_level_2"]
        },
        {
          "longText": "Thành phố Hà Nội",
          "shortText": "Hà Nội",
          "adminCode": "01",
          "adminLevel": "Thành phố",
          "types": ["administrative_area_level_1"]
        },
        {
          "longText": "",
          "shortText": "",
          "types": ["postal_code"]
        },
        {
          "longText": "Việt Nam",
          "shortText": "vn",
          "types": ["country"]
        }
      ],
      "plusCode": {
        "globalCode": "7PH72R4Q+FH",
        "compoundCode": "2R4Q+FH, Phường Kim Liên, Thành phố Hà Nội, Việt Nam"
      },
      "location": {
        "latitude": 21.006241,
        "longitude": 105.838935
      },
      "geometry": {
        "type": "Point",
        "coordinates": [105.838935, 21.006241]
      },
      "viewport": {
        "low": {
          "latitude": 21.002647755300035,
          "longitude": 105.83508595296657
        },
        "high": {
          "latitude": 21.009834244699963,
          "longitude": 105.84278404703345
        }
      },
      "websiteUri": "",
      "email": "",
      "adrFormatAddress": "",
      "displayName": {
        "text": "Công Ty TNHH Nghiên Cứu Chế Tạo Và Chuyển Giao Công Nghệ Thiết Bị Y Tế",
        "languageCode": "vi"
      },
      "timeZone": {
        "id": "Asia/Ho_Chi_Minh"
      },
      "extras": {},
      "distance": 0.06931808943443309,
      "pageToken": "WzAuMDY5MzE4MDg5NDM0NDMzMDksIjU0YTIyYzY5LTYyMmItNDQ3Ny05YzYxLWVlZTc2ZTg2ZTZkMiJd"
    }
  ],
  "meta": {
    "pagination": {
      "nextPageToken": "WzAuMDY5MzE4MDg5NDM0NDMzMDksIjU0YTIyYzY5LTYyMmItNDQ3Ny05YzYxLWVlZTc2ZTg2ZTZkMiJd"
    }
  },
  "licence": "© GTEL Maps"
}