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

1. Making an HTTP request via a web browser or API Platform etc. Postman.

2. The following parameters are accepted:

Name	Description	Format
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

1. Depending on the parameters provided, the script will construct a URL to fetch information from the CountryStateCity API.

Parameter Guidelines

• 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.

ISO2 Code

Refer this wikipedia to find your ISO2 Code.

Below is a sample how to find Malaysia ISO2 Code:

1. Find Malaysia and you will see country code at the left column.

'MY' is Malaysia's ISO2 Code

1. Onclick on the code then wikipedia with direct you to ISO 3166-2:MY where you can find its state code.

'01' is Johor's ISO2 Code

Demo

1. Retrieve information about all countries:

https://api.kosontechnology.com/country-state-city.php?country=ALLapi.kosontechnology.com

Retrieve all countries data

1. Retrieve information about a specific country:

https://api.kosontechnology.com/country-state-city.php?country=MYapi.kosontechnology.com

Retrieve Malaysia data

1. Retrieve information about all states:

https://api.kosontechnology.com/country-state-city.php?state=ALLapi.kosontechnology.com

Retrieve all states data

1. Retrieve information about all states within a specific country:

https://api.kosontechnology.com/country-state-city.php?country=MY&state=ALLapi.kosontechnology.com

Retrieve all state data from Malaysia

1. Retrieve information about a specific state within a specific country:

https://api.kosontechnology.com/country-state-city.php?country=MY&state=01api.kosontechnology.com

Retrieve Johor state data from Malaysia

1. Retrieve information about all cities within a specific state and country:

https://api.kosontechnology.com/country-state-city.php?city=ALL&country=MY&state=01api.kosontechnology.com

Retrieve all cities data from Malaysia's Johor

1. Retrieve information about all cities within a specific country:

https://api.kosontechnology.com/country-state-city.php?city=ALL&country=MYapi.kosontechnology.com

Retrieve all cities data from Malaysia

Download

Add download parameter to download the output json, below is some example of it:

https://api.kosontechnology.com/country-state-city.php?country=MY&download=api.kosontechnology.com

Download Malaysia's Json File

https://api.kosontechnology.com/country-state-city.php?city=all&country=my&download=&state=01api.kosontechnology.com

Download cities Json File from Malaysia's Johor