openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 57.2 kB
JSON
{"openapi":"3.0.0","info":{"description":"The GeoDB API focuses on getting global city and region data. Easily obtain country, region, and city data for use\nin your apps! \n<ul>\n <li>Filter cities by name prefix, country, location, time-zone, and even minimum population.</li>\n <li>Sort cities by name, country code, elevation, and population - or any combination of these.</li> \n <li>Get all country regions.</li> <li>Get all cities in a given region.</li>\n <li>\n Display results in multiple languages.</li> <li>RESTful API adheres to industry best-practices, including\n HATEOAS-style links to facilitate paging results.\n </li> \n <li>Backed by cloud-based load-balanced infrastructure for resiliency and performance!</li>\n <li>Data is periodically refreshed from GeoNames and WikiData.</li>\n</ul>\n<p>Notes:\n<ul>\n <li>\n Since the database is periodically updated, this may <strong>very rarely</strong> result in certain cities\n being marked deleted (e.g., duplicates removed). By default, endpoints returning city data will exclude\n cities marked deleted. However, in the unlikely event that this occurs while your app is paging through a set\n of affected results - and you care about the paged results suddenly changing underneath - specify \n <tt>includeDeleted=SINCE_YESTERDAY</tt> (or <tt>SINCE_LAST_WEEK</tt> if you're really paranoid!).\n </li>\n</ul>\n<hr/>\n<h3>Useful Resources</h3>\n<ul>\n <li>\n SDKs\n <ul>\n <li>\n <a href='https://www.npmjs.com/package/wft-geodb-angular-client'>Angular</a>, \n <a href='https://github.com/wirefreethought/geodb-sample-angular-app'>Sample App</a>\n </li>\n <li><a href='https://github.com/wirefreethought/geodb-java-client'>Java</a></li>\n <li><a href='https://www.npmjs.com/package/wft-geodb-js-client'>JavaScript</a></li>\n </ul>\n <li><a href='swagger.json'>Swagger Docs</a></li>\n <li><a href='http://creativecommons.org/licenses/by/3.0/'>Usage License</a></li>\n </li> \n</ul>\n","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"title":"GeoDB Cities API","version":"1.0.0","x-apisguru-categories":["developer_tools","location"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://wirefreethought.github.io/geodb-cities-api-docs/images/logo.png"},"x-origin":[{"format":"swagger","url":"https://wirefreethought.github.io/geodb-cities-api-docs/swagger.json","version":"2.0"}],"x-providerName":"mashape.com","x-serviceName":"geodb"},"security":[{"UserSecurity":[]}],"tags":[{"description":"Geo Endpoints","name":"Geo"},{"description":"Locale Endpoints","name":"Locale"}],"paths":{"/geo/adminDivisions":{"get":{"description":"Find administrative divisions, filtering by optional criteria. If no criteria are set, you will get back all\nknown divisions.\n","operationId":"findAdminDivisionsUsingGET","parameters":[{"$ref":"#/components/parameters/query.place.location.id"},{"$ref":"#/components/parameters/query.place.location.radiusOf"},{"$ref":"#/components/parameters/query.distanceUnit"},{"$ref":"#/components/parameters/query.place.countryIds"},{"$ref":"#/components/parameters/query.place.excludedCountryIds"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Find administrative divisions","tags":["Geo"]}},"/geo/adminDivisions/{divisionId}":{"get":{"description":"Get the details for a specific administrative division, including location coordinates, population, and\nelevation above sea-level (if available).\n","operationId":"getAdminDivisionUsingGET","parameters":[{"$ref":"#/components/parameters/path.divisionId"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.languageCode"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlace"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get administrative division details","tags":["Geo"]}},"/geo/adminDivisions/{divisionId}/nearbyCities":{"get":{"description":"Find cities near the given administrative division, filtering by optional criteria. If no criteria are set, you\nwill get back all known cities.\n","operationId":"findCitiesNearAdminDivisionUsingGET","parameters":[{"$ref":"#/components/parameters/path.divisionId"},{"$ref":"#/components/parameters/query.place.location.radiusOf"},{"$ref":"#/components/parameters/query.distanceUnit"},{"$ref":"#/components/parameters/query.place.countryIds"},{"$ref":"#/components/parameters/query.place.excludedCountryIds"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.place.types"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Find cities near division","tags":["Geo"]}},"/geo/adminDivisions/{divisionId}/nearbyDivisions":{"get":{"description":"Find administrative divisions near the given origin division, filtering by optional criteria. If no criteria\nare set, you will get back all known divisions.\n","operationId":"findDivisionsNearAdminDivisionUsingGET","parameters":[{"$ref":"#/components/parameters/path.divisionId"},{"$ref":"#/components/parameters/query.place.location.radiusOf"},{"$ref":"#/components/parameters/query.distanceUnit"},{"$ref":"#/components/parameters/query.place.countryIds"},{"$ref":"#/components/parameters/query.place.excludedCountryIds"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Find divisions near division","tags":["Geo"]}},"/geo/cities":{"get":{"description":"Find cities, filtering by optional criteria. If no criteria are set, you will get back all known cities.\n","operationId":"findCitiesUsingGET","parameters":[{"$ref":"#/components/parameters/query.place.location.id"},{"$ref":"#/components/parameters/query.place.location.radiusOf"},{"$ref":"#/components/parameters/query.distanceUnit"},{"$ref":"#/components/parameters/query.place.countryIds"},{"$ref":"#/components/parameters/query.place.excludedCountryIds"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.place.types"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Find cities","tags":["Geo"]}},"/geo/cities/{cityId}":{"get":{"description":"Get the details for a specific city, including location coordinates, population, and elevation above sea-level\n(if available).\n","operationId":"getCityUsingGET","parameters":[{"$ref":"#/components/parameters/path.cityId"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.languageCode"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlace"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get city details","tags":["Geo"]}},"/geo/cities/{cityId}/dateTime":{"get":{"description":"Get city date-time","operationId":"getCityDateTimeUsingGET","parameters":[{"$ref":"#/components/parameters/path.cityId"}],"responses":{"200":{"$ref":"#/components/responses/DateTime"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get city date-time","tags":["Geo"]}},"/geo/cities/{cityId}/distance":{"get":{"description":"Get distance from the given city","operationId":"getCityDistanceUsingGET","parameters":[{"$ref":"#/components/parameters/path.cityId"},{"$ref":"#/components/parameters/query.toCityId"},{"$ref":"#/components/parameters/query.distanceUnit"}],"responses":{"200":{"$ref":"#/components/responses/Distance"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get city distance","tags":["Geo"]}},"/geo/cities/{cityId}/locatedIn":{"get":{"description":"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\n(if available).\n","operationId":"getCityLocatedInUsingGET","parameters":[{"$ref":"#/components/parameters/path.cityId"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.languageCode"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlace"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get city admin region","tags":["Geo"]}},"/geo/cities/{cityId}/nearbyCities":{"get":{"description":"Find cities near the given origin city, filtering by optional criteria. If no criteria are set, you will get\nback all known cities.\n","operationId":"findCitiesNearCityUsingGET","parameters":[{"$ref":"#/components/parameters/path.cityId"},{"$ref":"#/components/parameters/query.place.location.radiusOf"},{"$ref":"#/components/parameters/query.distanceUnit"},{"$ref":"#/components/parameters/query.place.countryIds"},{"$ref":"#/components/parameters/query.place.excludedCountryIds"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.place.types"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Find cities near city","tags":["Geo"]}},"/geo/cities/{cityId}/time":{"get":{"description":"Get city time","operationId":"getCityTimeUsingGET","parameters":[{"$ref":"#/components/parameters/path.cityId"}],"responses":{"200":{"$ref":"#/components/responses/Time"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get city time","tags":["Geo"]}},"/geo/countries":{"get":{"description":"Find countries, filtering by optional criteria. If no criteria are set, you will get back all known countries.\n","operationId":"getCountriesUsingGET","parameters":[{"$ref":"#/components/parameters/query.country.currencyCode"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.country.sort"}],"responses":{"200":{"$ref":"#/components/responses/Countries"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Find countries","tags":["Geo"]}},"/geo/countries/{countryId}":{"get":{"description":"Get the details for a specific country, including number of regions.","operationId":"getCountryUsingGET","parameters":[{"$ref":"#/components/parameters/path.countryId"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.languageCode"}],"responses":{"200":{"$ref":"#/components/responses/Country"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get country details","tags":["Geo"]}},"/geo/countries/{countryId}/regions":{"get":{"description":"Get all regions in a specific country. These could be states, provinces, districts, or otherwise major\npolitical divisions.\n","operationId":"getRegionsUsingGET","parameters":[{"$ref":"#/components/parameters/path.countryId"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.region.sort"}],"responses":{"200":{"$ref":"#/components/responses/Regions"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Find country regions","tags":["Geo"]}},"/geo/countries/{countryId}/regions/{regionCode}":{"get":{"description":"Get the details of a specific country region, including number of cities.","operationId":"getRegionUsingGET","parameters":[{"$ref":"#/components/parameters/path.countryId"},{"$ref":"#/components/parameters/path.regionCode"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.languageCode"}],"responses":{"200":{"$ref":"#/components/responses/Region"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get region details","tags":["Geo"]}},"/geo/countries/{countryId}/regions/{regionCode}/adminDivisions":{"get":{"description":"Get the administrative divisions in a specific country region. The country and region info is omitted in the\nresponse.\n","operationId":"findRegionDivisionsUsingGET","parameters":[{"$ref":"#/components/parameters/path.countryId"},{"$ref":"#/components/parameters/path.regionCode"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort.withinRegion"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Find country region administrative divisions","tags":["Geo"]}},"/geo/countries/{countryId}/regions/{regionCode}/cities":{"get":{"description":"Get the cities in a specific country region. The country and region info is omitted in the response.\n","operationId":"findRegionCitiesUsingGET","parameters":[{"$ref":"#/components/parameters/path.countryId"},{"$ref":"#/components/parameters/path.regionCode"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.place.types"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort.withinRegion"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Find country region cities","tags":["Geo"]}},"/geo/locations/{locationId}/nearbyCities":{"get":{"description":"Find cities near the given location, filtering by optional criteria. If no criteria are set, you will get back\nall known cities.\n","operationId":"findCitiesNearLocationUsingGET","parameters":[{"$ref":"#/components/parameters/path.location.id"},{"$ref":"#/components/parameters/query.place.location.radiusOf"},{"$ref":"#/components/parameters/query.distanceUnit"},{"$ref":"#/components/parameters/query.place.countryIds"},{"$ref":"#/components/parameters/query.place.excludedCountryIds"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.place.types"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Find cities near location","tags":["Geo"]}},"/geo/locations/{locationId}/nearbyDivisions":{"get":{"description":"Find administrative divisions near the given location, filtering by optional criteria. If no criteria are set,\nyou will get back all known divisions.\n","operationId":"findDivisionsNearLocationUsingGET","parameters":[{"$ref":"#/components/parameters/path.location.id"},{"$ref":"#/components/parameters/query.place.location.radiusOf"},{"$ref":"#/components/parameters/query.distanceUnit"},{"$ref":"#/components/parameters/query.place.countryIds"},{"$ref":"#/components/parameters/query.place.excludedCountryIds"},{"$ref":"#/components/parameters/query.place.minPopulation"},{"$ref":"#/components/parameters/query.place.maxPopulation"},{"$ref":"#/components/parameters/query.entity.namePrefix"},{"$ref":"#/components/parameters/query.entity.namePrefixDefaultLangResults"},{"$ref":"#/components/parameters/query.timeZoneIds"},{"$ref":"#/components/parameters/query.asciiMode"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.languageCode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"},{"$ref":"#/components/parameters/query.place.sort"},{"$ref":"#/components/parameters/query.includeDeleted"}],"responses":{"200":{"$ref":"#/components/responses/PopulatedPlaces"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Find divisions near location","tags":["Geo"]}},"/locale/currencies":{"get":{"description":"Find currencies, filtering by optional criteria. If no criteria are set, you will get back all known currencies.","operationId":"getCurrenciesUsingGET","parameters":[{"$ref":"#/components/parameters/query.currency.countryId"},{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"}],"responses":{"200":{"$ref":"#/components/responses/Currencies"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Find currencies","tags":["Locale"]}},"/locale/languages":{"get":{"description":"Get all supported languages","operationId":"getLanguagesUsingGET","parameters":[{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"}],"responses":{"200":{"$ref":"#/components/responses/Languages"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Get languages","tags":["Locale"]}},"/locale/locales":{"get":{"description":"Get all known locales","operationId":"getLocalesUsingGET","parameters":[{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"}],"responses":{"200":{"$ref":"#/components/responses/Locales"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Get locales","tags":["Locale"]}},"/locale/timezones":{"get":{"description":"Get all known time-zones","operationId":"getTimezonesUsingGET","parameters":[{"$ref":"#/components/parameters/query.hateoasMode"},{"$ref":"#/components/parameters/query.limit"},{"$ref":"#/components/parameters/query.offset"}],"responses":{"200":{"$ref":"#/components/responses/TimeZones"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"summary":"Get time-zones","tags":["Locale"]}},"/locale/timezones/{zoneId}":{"get":{"description":"Get time-zone","operationId":"getTimeZoneUsingGET","parameters":[{"$ref":"#/components/parameters/path.zoneId"}],"responses":{"200":{"$ref":"#/components/responses/TimeZone"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get time-zone","tags":["Locale"]}},"/locale/timezones/{zoneId}/dateTime":{"get":{"description":"Get time-zone date-time","operationId":"getTimeZoneDateTimeUsingGET","parameters":[{"$ref":"#/components/parameters/path.zoneId"}],"responses":{"200":{"$ref":"#/components/responses/DateTime"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get time-zone date-time","tags":["Locale"]}},"/locale/timezones/{zoneId}/time":{"get":{"description":"Get time-zone time","operationId":"getTimeZoneTimeUsingGET","parameters":[{"$ref":"#/components/parameters/path.zoneId"}],"responses":{"200":{"$ref":"#/components/responses/Time"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"summary":"Get time-zone time","tags":["Locale"]}}},"servers":[{"url":"https://wft-geo-db.p.rapidapi.com/v1"}],"components":{"parameters":{"path.cityId":{"description":"A city id (either native 'id' or 'wikiDataId')","in":"path","name":"cityId","required":true,"schema":{"type":"string"}},"path.countryId":{"description":"An ISO-3166 country code or WikiData id","in":"path","name":"countryId","required":true,"schema":{"type":"string"}},"path.divisionId":{"description":"An admin-division id (either native 'id' or 'wikiDataId')","in":"path","name":"divisionId","required":true,"schema":{"type":"string"}},"path.location.id":{"description":"A latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD","in":"path","name":"locationId","required":true,"schema":{"type":"string"}},"path.regionCode":{"description":"An ISO-3166 or FIPS region code","in":"path","name":"regionCode","required":true,"schema":{"type":"string"}},"path.zoneId":{"description":"A time-zone id","in":"path","name":"zoneId","required":true,"schema":{"type":"string"}},"query.asciiMode":{"description":"Display results using ASCII characters","in":"query","name":"asciiMode","required":false,"schema":{"type":"boolean","default":false}},"query.country.currencyCode":{"description":"Only countries supporting this currency","in":"query","name":"currencyCode","required":false,"schema":{"type":"string"}},"query.country.sort":{"description":"How to sort countries. \nFormat: ±SORT_FIELD \nwhere SORT_FIELD = code | name","in":"query","name":"sort","required":false,"schema":{"type":"string"}},"query.currency.countryId":{"description":"Currencies for this country id","in":"query","name":"countryId","required":true,"schema":{"type":"string"}},"query.distanceUnit":{"description":"The unit of distance: MI | KM","in":"query","name":"distanceUnit","required":false,"schema":{"type":"string","default":"MI"}},"query.entity.namePrefix":{"description":"Only entities whose names start with this prefix. If languageCode is set, the prefix will be matched on the name\nas it appears in that language.\n","in":"query","name":"namePrefix","required":false,"schema":{"type":"string"}},"query.entity.namePrefixDefaultLangResults":{"description":"When name-prefix matching, whether or not to match on names in the default language if a non-default languageCode is set.\n","in":"query","name":"namePrefixDefaultLangResults","required":false,"schema":{"type":"boolean","default":true}},"query.hateoasMode":{"description":"Include HATEOAS-style links in results","in":"query","name":"hateoasMode","required":false,"schema":{"type":"boolean","default":true}},"query.includeDeleted":{"description":"Whether to include any divisions marked deleted: ALL | SINCE_YESTERDAY | SINCE_LAST_WEEK | NONE","in":"query","name":"includeDeleted","required":false,"schema":{"type":"string","default":"NONE"}},"query.languageCode":{"description":"Display results in this language","in":"query","name":"languageCode","required":false,"schema":{"type":"string"}},"query.limit":{"description":"The maximum number of results to retrieve","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":10}},"query.offset":{"description":"The zero-ary offset index into the results","in":"query","name":"offset","required":false,"schema":{"type":"integer","format":"int32","default":0}},"query.place.countryIds":{"description":"Only places in these countries (comma-delimited country codes or WikiData ids)","in":"query","name":"countryIds","required":false,"schema":{"type":"string"}},"query.place.excludedCountryIds":{"description":"Only places NOT in these countries (comma-delimited country codes or WikiData ids)","in":"query","name":"excludedCountryIds","required":false,"schema":{"type":"string"}},"query.place.location.id":{"description":"Only places near this location. Latitude/longitude in ISO-6709 format: ±DD.DDDD±DDD.DDDD","in":"query","name":"location","required":false,"schema":{"type":"string"}},"query.place.location.radiusOf":{"description":"The location radius within which to find places","in":"query","name":"radius","required":false,"schema":{"type":"integer","format":"int32"}},"query.place.maxPopulation":{"description":"Only places having no more than this population","in":"query","name":"maxPopulation","required":false,"schema":{"type":"integer","format":"int32"}},"query.place.minPopulation":{"description":"Only places having at least this population","in":"query","name":"minPopulation","required":false,"schema":{"type":"integer","format":"int32"}},"query.place.sort":{"description":"How to sort places. \nFormat: ±SORT_FIELD,±SORT_FIELD \nwhere SORT_FIELD = countryCode | elevation | name | population\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}},"query.place.sort.withinRegion":{"description":"How to sort place results. \n'Format: ±SORT_FIELD,±SORT_FIELD' \nwhere SORT_FIELD = elevation | name | population\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}},"query.place.types":{"description":"Only places for these types (comma-delimited): CITY | ADM2","in":"query","name":"types","required":false,"schema":{"type":"string"}},"query.region.sort":{"description":"How to sort regions. \nFormat: ±SORT_FIELD \nwhere SORT_FIELD = fipsCode | isoCode | name","in":"query","name":"sort","required":false,"schema":{"type":"string"}},"query.sort":{"description":"How to sort place results. \n'Format: ±SORT_FIELD,±SORT_FIELD' \nwhere SORT_FIELD = countryCode | elevation | name | population\n","in":"query","name":"sort","required":false,"schema":{"type":"string"}},"query.timeZoneIds":{"description":"Only places in these time-zones (comma-delimited)","in":"query","name":"timeZoneIds","required":false,"schema":{"type":"string"}},"query.toCityId":{"description":"Distance to this city","in":"query","name":"toCityId","required":true,"schema":{"type":"string"}}},"responses":{"BadRequest":{"description":"400 - Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"Countries":{"description":"A list of countries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountriesResponse"}}}},"Country":{"description":"Country detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryResponse"}}}},"Currencies":{"description":"A list of currencies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrenciesResponse"}}}},"DateTime":{"description":"An ISO-6801 date-time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DateTimeResponse"}}}},"Distance":{"description":"A decimal distance (in miles or kilometers)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistanceResponse"}}}},"Forbidden":{"description":"403 - Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"Languages":{"description":"A list of languages supported by the system","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguagesResponse"}}}},"Locales":{"description":"A list of locales","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalesResponse"}}}},"NotFound":{"description":"404 - Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"PopulatedPlace":{"description":"Populated-place details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopulatedPlaceResponse"}}}},"PopulatedPlaces":{"description":"A list of populated places","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopulatedPlacesResponse"}}}},"Region":{"description":"Country region details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionResponse"}}}},"Regions":{"description":"A list of country regions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionsResponse"}}}},"Time":{"description":"An ISO-8601 time response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeResponse"}}}},"TimeZone":{"description":"A time-zone","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeZoneResponse"}}}},"TimeZones":{"description":"A list of time-zones","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeZonesResponse"}}}},"Unauthorized":{"description":"401 - Unauthorized"}},"securitySchemes":{"UserSecurity":{"in":"header","name":"x-rapidapi-key","type":"apiKey"}},"schemas":{"BadRequestResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}],"description":"Bad Request Response","example":{"errors":[{"code":"PARAM_INVALID","message":"Param [someParam] has invalid value: invalidValue"}]},"title":"Bad Request Response","type":"object"},"BaseCollectionResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"properties":{"links":{"items":{"$ref":"#/components/schemas/Link"},"title":"Links","type":"array"},"metadata":{"$ref":"#/components/schemas/Metadata"}}}],"description":"Common properties for all collection responses","example":{"links":[{"href":"/data/world/v1/some/resource?offset=0&limit=5","rel":"first"},{"href":"/data/world/v1/some/resource?offset=0&limit=5","rel":"prev"},{"href":"/data/world/v1/some/resource?offset=10&limit=5","rel":"next"},{"href":"/data/world/v1/some/resource?offset=95&limit=5","rel":"last"}],"metadata":{"currentOffset":5,"totalCount":100}},"title":"Base Collection Response","type":"object"},"BaseResponse":{"description":"Common properties for all responses","example":{"errors":[]},"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"title":"Errors","type":"array"}},"title":"Base Response","type":"object"},"CountriesResponse":{"allOf":[{"$ref":"#/components/schemas/BaseCollectionResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/CountrySummary"},"title":"CountrySummaries","type":"array"}}}],"description":"A list of countries","example":{"data":[{"code":"SM","currencyCodes":["EUR"],"name":"San Marino","wikiDataId":"Q238"},{"code":"NE","currencyCodes":["XOF"],"name":"Niger","wikiDataId":"Q1032"},{"code":"MT","currencyCodes":["EUR"],"name":"Malta","wikiDataId":"Q233"},{"code":"KZ","currencyCodes":["KZT"],"name":"Kazakhstan","wikiDataId":"Q232"},{"code":"KE","currencyCodes":["KES"],"name":"Kenya","wikiDataId":"Q114"}],"links":[{"href":"/data/world/v1/geo/countries?offset=0&limit=5","rel":"first"},{"href":"/data/world/v1/geo/countries?offset=0&limit=5","rel":"prev"},{"href":"/data/world/v1/geo/countries?offset=10&limit=5","rel":"next"},{"href":"/data/world/v1/geo/countries?offset=195&limit=5","rel":"last"}],"metadata":{"currentOffset":5,"totalCount":198}},"title":"Countries Response","type":"object"},"CountryDetails":{"description":"Full country details","example":{"callingCode":"+1","code":"US","currencyCodes":["USD"],"flagImageUri":"http://commons.wikimedia.org/wiki/Special:FilePath/Flag%20of%20the%20United%20States.svg","name":"United States","numRegions":56,"wikiDataId":"Q30"},"properties":{"callingCode":{"description":"The country dialing prefix","type":"string"},"code":{"description":"The ISO-3166 country code","type":"string"},"currencyCodes":{"description":"A list of supported ISO-4217 currency codes","items":{"type":"string"},"type":"array"},"flagImageUri":{"description":"The country flag image","type":"string"},"name":{"description":"The country name (varies by languageCode)","type":"string"},"numRegions":{"description":"The number of regions in this country","format":"int32","type":"integer"},"wikiDataId":{"description":"The country WikiData id","type":"string"}},"title":"Country Details","type":"object"},"CountryResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"properties":{"data":{"$ref":"#/components/schemas/CountryDetails"}}}],"description":"Country details response","example":{"data":{"callingCode":"+1","code":"US","currencyCodes":["USD"],"flagImageUri":"http://commons.wikimedia.org/wiki/Special:FilePath/Flag%20of%20the%20United%20States.svg","name":"United States","numRegions":56,"wikiDataId":"Q30"}},"title":"Country Response","type":"object"},"CountrySummary":{"description":"Minimal country info","example":{"code":"US","currencyCodes":["USD"],"name":"United States","wikiDataId":"Q30"},"properties":{"code":{"description":"The ISO-3166 country code","type":"string"},"currencyCodes":{"description":"A list of supported ISO-4217 currency codes","items":{"type":"string"},"type":"array"},"name":{"description":"The country name (varies by languageCode)","type":"string"},"wikiDataId":{"description":"The country WikiData id","type":"string"}},"title":"Country Summary","type":"object"},"CurrenciesResponse":{"allOf":[{"$ref":"#/components/schemas/BaseCollectionResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Currency"},"type":"array"}}}],"description":"A list of currencies","example":{"data":[{"code":"AWG","countryCodes":["AW"]},{"code":"AZN","countryCodes":["AZ"]},{"code":"BAM","countryCodes":["BA"]},{"code":"BBD","countryCodes":["BB"]},{"code":"BDT","countryCodes":["BD"]}],"links":[{"href":"/data/world/v1/locale/currencies?offset=0&limit=5","rel":"first"},{"href":"/data/world/v1/locale/currencies?offset=5&limit=5","rel":"prev"},{"href":"/data/world/v1/locale/currencies?offset=15&limit=5","rel":"next"},{"href":"/data/world/v1/locale/currencies?offset=200&limit=5","rel":"last"}],"metadata":{"currentOffset":10,"totalCount":205}},"title":"Currencies Response","type":"object"},"Currency":{"description":"Currency info","example":{"code":"USD","countryCodes":["PR","MP","IO","FM","PW","GU","BQ","TC","VG","AS","VI","TL","UM","MH","EC","US"],"symbol":"$"},"properties":{"code":{"description":"The ISO-4217 currency code","type":"string"},"countryCodes":{"description":"A list of ISO-3166 country codes of countries supporting this currency","items":{"type":"string"},"type":"array"},"symbol":{"description":"The currency symbol","type":"string"}},"title":"Currency","type":"object"},"DateTimeResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"properties":{"data":{"description":"The date-time in ISO-6801 format: yyyyMMdd'T'HHmmssZ","format":"date-time","type":"string"}}}],"description":"An ISO-6801 date-time response","example":{"data":"2025-06-15T13:47:48.423Z"},"title":"Date-Time Response","type":"object"},"DistanceResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"properties":{"data":{"description":"The distance in units as set by the distanceUnit param (defaults to miles)","format":"double","type":"number"}}}],"description":"A decimal distance (in miles or kilometers)","example":{"data":6707.9},"title":"Distance Response","type":"object"},"Error":{"description":"An error that occurred processing the request","example":{"code":"ENTITY_NOT_FOUND","message":"Param [someParam] has invalid value: invalidValue"},"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"title":"Error","type":"object"},"ErrorCode":{"description":"One of a set of enumerated error codes representing the types of errors that can occur processing a\nrequest\n","enum":["ACCESS_DENIED","ENTITY_NOT_FOUND","INCOMPATIBLE","PARAM_INVALID","PARAMS_MUTUALLY_EXCLUSIVE","REQUEST_UNPROCESSABLE"],"example":"ENTITY_NOT_FOUND","title":"ErrorCode","type":"string"},"ForbiddenResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}],"description":"Forbidden Response","example":{"errors":[{"code":"ACCESS_DENIED","message":"The reason why access was denied"}]},"title":"Forbidden Response","type":"object"},"LanguageDescriptor":{"description":"A language supported by the service","example":{"code":"en","name":"English"},"properties":{"code":{"enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"type":"string"},"name":{"type":"string"}},"title":"Language","type":"object"},"LanguagesResponse":{"allOf":[{"$ref":"#/components/schemas/BaseCollectionResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/LanguageDescriptor"},"type":"array"}}}],"description":"A list of languages supported by the system","example":{"data":[{"code":"fr","name":"French"},{"code":"it","name":"Italian"},{"code":"pt","name":"Portuguese"}],"links":[{"href":"/data/world/v1/locale/languages?offset=0&limit=3","rel":"first"},{"href":"/data/world/v1/locale/languages?offset=0&limit=3","rel":"prev"},{"href":"/data/world/v1/locale/languages?offset=6&limit=3","rel":"next"},{"href":"/data/world/v1/locale/languages?offset=6&limit=3","rel":"last"}],"metadata":{"currentOffset":3,"totalCount":8}},"title":"Languages Response","type":"object"},"Link":{"description":"A HATEAOS link","example":{"href":"/data/world/v1/geo/cities?offset=10&limit=10","rel":"next"},"properties":{"href":{"type":"string"},"rel":{"type":"string"}},"title":"Link","type":"object"},"Locale":{"description":"A locale representing a language/region combination","example":{"code":"en_US"},"properties":{"code":{"description":"The locale code","type":"string"}},"title":"Locale","type":"object"},"LocalesResponse":{"allOf":[{"$ref":"#/components/schemas/BaseCollectionResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/Locale"},"type":"array"}}}],"description":"A list of locales","example":{"data":[{"code":"eu"},{"code":"ar_MR"},{"code":"es_DO"},{"code":"ru"},{"code":"az"}],"links":[{"href":"/data/world/v1/locale/locales?offset=0&limit=5","rel":"first"},{"href":"/data/world/v1/locale/locales?offset=45&limit=5","rel":"prev"},{"href":"/data/world/v1/locale/locales?offset=55&limit=5","rel":"next"},{"href":"/data/world/v1/locale/locales?offset=770&limit=5","rel":"last"}],"metadata":{"currentOffset":50,"totalCount":772}},"title":"Locales Response","type":"object"},"Metadata":{"description":"Result metadata (currently only associated with collection results)","example":{"currentOffset":0,"totalCount":100},"properties":{"currentOffset":{"description":"The zero-ary offset into the results (0 is the first result)","format":"int64","type":"integer"},"totalCount":{"description":"The total number of results across pages","format":"int64","type":"integer"}},"title":"Metadata","type":"object"},"NotFoundResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}],"description":"Not Found Response","example":{"errors":[{"code":"ENTITY_NOT_FOUND","message":"Entity not found for id: someEntityId"}]},"title":"Not Found Response","type":"object"},"PopulatedPlaceDetails":{"description":"Full populated-place details","example":{"country":"United States of America","countryCode":"US","deleted":false,"elevationMeters":10,"id":123214,"latitude":40.67,"longitude":-73.94,"name":"New York City","population":8398748,"region":"New York","regionCode":"NY","timezone":"America__New_York","type":"CITY","wikiDataId":"Q60"},"properties":{"country":{"description":"The country name (varies by languageCode)","type":"string"},"countryCode":{"description":"The ISO-3166 country code","type":"string"},"deleted":{"description":"If this place has been soft-deleted","type":"boolean"},"elevationMeters":{"description":"The place elevation (meters) above sea level","format":"int32","type":"integer"},"id":{"description":"The place GeoDB native id","format":"int32","type":"integer"},"latitude":{"description":"The place latittude (-90.0 to 90.0)","format":"double","type":"number"},"longitude":{"description":"The place longitude (-180.0 to 180.0)","format":"double","type":"number"},"name":{"description":"The place name (varies by languageCode)","type":"string"},"population":{"description":"The place population","format":"int32","type":"integer"},"region":{"description":"The region name (varies by languageCode)","type":"string"},"regionCode":{"description":"The ISO or FIPS region code","type":"string"},"timezone":{"description":"The place timezone id","type":"string"},"type":{"$ref":"#/components/schemas/PopulatedPlaceType"},"wikiDataId":{"description":"The place WikiData id","type":"string"}},"title":"Populated-Place Details","type":"object"},"PopulatedPlaceResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"properties":{"data":{"$ref":"#/components/schemas/PopulatedPlaceDetails"}}}],"description":"Populated-place details response","example":{"data":{"country":"United States of America","countryCode":"US","deleted":false,"elevationMeters":10,"id":123214,"latitude":40.67,"longitude":-73.94,"name":"New York City","population":8398748,"region":"New York","regionCode":"NY","timezone":"America__New_York","type":"CITY","wikiDataId":"Q60"}},"title":"Populated-Place Response","type":"object"},"PopulatedPlaceSummary":{"description":"Minimal populated-place info","example":{"country":"United States of America","countryCode":"US","id":123214,"latitude":40.67,"longitude":-73.94,"name":"New York City","region":"New York","regionCode":"NY","type":"CITY","wikiDataId":"Q60"},"properties":{"country":{"description":"The country name (varies by languageCode)","type":"string"},"countryCode":{"description":"The ISO-3166 country code","type":"string"},"distance":{"description":"Included if this is the result of a distance query","format":"double","type":"number"},"id":{"description":"The place GeoDB native id","format":"int32","type":"integer"},"latitude":{"description":"The place latittude (-90.0 to 90.0)","format":"double","type":"number"},"longitude":{"description":"The place longitude (-180.0 to 180.0)","format":"double","type":"number"},"name":{"description":"The place name (varies by languageCode)","type":"string"},"population":{"description":"The place population","format":"int32","type":"integer"},"region":{"description":"The region name (varies by languageCode)","type":"string"},"regionCode":{"description":"The ISO or FIPS region code","type":"string"},"type":