Teleport public APIs

UrbanArea Resource

Teleport urban area (aka Teleport City)

Properties

  • bounding_box BoundingBox(object) - Bounding box of the urban area
  • continent string - The continent where the urban area is located
  • full_name string - Full name of the urban area
  • is_government_partner boolean - Whether the urban_area represents a government partner to Teleport
  • name string - Name of the urban area
  • slug string - Teleport Urban Area slug
  • teleport_city_url URL(string) - Link to Teleport City Profile
  • ua_id UrbanAreaID(string) - Teleport Urban Area ID

Relations

  • ua:admin1-divisions resource: Admin1Division - The level 1 administrative divisions that overlap the urban area
  • ua:cities resource: UrbanAreaCityList - List of all cities belonging to the urban area
  • ua:continent resource: Continent - The continent the urban area is located on
  • ua:countries resource: Country - The countries that overlap the urban area
  • ua:details resource: UrbanAreaDetails - The Teleport City details for the urban area
  • ua:identifying-city resource: City - The main city in the urban area (usually the city the urban area is named after)
  • ua:images resource: UrbanAreaImages - The Teleport City images for the urban area
  • ua:primary-cities resource: City - The primary cities that make up the urban area
  • ua:salaries resource: UrbanAreaSalaries - Salary statistics for the urban area
  • ua:scores resource: UrbanAreaScores - The Teleport City Scores for the urban area

Example

{
    "_links": {
        "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/urban_areas/slug:san-francisco-bay-area/"
        }, 
        "ua:admin1-divisions": [
            {
                "href": "https://api.teleport.org/api/countries/iso_alpha2:US/admin1_divisions/geonames:CA/", 
                "name": "California"
            }
        ], 
        "ua:cities": {
            "href": "https://api.teleport.org/api/urban_areas/slug:san-francisco-bay-area/cities/"
        }, 
        "ua:continent": {
            "href": "https://api.teleport.org/api/continents/geonames:NA/", 
            "name": "North America"
        }, 
        "ua:countries": [
            {
                "href": "https://api.teleport.org/api/countries/iso_alpha2:US/", 
                "name": "United States"
            }
        ], 
        "ua:details": {
            "href": "https://api.teleport.org/api/urban_areas/slug:san-francisco-bay-area/details/"
        }, 
        "ua:identifying-city": {
            "href": "https://api.teleport.org/api/cities/geonameid:5391959/", 
            "name": "San Francisco"
        }, 
        "ua:images": {
            "href": "https://api.teleport.org/api/urban_areas/slug:san-francisco-bay-area/images/"
        }, 
        "ua:primary-cities": [
            {
                "href": "https://api.teleport.org/api/cities/geonameid:5392171/", 
                "name": "San Jose"
            }, 
            {
                "href": "https://api.teleport.org/api/cities/geonameid:5391959/", 
                "name": "San Francisco"
            }, 
            {
                "href": "https://api.teleport.org/api/cities/geonameid:5389489/", 
                "name": "Sacramento"
            }, 
            {
                "href": "https://api.teleport.org/api/cities/geonameid:5378538/", 
                "name": "Oakland"
            }
        ], 
        "ua:salaries": {
            "href": "https://api.teleport.org/api/urban_areas/slug:san-francisco-bay-area/salaries/"
        }, 
        "ua:scores": {
            "href": "https://api.teleport.org/api/urban_areas/slug:san-francisco-bay-area/scores/"
        }
    }, 
    "bounding_box": {
        "latlon": {
            "east": -121.025, 
            "north": 38.719, 
            "south": 36.791, 
            "west": -123.64
        }
    }, 
    "continent": "North America", 
    "full_name": "San Francisco Bay Area, California", 
    "is_government_partner": false, 
    "name": "San Francisco Bay Area", 
    "slug": "san-francisco-bay-area", 
    "teleport_city_url": "https://teleportstaging.site/cities/san-francisco-bay-area/", 
    "ua_id": "9q8yy"
}