🌎Country, city/county and region

Country

GET https://{API_DOMAIN}/api/v1/state

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/country?per_page=3"

Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
page	false	1	Number	Which page is currently on
per_page	false	15	Number	How many items to display per page

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	Country array
meta	Object	Pagination meta

{
    "data": [
        {
            "id": 1,
            "name": "Taiwan",
            "abbrev": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": "3",
        "to": 1,
        "total": 1
    }
}

State/County

GET https://{API_DOMAIN}/api/v1/state‌

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/state?per_page=3"

Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
page	false	1	Number	Which page is currently on
per_page	false	15	Number	How many items to display per page
name	false	NULL	String	County/City name

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	State/County array
meta	Object	Pagination meta

{
    "data": [
        {
            "id": 2,
            "country_id": 1,
            "name": "Keelung City",
            "country": {
                "id": 1,
                "name": "Taiwan",
                "abbrev": null
            }
        },
        {
            "id": 3,
            "country_id": 1,
            "name": "Taipei City",
            "country": {
                "id": 1,
                "name": "Taiwan",
                "abbrev": null
            }
        },
        {
            "id": 4,
            "country_id": 1,
            "name": "New Taipei City",
            "country": {
                "id": 1,
                "name": "Taiwan",
                "abbrev": null
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 8,
        "per_page": "3",
        "to": 3,
        "total": 23
    }
}

District

GET https://{API_DOMAIN}/api/v1/city

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/city?per_page=3"

Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
page	false	1	Number	Which page is currently on
per_page	false	15	Number	How many items to display per page
state_id	false	NULL	Number	State/Countyid of
zipcode	false	NULL	Number	Postal code
name	false	NULL	String	Postal district name

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	District array
meta	Object	Pagination meta

{
    "data": [
        {
            "id": 1,
            "state_id": 2,
            "state": {
                "id": 2,
                "country_id": 1,
                "name": "Keelung City"
            },
            "name": "Ren'ai District",
            "zipcode": "200"
        },
        {
            "id": 2,
            "state_id": 2,
            "state": {
                "id": 2,
                "country_id": 1,
                "name": "Keelung City"
            },
            "name": "Xinyi District",
            "zipcode": "201"
        },
        {
            "id": 3,
            "state_id": 2,
            "state": {
                "id": 2,
                "country_id": 1,
                "name": "Keelung City"
            },
            "name": "Zhongzheng District",
            "zipcode": "202"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 124,
        "per_page": "3",
        "to": 3,
        "total": 371
    }
}