country_places
Retrieve cities and places within a specific country with filters for population, time zones, name prefixes, and administrative types.
Instructions
Get the places in the given country.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| types | No | Only cities for these types (comma-delimited): ADM2 | CITY | ISLAND | |
| timeZoneIds | No | Only places in these time-zones | |
| minPopulation | No | Only places having at least this population | |
| maxPopulation | No | Only places having no more than this population | 0 |
| namePrefix | No | Only places whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. | |
| namePrefixDefaultLangResults | No | Example value: | |
| languageCode | No | Display results in this language | |
| asciiMode | No | Example value: | |
| hateoasMode | No | Example value: | |
| includeDeleted | No | Whether to include any cities marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE | |
| limit | No | The maximum number of results to retrieve | |
| offset | No | The zero-ary offset into the results | |
| sort | No | How to sort the results. Format: ±SORT_FIELD,±SORT_FIELD where SORT_FIELD = elevation | name | population | |
| countryId | Yes | Example value: US |