Endpoint
GET/geo/provincesDanh sách tỉnh thành phốGET/geo/districtsDanh sách quận huyệnGET/geo/communesDanh sách phường xãDanh sách tỉnh thành phố
GET
/geo/provincesLấy danh sách tỉnh thành phố
Tham số truy vấn
country_codestringbắt buộcMã quốc gia (ví dụ mã quốc gia Viet Nam là 84)
is_newbooleanTỉnh thành mới (với quốc gia Viet Nam)
allbooleanTỉnh thành gồm cả cũ và mới (với quốc gia Viet Nam)
Phản hồi
object
dataarray<object>Yêu cầu
curl "https://pos.pages.fm/api/v1/geo/provinces?api_key=API_KEY&country_code=84"Phản hồi 200
{
"data": [
{
"id": "101",
"name": "Hà Nội",
"name_en": "ha noi",
"new_id": "84_VN101"
},
{
"id": "701",
"name": "Hồ Chí Minh",
"name_en": "ho chi minh",
"new_id": "84_VN129"
}
]
}Danh sách quận huyện
GET
/geo/districtsLấy danh sách quận huyện
Tham số truy vấn
province_idstringbắt buộcMã tỉnh thành phố của các quận huyện bạn muốn lấy. Lấy mã tỉnh thành phố trong api GET /geo/provinces
Phản hồi
object
dataarray<object>Yêu cầu
curl "https://pos.pages.fm/api/v1/geo/districts?api_key=API_KEY&province_id=101"Phản hồi 200
{
"data": [
{
"id": "10101",
"name": "Quận Ba Đình",
"name_en": "ba dinh",
"province_id": "101"
}
]
}Danh sách phường xã
GET
/geo/communesLấy danh sách phường xã
Tham số truy vấn
district_idstringbắt buộcMã quận huyện của các phường xã bạn muốn lấy. Lấy mã quận huyện trong api GET /geo/districts
province_idstringbắt buộcMã tỉnh thành phố của các phường xã bạn muốn lấy. Lấy mã tỉnh thành phố trong api GET /geo/provinces
Phản hồi
object
dataarray<object>Yêu cầu
curl "https://pos.pages.fm/api/v1/geo/communes?api_key=API_KEY&district_id=DISTRICT_ID&province_id=PROVINCE_ID"Phản hồi 200
{
"data": [
{
"district_id": "10101",
"id": "1010115",
"name": "Phường Cống Vị",
"name_en": "cong vi",
"new_id": null,
"postcode": null,
"province_id": "101"
}
]
}