Teleport public APIs

City Resource

Detailed information about a city

Properties

  • full_name string - The full name of the city, qualified with country and administrative division (if present)
  • geoname_id GeonameID(integer, int32) - The GeoNames.org ID of the city
  • location Coordinates(object) - The coordinates of the city center
  • name string - The name of the city
  • population Population(integer, int64) - The population estimate of the city

Relations

  • city:admin1_division resource: Admin1Division - The level 1 administrative division (e.g. state) that the city belongs to
  • city:alternate-names resource: CityAlternateNames - The alternate names for the city
  • city:country resource: Country - The country that the city belongs to
  • city:timezone resource: Timezone - The timezone of the city
  • city:urban_area resource: UrbanArea - The urban area that the city belongs to

Example

{
    "_links": {
        "city:admin1_division": {
            "href": "https://api.teleport.org/api/countries/iso_alpha2:US/admin1_divisions/geonames:CA/", 
            "name": "California"
        }, 
        "city:alternate-names": {
            "href": "https://api.teleport.org/api/cities/geonameid:5391959/alternate_names/"
        }, 
        "city:country": {
            "href": "https://api.teleport.org/api/countries/iso_alpha2:US/", 
            "name": "United States"
        }, 
        "city:timezone": {
            "href": "https://api.teleport.org/api/timezones/iana:America%2FLos_Angeles/", 
            "name": "America/Los_Angeles"
        }, 
        "city:urban_area": {
            "href": "https://api.teleport.org/api/urban_areas/slug:san-francisco-bay-area/", 
            "name": "San Francisco Bay Area"
        }, 
        "curies": [
            {
                "href": "https://developers.teleport.org/api/resources/Location/#!/relations/{rel}/", 
                "name": "location", 
                "templated": true
            }, 
            {
                "href": "https://developers.teleport.org/api/resources/City/#!/relations/{rel}/", 
                "name": "city", 
                "templated": true
            }, 
            {
                "href": "https://developers.teleport.org/api/resources/UrbanArea/#!/relations/{rel}/", 
                "name": "ua", 
                "templated": true
            }, 
            {
                "href": "https://developers.teleport.org/api/resources/Country/#!/relations/{rel}/", 
                "name": "country", 
                "templated": true
            }, 
            {
                "href": "https://developers.teleport.org/api/resources/Admin1Division/#!/relations/{rel}/", 
                "name": "a1", 
                "templated": true
            }, 
            {
                "href": "https://developers.teleport.org/api/resources/Timezone/#!/relations/{rel}/", 
                "name": "tz", 
                "templated": true
            }
        ], 
        "self": {
            "href": "https://api.teleport.org/api/cities/geonameid:5391959/"
        }
    }, 
    "full_name": "San Francisco, California, United States", 
    "geoname_id": 5391959, 
    "location": {
        "geohash": "9q8yyk8yuv26emr0cctm", 
        "latlon": {
            "latitude": 37.77493, 
            "longitude": -122.41942
        }
    }, 
    "name": "San Francisco", 
    "population": 805235
}