Administrative API
Administrative API GTEL MAPS cung cấp dữ liệu về các đơn vị hành chính, bao gồm quốc gia, tỉnh/thành phố, phường/xã và các hình dạng địa lý của địa điểm cụ thể.
Danh sách tỉnh/thành phố
Loading...
Tham số
| Tham số tuỳ chọn | Kiểu dữ liệu | Mô tả |
|---|---|---|
codes | string | Danh sách mã tỉnh/thành phố, phân tách bằng dấu phẩy (01,79,48). Nếu không truyền codes sẽ trả về danh sách tất cả tỉnh/thành phố. |
fields | string | Danh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy: - id (default): Mã định danh duy nhất.- geom: Trường tọa độ.- prov_code (default): Mã tỉnh/thành phố.- prov_name: Tên tỉnh/thành phố.- prov_fname (default): Tên đầy đủ tỉnh/thành phố (tiếng Việt).- prov_ne: Tên tỉnh/thành phố (tiếng Anh).- prov_fne (default): Tên đầy đủ tỉnh/thành phố (tiếng Anh).- level (default): Cấp tỉnh/thành phố.- region (default): Khu vực địa lý.- center: Tọa độ trung tâm.- viewport: Khung nhìn bao quanh.- sort (default): Sắp xếp thứ tự hiển thị. |
include_geom | boolean | Trả về trường geom nếu giá trị là true mặc định là false. |
geom_level | string | Mức độ chi tiết của trường geom nếu có trong phản hồi. Chỉ áp dụng khi phản hồi có trường geom. Giá trị: - auto (mặc định): Server tự chọn mức phù hợp để cân bằng tốc độ và độ chi tiết.- country: Dạng hình tổng quát cho hiển thị toàn quốc. Nhẹ nhất, dùng cho mức zoom rất xa.- province: Hình ranh giới cấp tỉnh/thành. Cân bằng giữa dung lượng và chi tiết.- ward: Chi tiết đến cấp phường/xã. Nặng hơn, phù hợp khi zoom gần.- street: Chi tiết cao nhất theo mức đường phố. Nặng nhất, chỉ dùng khi cần độ chính xác cao ở mức rất gần. |
Headers
| Header | Kiểu dữ liệu | Mô tả |
|---|---|---|
app-version | string | Bắt buộc. Phiên bản API: 1.1 |
Yêu cầu và phản hồi mẫu: Danh sách tỉnh/thành phố
Loading API request...
{
"data": [
{
"id": 5,
"prov_code": "79",
"prov_fname": "Thành phố Hồ Chí Minh",
"prov_fne": "Ho Chi Minh City",
"level": "Thành phố Trung ương",
"sort": "1"
},
{
"id": 4,
"prov_code": "01",
"prov_fname": "Thành phố Hà Nội",
"prov_fne": "Ha Noi City",
"level": "Thành phố Trung ương",
"sort": "2"
}
// ... (more provinces)
],
"licence": "© GTEL Maps"
}
Mô tả các trường phản hồi
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
data | array | Mảng danh sách các tỉnh/thành phố. |
data[].id | integer | Mã định danh duy nhất của tỉnh/thành phố. |
data[].geom | object | Thông tin hình học (geometry) của tỉnh/thành phố. |
data[].geom.type | string | Loại hình học, thường là "MultiPolygon". |
data[].geom.coordinates | array | Mảng tọa độ định nghĩa ranh giới hành chính. |
data[].prov_code | string | Mã tỉnh/thành phố (2 chữ số). |
data[].prov_name | string | Tên ngắn gọn của tỉnh/thành phố. |
data[].prov_fname | string | Tên đầy đủ của tỉnh/thành phố (tiếng Việt). |
data[].prov_ne | string | Tên tỉnh/thành phố (tiếng Anh không dấu). |
data[].prov_fne | string | Tên đầy đủ tỉnh/thành phố (tiếng Anh). |
data[].level | string | Cấp hành chính (tỉnh, thành phố trung ương, v.v.). |
data[].region | string | Khu vực địa lý (Đồng bằng sông Hồng, v.v.). |
data[].sort | string | Thứ tự sắp xếp hiển thị. |
data[].geomLevel | string | Mức độ chi tiết geometry được áp dụng. |
data[].center | object | Tọa độ trung tâm của tỉnh/thành phố. |
data[].center.lat | number | Vĩ độ của điểm trung tâm. |
data[].center.lng | number | Kinh độ của điểm trung tâm. |
data[].viewport | object | Khung nhìn bao quanh tỉnh/thành phố. |
data[].viewport.northeast | object | Tọa độ góc đông bắc của khung nhìn. |
data[].viewport.northeast.lat | number | Vĩ độ góc đông bắc. |
data[].viewport.northeast.lng | number | Kinh độ góc đông bắc. |
data[].viewport.southwest | object | Tọa độ góc tây nam của khung nhìn. |
data[].viewport.southwest.lat | number | Vĩ độ góc tây nam. |
data[].viewport.southwest.lng | number | Kinh độ góc tây nam. |
licence | string | Thông tin bản quyền của dữ liệu. |
Chi tiết tỉnh/thành phố
Loading...
Tham số
| Tham số bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|
code | string | Mã của cấp tỉnh/thành phố. |
| Tham số tuỳ chọn | Kiểu dữ liệu | Mô tả |
|---|---|---|
fields | string | Danh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy: - id (default): Mã định danh duy nhất.- geom: Trường tọa độ.- prov_code (default): Mã tỉnh/thành phố.- prov_name: Tên tỉnh/thành phố.- prov_fname (default): Tên đầy đủ tỉnh/thành phố (tiếng Việt).- prov_ne: Tên tỉnh/thành phố (tiếng Anh).- prov_fne (default): Tên đầy đủ tỉnh/thành phố (tiếng Anh).- level (default): Cấp tỉnh/thành phố.- region (default): Khu vực địa lý.- center: Tọa độ trung tâm.- viewport: Khung nhìn bao quanh.- sort (default): Sắp xếp thứ tự hiển thị. |
geom_level | string | Mức độ chi tiết của trường geom nếu có trong phản hồi. Chỉ áp dụng khi phản hồi có trường geom. Giá trị: - auto (mặc định): Server tự chọn mức phù hợp để cân bằng tốc độ và độ chi tiết.- country: Dạng hình tổng quát cho hiển thị toàn quốc. Nhẹ nhất, dùng cho mức zoom rất xa.- province: Hình ranh giới cấp tỉnh/thành. Cân bằng giữa dung lượng và chi tiết.- ward: Chi tiết đến cấp phường/xã. Nặng hơn, phù hợp khi zoom gần.- street: Chi tiết cao nhất theo mức đường phố. Nặng nhất, chỉ dùng khi cần độ chính xác cao ở mức rất gần. |
Headers
| Header | Kiểu dữ liệu | Mô tả |
|---|---|---|
app-version | string | Bắt buộc. Phiên bản API: 1.1 |
Yêu cầu và phản hồi mẫu: Chi tiết tỉnh/thành phố
Loading API request...
{
"status": "OK",
"data": {
"id": 4,
"prov_fname": "Thành phố Hà Nội",
"prov_code": "01",
"prov_name": "Hà Nội",
"geomLevel": "ward",
"center": {
"lat": 20.99896666957046,
"lng": 105.69998988421155
},
"viewport": {
"northeast": {
"lat": 21.385406764000038,
"lng": 105.28535904500006
},
"southwest": {
"lat": 20.564307720000045,
"lng": 106.02007642700005
}
}
},
"licence": "© GTEL Maps"
}
Mô tả các trường phản hồi
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
status | string | Trạng thái của request: "OK" (thành công) hoặc "ERROR" (lỗi). |
data | object | Dữ liệu tỉnh/thành phố được trả về. |
data.id | integer | Mã định danh duy nhất của tỉnh/thành phố. |
data.geom | object | Thông tin hình học (geometry) của tỉnh/thành phố. |
data.geom.type | string | Loại hình học, thường là "MultiPolygon". |
data.geom.coordinates | array | Mảng tọa độ định nghĩa ranh giới hành chính. |
data.prov_code | string | Mã tỉnh/thành phố (2 chữ số). |
data.prov_name | string | Tên ngắn gọn của tỉnh/thành phố. |
data.prov_fname | string | Tên đầy đủ của tỉnh/thành phố (tiếng Việt). |
data.prov_ne | string | Tên tỉnh/thành phố (tiếng Anh không dấu). |
data.prov_fne | string | Tên đầy đủ tỉnh/thành phố (tiếng Anh). |
data.level | string | Cấp hành chính (tỉnh, thành phố trung ương, v.v.). |
data.region | string | Khu vực địa lý (Đồng bằng sông Hồng, v.v.). |
data.geomLevel | string | Mức độ chi tiết geometry được áp dụng. |
data.center | object | Tọa độ trung tâm của tỉnh/thành phố. |
data.center.lat | number | Vĩ độ của điểm trung tâm. |
data.center.lng | number | Kinh độ của điểm trung tâm. |
data.viewport | object | Khung nhìn bao quanh tỉnh/thành phố. |
data.viewport.northeast | object | Tọa độ góc đông bắc của khung nhìn. |
data.viewport.northeast.lat | number | Vĩ độ góc đông bắc. |
data.viewport.northeast.lng | number | Kinh độ góc đông bắc. |
data.viewport.southwest | object | Tọa độ góc tây nam của khung nhìn. |
data.viewport.southwest.lat | number | Vĩ độ góc tây nam. |
data.viewport.southwest.lng | number | Kinh độ góc tây nam. |
licence | string | Thông tin bản quyền của dữ liệu. |
Danh sách phường/xã
Loading...
Tham số
| Tham số bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|
codes | string | Danh sách mã phường/xã, phân tách bằng dấu phẩy (00130,00136). codes và prov_code không được truyền cùng lúc. |
prov_code | string | Mã tỉnh/thành phố (nếu không truyền codes). |
| Tham số tuỳ chọn | Kiểu dữ liệu | Mô tả |
|---|---|---|
fields | string | Danh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy: - id (default): Mã định danh duy nhất.- geom: Trường tọa độ.- prov_code (default): Mã tỉnh/thành phố.- ward_code (default): Mã phường/xã.- ward_name: Tên phường/xã.- ward_fname (default): Tên đầy đủ phường/xã (tiếng Việt).- ward_ne: Tên phường/xã (tiếng Anh).- ward_fne (default): Tên đầy đủ phường/xã (tiếng Anh).- level (default): Cấp phường/xã.- region (default): Khu vực địa lý.- center: Tọa độ trung tâm.- viewport: Khung nhìn bao quanh. |
include_geom | boolean | Trả về trường geom nếu giá trị là true mặc định là false. |
page | integer | Số trang (mặc định 1) chỉ suport khi không truyền codes. |
size | integer | Số lượng bản ghi trên mỗi trang (mặc định 10) chỉ suport khi không truyền codes. |
Headers
| Header | Kiểu dữ liệu | Mô tả |
|---|---|---|
app-version | string | Bắt buộc. Phiên bản API: 1.1 |
Yêu cầu và phản hồi mẫu: Danh sách phường/xã
Loading API request...
{
"data": [
{
"id": 26,
"prov_code": "01",
"ward_code": "00316",
"ward_fname": "Phường Định Công",
"ward_fne": "Dinh Cong Ward",
"level": "Phường"
},
{
"id": 10,
"prov_code": "01",
"ward_code": "00130",
"ward_fname": "Phường Bồ Đề",
"ward_fne": "Bo De Ward",
"level": "Phường"
},
{
"id": 88,
"prov_code": "01",
"ward_code": "09832",
"ward_fname": "Xã Hoài Đức",
"ward_fne": "Hoai Duc Commune",
"level": "Xã"
}
// ... (more wards)
],
"meta": {
"pagination": {
"total": 126,
"currentPage": 1,
"pageSize": 10,
"totalPages": 13
}
},
"licence": "© GTEL Maps"
}
Mô tả các trường phản hồi
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
data | array | Mảng danh sách các phường/xã. |
data[].id | integer | Mã định danh duy nhất của phường/xã. |
data[].geom | object | Thông tin hình học (geometry) của phường/xã. |
data[].geom.type | string | Loại hình học, thường là "MultiPolygon". |
data[].geom.coordinates | array | Mảng tọa độ định nghĩa ranh giới hành chính. |
data[].prov_code | string | Mã tỉnh/thành phố chứa phường/xã này. |
data[].ward_code | string | Mã phường/xã (5 chữ số). |
data[].ward_name | string | Tên ngắn gọn của phường/xã. |
data[].ward_fname | string | Tên đầy đủ của phường/xã (tiếng Việt). |
data[].ward_ne | string | Tên phường/xã (tiếng Anh không dấu). |
data[].ward_fne | string | Tên đầy đủ của phường/xã (tiếng Anh). |
data[].level | string | Cấp hành chính (phường, xã, thị trấn, v.v.). |
data[].region | string | Khu vực địa lý. |
data[].center | object | Tọa độ trung tâm của phường/xã. |
data[].center.lat | number | Vĩ độ của điểm trung tâm. |
data[].center.lng | number | Kinh độ của điểm trung tâm. |
data[].viewport | object | Khung nhìn bao quanh phường/xã. |
data[].viewport.northeast | object | Tọa độ góc đông bắc của khung nhìn. |
data[].viewport.northeast.lat | number | Vĩ độ góc đông bắc. |
data[].viewport.northeast.lng | number | Kinh độ góc đông bắc. |
data[].viewport.southwest | object | Tọa độ góc tây nam của khung nhìn. |
data[].viewport.southwest.lat | number | Vĩ độ góc tây nam. |
data[].viewport.southwest.lng | number | Kinh độ góc tây nam. |
meta | object | Thông tin metadata của response. |
meta.pagination | object | Thông tin phân trang. |
meta.pagination.total | integer | Tổng số phường/xã. |
meta.pagination.currentPage | integer | Trang hiện tại. |
meta.pagination.pageSize | integer | Số lượng items trên mỗi trang. |
meta.pagination.totalPages | integer | Tổng số trang. |
licence | string | Thông tin bản quyền của dữ liệu. |
Chi tiết phường/xã
Loading...
Tham số
| Tham số bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|
code | string | Mã của cấp phường/xã. |
| Tham số tuỳ chọn | Kiểu dữ liệu | Mô tả |
|---|---|---|
fields | string | Danh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy: - id (default): Mã định danh duy nhất.- geom: Trường tọa độ.- prov_code (default): Mã tỉnh/thành phố.- ward_code (default): Mã phường/xã.- ward_name: Tên phường/xã.- ward_fname (default): Tên đầy đủ phường/xã (tiếng Việt).- ward_ne: Tên phường/xã (tiếng Anh).- ward_fne (default): Tên đầy đủ phường/xã (tiếng Anh).- level (default): Cấp phường/xã.- region (default): Khu vực địa lý.- center: Tọa độ trung tâm.- viewport: Khung nhìn bao quanh. |
Headers
| Header | Kiểu dữ liệu | Mô tả |
|---|---|---|
app-version | string | Bắt buộc. Phiên bản API: 1.1 |
Yêu cầu và phản hồi mẫu: Chi tiết phường/xã
Loading API request...
{
"status": "OK",
"data": {
"id": 26,
"prov_code": "01",
"ward_code": "00316",
"ward_name": "Định Công",
"center": {
"lat": 20.978950837551672,
"lng": 105.82572498634337
},
"viewport": {
"northeast": {
"lat": 20.995024159000025,
"lng": 105.80833014300003
},
"southwest": {
"lat": 20.965437053000073,
"lng": 105.84076598700005
}
}
},
"licence": "© GTEL Maps"
}
Mô tả các trường phản hồi
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
status | string | Trạng thái của request: "OK" (thành công) hoặc "ERROR" (lỗi). |
data | object | Dữ liệu phường/xã được trả về. |
data.id | integer | Mã định danh duy nhất của phường/xã. |
data.geom | object | Thông tin hình học (geometry) của phường/xã. |
data.geom.type | string | Loại hình học, thường là "MultiPolygon". |
data.geom.coordinates | array | Mảng tọa độ định nghĩa ranh giới hành chính. |
data.prov_code | string | Mã tỉnh/thành phố chứa phường/xã này. |
data.ward_code | string | Mã phường/xã (5 chữ số). |
data.ward_name | string | Tên ngắn gọn của phường/xã. |
data.ward_fname | string | Tên đầy đủ của phường/xã (tiếng Việt). |
data.ward_ne | string | Tên phường/xã (tiếng Anh không dấu). |
data.ward_fne | string | Tên đầy đủ của phường/xã (tiếng Anh). |
data.level | string | Cấp hành chính (phường, xã, thị trấn, v.v.). |
data.region | string | Khu vực địa lý. |
data.center | object | Tọa độ trung tâm của phường/xã. |
data.center.lat | number | Vĩ độ của điểm trung tâm. |
data.center.lng | number | Kinh độ của điểm trung tâm. |
data.viewport | object | Khung nhìn bao quanh phường/xã. |
data.viewport.northeast | object | Tọa độ góc đông bắc của khung nhìn. |
data.viewport.northeast.lat | number | Vĩ độ góc đông bắc. |
data.viewport.northeast.lng | number | Kinh độ góc đông bắc. |
data.viewport.southwest | object | Tọa độ góc tây nam của khung nhìn. |
data.viewport.southwest.lat | number | Vĩ độ góc tây nam. |
data.viewport.southwest.lng | number | Kinh độ góc tây nam. |
licence | string | Thông tin bản quyền của dữ liệu. |