COUNTRY-STATE-CITY
Country State City API Data Retrieval Script Documentation
Last updated
Country State City API Data Retrieval Script Documentation
Last updated
GET https://api.kosontechnology.com/country-state-city.php
| Name | Type | Description |
|---|---|---|
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.
Making an HTTP request via a web browser or API Platform etc. Postman.
The following parameters are accepted:
| Name | Description | Format |
|---|---|---|
Depending on the parameters provided, the script will construct a URL to fetch information from the CountryStateCity API.
country Parameter:
If you provide a country parameter as 'all' or 'ALL', the script will retrieve information about all countries.
If you specify a valid country ISO2 Code as the country parameter, the script will retrieve information about that specific country.
state Parameter:
If you provide a state parameter as 'all' or 'ALL' in addition to the country parameter, the script will retrieve information about all states within the selected country.
If you specify a valid state ISO2 Code as the state parameter, the script will retrieve information about that specific state within the selected country.
city Parameter:
If you provide a city parameter as 'all' or 'ALL' in addition to the country and state parameters, the script will retrieve information about all cities within the selected state and country.
download Parameter:
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.
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.
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:
Add download parameter to download the output json, below is some example of it:
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
country
To specify the desired country.
ISO2 Code of Country
'ALL' or 'all'
state
To specify the desired state within the selected country.
ISO2 Code of State
'ALL' or 'all'
city
To specify the desired city within the selected country and state.
'ALL' or 'all'
download
To download the JSON output
This parameter does not require the content, Leave empty or Type anything is acceptable
