City
City List
Use this API to list all cities based on a state.
GET /city/city-list Try now
Query string parameters
| Field | Type | Description |
|---|---|---|
| stateId required | integer | State ID |
| q | string | filter data by city name |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"cityList": [
{
"cityId": 1,
"name": "San Francisco"
},
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| cityId | integer | City ID |
| name | string | City Name |
| totalRecords | integer | count of records returned |
| Code | Description |
|---|---|
| 1001 | "Missing stateId" |
| 1002 | "Invalid stateId" |