GeoDB (Independent Publisher) (Preview)
The GeoDB API focuses on getting global city and region data. Filter cities by name prefix, country, location, time-zone, and even minimum population. Sort cities by name, country code, elevation, and population - or any combination of these. Get all country regions and all cities in a region.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://geodb-cities-api.wirefreethought.com/ |
| Privacy policy | http://wirefreethought.com/privacy-policy |
| Categories | Data |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Find administrative divisions |
Find administrative divisions, filtering by optional criteria. If no criteria are set, you will get back all known divisions. |
| Find cities |
Find cities, filtering by optional criteria. If no criteria are set, you will get back all known cities. |
| Find cities near city |
Find cities near the given origin city, filtering by optional criteria. If no criteria are set, you will get back all known cities. |
| Find cities near division |
Find cities near the given administrative division, filtering by optional criteria. If no criteria are set, you will get back all known cities. |
| Find cities near location |
Find cities near the given location, filtering by optional criteria. If no criteria are set, you will get back all known cities. |
| Find countries |
Find countries, filtering by optional criteria. If no criteria are set, you will get back all known countries. |
| Find country region administrative divisions |
Get the administrative divisions in a specific country region. The country and region info is omitted in the response. . |
| Find country region cities |
Get the cities in a specific country region. The country and region info is omitted in the response. . |
| Find country regions |
Get all regions in a specific country. These could be states, provinces, districts, or otherwise major political divisions. |
| Find currencies |
Find currencies, filtering by optional criteria. If no criteria are set, you will get back all known currencies. |
| Find divisions near division |
Find administrative divisions near the given origin division, filtering by optional criteria. If no criteria are set, you will get back all known divisions. |
| Find divisions near location |
Find administrative divisions near the given location, filtering by optional criteria. If no criteria are set, you will get back all known divisions. |
| Get administrative division details |
Get the details for a specific administrative division, including location coordinates, population, and elevation above sea-level (if available). |
| Get city admin region |
Get the details for the containing populated place (e.g., its county or other administrative division), including location coordinates, population, and elevation above sea-level (if available). |
| Get city date-time |
Get city date-time. |
| Get city details |
Get the details for a specific city, including location coordinates, population, and elevation above sea-level (if available). |
| Get city distance |
Get distance from the given city. |
| Get city time |
Get city time. |
| Get country details |
Get the details for a specific country, including number of regions. |
| Get languages |
Get all supported languages. |
| Get locales |
Get all known locales. |
| Get region details |
Get the details of a specific country region, including number of cities. |
| Get time-zone |
Get time-zone. |
| Get time-zone date-time |
Get time-zone date-time. |
| Get time-zone time |
Get time-zone time. |
| Get time-zones |
Get all known time-zones. |
Find administrative divisions
Find administrative divisions, filtering by optional criteria. If no criteria are set, you will get back all known divisions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Nearby Location IDs
|
location | string |
Only places near this location. Latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD |
|
|
Location Radius
|
radius | integer |
The location radius within which to find places. |
|
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
|
|
Country ID
|
countryIds | string |
Only places in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Exclude Country IDs
|
excludedCountryIds | string |
Only places NOT in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Places
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = countryCode | elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find cities
Find cities, filtering by optional criteria. If no criteria are set, you will get back all known cities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Nearby Location IDs
|
location | string |
Only places near this location. Latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD |
|
|
Location Radius
|
radius | integer |
The location radius within which to find places. |
|
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
|
|
Country ID
|
countryIds | string |
Only places in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Exclude Country IDs
|
excludedCountryIds | string |
Only places NOT in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
Place Types
|
types | string |
Only places for these types (comma-delimited): CITY | ADM2. |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Places
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = countryCode | elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find cities near city
Find cities near the given origin city, filtering by optional criteria. If no criteria are set, you will get back all known cities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
City ID
|
cityId | True | string |
A city ID (either native 'id' or 'wikiDataId'). |
|
Location Radius
|
radius | integer |
The location radius within which to find places. |
|
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
|
|
Country ID
|
countryIds | string |
Only places in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Exclude Country IDs
|
excludedCountryIds | string |
Only places NOT in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
Place Types
|
types | string |
Only places for these types (comma-delimited): CITY | ADM2. |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Places
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = countryCode | elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find cities near division
Find cities near the given administrative division, filtering by optional criteria. If no criteria are set, you will get back all known cities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Division ID
|
divisionId | True | string |
An admin-division ID (either native 'id' or 'wikiDataId'). |
|
Location Radius
|
radius | integer |
The location radius within which to find places. |
|
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
|
|
Country ID
|
countryIds | string |
Only places in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Exclude Country IDs
|
excludedCountryIds | string |
Only places NOT in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
Place Types
|
types | string |
Only places for these types (comma-delimited): CITY | ADM2. |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Places
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = countryCode | elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find cities near location
Find cities near the given location, filtering by optional criteria. If no criteria are set, you will get back all known cities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location ID
|
locationId | True | string |
A latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD |
|
Location Radius
|
radius | integer |
The location radius within which to find places. |
|
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
|
|
Country ID
|
countryIds | string |
Only places in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Exclude Country IDs
|
excludedCountryIds | string |
Only places NOT in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
Place Types
|
types | string |
Only places for these types (comma-delimited): CITY | ADM2. |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Places
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = countryCode | elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find countries
Find countries, filtering by optional criteria. If no criteria are set, you will get back all known countries.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Currency Code
|
currencyCode | string |
Only countries supporting this currency. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
Find country region administrative divisions
Get the administrative divisions in a specific country region. The country and region info is omitted in the response. .
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Country ID
|
countryId | True | string |
An ISO-3166 country code or WikiData ID. |
|
Region Code
|
regionCode | True | string |
An ISO-3166 or FIPS region code. |
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Within Region
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find country region cities
Get the cities in a specific country region. The country and region info is omitted in the response. .
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Country ID
|
countryId | True | string |
An ISO-3166 country code or WikiData ID. |
|
Region Code
|
regionCode | True | string |
An ISO-3166 or FIPS region code. |
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
Place Types
|
types | string |
Only places for these types (comma-delimited): CITY | ADM2. |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Within Region
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find country regions
Get all regions in a specific country. These could be states, provinces, districts, or otherwise major political divisions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Country ID
|
countryId | True | string |
An ISO-3166 country code or WikiData ID. |
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
Find currencies
Find currencies, filtering by optional criteria. If no criteria are set, you will get back all known currencies.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Currency for Country ID
|
countryId | True | string |
Currencies for this country ID. |
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
Find divisions near division
Find administrative divisions near the given origin division, filtering by optional criteria. If no criteria are set, you will get back all known divisions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Division ID
|
divisionId | True | string |
An admin-division ID (either native 'id' or 'wikiDataId'). |
|
Location Radius
|
radius | integer |
The location radius within which to find places. |
|
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
|
|
Country ID
|
countryIds | string |
Only places in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Exclude Country IDs
|
excludedCountryIds | string |
Only places NOT in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Places
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = countryCode | elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Find divisions near location
Find administrative divisions near the given location, filtering by optional criteria. If no criteria are set, you will get back all known divisions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location ID
|
locationId | True | string |
A latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD |
|
Location Radius
|
radius | integer |
The location radius within which to find places. |
|
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
|
|
Country ID
|
countryIds | string |
Only places in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Exclude Country IDs
|
excludedCountryIds | string |
Only places NOT in these countries (comma-delimited country codes or WikiData IDs). |
|
|
Minimum Population
|
minPopulation | integer |
Only places having at least this population. |
|
|
Maximum Population
|
maxPopulation | integer |
Only places having no more than this population. |
|
|
Name Prefix
|
namePrefix | string |
Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name as it appears in that language. |
|
|
Name Prefix Default Language
|
namePrefixDefaultLangResults | boolean |
When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set. |
|
|
Timezone ID
|
timeZoneIds | string |
Only places in these time-zones (comma-delimited). |
|
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
|
|
Sort Places
|
sort | string |
How to sort place results. 'Format: ±SORT_FIELD,±SORT_FIELD' where SORT_FIELD = countryCode | elevation | name | population . |
|
|
Include Deleted
|
includeDeleted | string |
Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE. |
Get administrative division details
Get the details for a specific administrative division, including location coordinates, population, and elevation above sea-level (if available).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Division ID
|
divisionId | True | string |
An admin-division ID (either native 'id' or 'wikiDataId'). |
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
Get city admin region
Get the details for the containing populated place (e.g., its county or other administrative division), including location coordinates, population, and elevation above sea-level (if available).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
City ID
|
cityId | True | string |
A city ID (either native 'id' or 'wikiDataId'). |
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
Get city date-time
Get city date-time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
City ID
|
cityId | True | string |
A city ID (either native 'id' or 'wikiDataId'). |
Get city details
Get the details for a specific city, including location coordinates, population, and elevation above sea-level (if available).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
City ID
|
cityId | True | string |
A city ID (either native 'id' or 'wikiDataId'). |
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
Get city distance
Get distance from the given city.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
City ID
|
cityId | True | string |
A city ID (either native 'id' or 'wikiDataId'). |
|
To City ID
|
toCityId | True | string |
Distance to this city. |
|
Distance Unit
|
distanceUnit | string |
The unit of distance: MI | KM. |
Get city time
Get city time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
City ID
|
cityId | True | string |
A city ID (either native 'id' or 'wikiDataId'). |
Get country details
Get the details for a specific country, including number of regions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Country ID
|
countryId | True | string |
An ISO-3166 country code or WikiData ID. |
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
Get languages
Get all supported languages.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
Get locales
Get all known locales.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |
Get region details
Get the details of a specific country region, including number of cities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Country ID
|
countryId | True | string |
An ISO-3166 country code or WikiData ID. |
|
Region Code
|
regionCode | True | string |
An ISO-3166 or FIPS region code. |
|
ASCII Mode
|
asciiMode | boolean |
Display results using ASCII characters. |
|
|
Language Code
|
languageCode | string |
Display results in this language. |
Get time-zone
Get time-zone.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Zone ID
|
zoneId | True | string |
A time-zone ID. |
Get time-zone date-time
Get time-zone date-time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Zone ID
|
zoneId | True | string |
A time-zone ID. |
Get time-zone time
Get time-zone time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Zone ID
|
zoneId | True | string |
A time-zone ID. |
Get time-zones
Get all known time-zones.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
HATEOAS Mode
|
hateoasMode | boolean |
Include HATEOAS-style links in results. |
|
|
Limit
|
limit | integer |
The maximum number of results to retrieve. |
|
|
Offset
|
offset | integer |
The zero-ary offset index into the results. |