COUNTRY-STATE-CITY
Country State City API Data Retrieval Script Documentation
GET https://api.kosontechnology.com/country-state-city.php
Path Parameters
| Name | Type | Description |
|---|---|---|
country | String | To specify the desired country. |
state | String | to specify the desired state within the selected country. |
city | String | To specify the desired city within the selected country and state |
download | - | To download the json file |
This API script is designed to retrieve information from the CountryStateCity API using provided parameters. The script constructs the appropriate URL based on the parameters provided and then fetches data from the API. Please follow the instructions below to use this script effectively.
Usage
Making an HTTP request via a web browser or API Platform etc. Postman.
The following parameters are accepted:
| Name | Description | Format |
|---|---|---|
country | To specify the desired country. |
|
state | To specify the desired state within the selected country. |
|
city | To specify the desired city within the selected country and state. |
|
download | To download the JSON output |
|
Depending on the parameters provided, the script will construct a URL to fetch information from the CountryStateCity API.
Parameter Guidelines
countryParameter:If you provide a
countryparameter as 'all' or 'ALL', the script will retrieve information about all countries.If you specify a valid country ISO2 Code as the
countryparameter, the script will retrieve information about that specific country.
stateParameter:If you provide a
stateparameter as 'all' or 'ALL' in addition to thecountryparameter, the script will retrieve information about all states within the selected country.If you specify a valid state ISO2 Code as the
stateparameter, the script will retrieve information about that specific state within the selected country.
cityParameter:If you provide a
cityparameter as 'all' or 'ALL' in addition to thecountryandstateparameters, the script will retrieve information about all cities within the selected state and country.
downloadParameter:If you want to download the JSON output of these parameter, define the parameter with empty or any input will able you to auto download it. See the download sample at here.
ISO2 Code
Refer this wikipedia to find your ISO2 Code.
Below is a sample how to find Malaysia ISO2 Code:
Find Malaysia and you will see country code at the left column.
Onclick on the code then wikipedia with direct you to ISO 3166-2:MY where you can find its state code.
Demo
Retrieve information about all countries:
Retrieve information about a specific country:
Retrieve information about all states:
Retrieve information about all states within a specific country:
Retrieve information about a specific state within a specific country:
Retrieve information about all cities within a specific state and country:
Retrieve information about all cities within a specific country:
Download
Add download parameter to download the output json, below is some example of it:
Last updated
