location / تقسیمات کشوری

شرح خدمت

سرویس ارائه تقسیمات کشوری (استان / شهرستان / شهر) بر اساس دیتای ارائه شده توسط وزارت کشور

برای فراخوانی api-key الزامیست.

1. فهرست استانها


                    url: https://api.i-data.ir/location/province
                    

                    method: get

مقدار فیلد result برگشتی آرایه‌ای مانند نمونه زیر


        {
            "id": 1,
            "name": "tehran",
            "caption": "تهران",
            "lat": "35.699731",
            "lon": "51.33805",
            "area_code": "021"
        }

اجزای کلاس پاسخ به شرح زیر می باشد:

id : شناسه یکتا استان
name : نام لاتین استان، این نام یکتا می‌باشد.
caption : عنوان استان
lat : مقدار lat در نقشه گوگل
lon : مقدار lon در نقشه گوگل
area_code : پیشماره تلفن منطقه

2. فهرست شهرستانهای یک استان


                    url: https://api.i-data.ir/location/township-in-province/{id_or_name}
                    

                    method: get

id_or_name : شناسه یا نام لاتین استان

مقدار فیلد result برگشتی آرایه‌ای مانند نمونه زیر

{
"id": 101,
"name": "tehran",
"caption": "تهران"}

اجزای کلاس پاسخ به شرح زیر می باشد:

id : شناسه یکتا شهرستان
name : نام لاتین شهرستان، این نام در سطح استان یکتا می‌باشد.
caption : عنوان شهرستان

3. فهرست شهرهای یک استان


                    url: https://api.i-data.ir/location/city-in-province/{id_or_name}
                    

                    method: get

id_or_name : شناسه یا نام لاتین استان

مقدار فیلد result برگشتی آرایه‌ای مانند نمونه زیر

{
"id": 101001,
            "name": "tehran",
            "caption": "تهران",
            "lat": "35.699731",
            "lon": "51.33805"}

اجزای کلاس پاسخ به شرح زیر می باشد:

id : شناسه یکتا شهر
name : نام لاتین شهر، این نام در سطح استان یکتا می‌باشد.
caption : عنوان شهر
lat : مقدار lat در نقشه گوگل *
lon : مقدار lon در نقشه گوگل *

مقدار lat و lon برای تمامی شهرها موجود نمی‌باشد. اما مراکز استان و شهرهای مهم این مقدار را دارند.

4. فهرست شهرهای یک شهرستان


                    url: https://api.i-data.ir/location/city-in-township/{id_or_name}
                    

                    method: get

id_or_name : شناسه یا نام لاتین شهرستان

مقدار فیلد result برگشتی آرایه‌ای مانند نمونه زیر

{
"id": 101001,
            "name": "tehran",
            "caption": "تهران",
            "lat": "35.699731",
            "lon": "51.33805"}

اجزای کلاس پاسخ به شرح زیر می باشد:

id : شناسه یکتا شهر
name : نام لاتین شهر، این نام در سطح استان یکتا می‌باشد.
caption : عنوان شهر
lat : مقدار lat در نقشه گوگل *
lon : مقدار lon در نقشه گوگل *

مقدار lat و lon برای تمامی شهرها موجود نمی‌باشد. اما مراکز استان و شهرهای مهم این مقدار را دارند.

4. فهرست استانها به همراه اطلاعات مرکز استان


                    url: https://api.i-data.ir/location/province-center
                    

                    method: get

مقدار فیلد result برگشتی آرایه‌ای مانند نمونه زیر

{
            "province_id": 1,
            "province_name": "tehran",
            "province_caption": "تهران",
            "city_id": 101001,
            "city_name": "tehran",
            "city_caption": "تهران",
            "city_lat": "35.699731",
            "city_lon": "51.33805"}

اجزای کلاس پاسخ به شرح زیر می باشد:

province_id : شناسه یکتا استان
province_name : نام لاتین استان
province_caption : عنوان استان
city_id : شناسه یکتا شهر مرکز استان
city_name : نام لاتین شهر مرکز استان.
city_caption : عنوان شهر مرکز استان
city_lat : مقدار lat در نقشه گوگل
city_lon : مقدار lon در نقشه گوگل

نمونه کد جاوا اسکریپت


                    <script>

                    const myHeaders = new Headers();

    myHeaders.append("api-key", "1-XXXXXXXXXXXXXX");

    const requestOptions = {

        method: "GET",

        headers: myHeaders,

        redirect: "follow"

    };

    
    fetch("https://api.i-data.ir/location/province-center", requestOptions)

    .then((response) => response.json())

    .then((result) => console.log(result))

    .catch((error) => console.error(error));

    </script>