Teleport API with Python (How to Get Geographical Data)

The teleport API allows to gather data about a geographical areas for free.

Teleport allows you to gather data from cities such as:

  • Population
  • Geographical area
  • Salaries
  • Job market
  • Cost of living
  • Images
  • and more

In this tutorial, we will learn how to use the teleport API to gather geographical data.

Subscribe to my Newsletter

Example Result using the Teleport API with Python

What is the Teleport API

The teleport API is an open-source application programming interface that allows you to gather data from geographical regions.

Using The Teleport API with Python

Information about the API can be found on the official Teleport API Documentation.

How the API works?

The Transport API is an open API for which you can simply call the endpoint.

For instance, if you open the following URL in your browser, you will see that no authentication is required to use the API.

In order to use the API with Python, we simply need to use the Python Requests library.

Create the Functions to Get the Data

import requests

def get_teleport_data(city_name):
    ua_endpoint = get_urban_area_endpoint(city_name)
    results = {}
    if ua_endpoint:
        details = get_area_details(ua_endpoint)
        results['details'] = details
        images = get_area_images(ua_endpoint)
        results['images'] = images
        scores = get_area_scores(ua_endpoint)
        results['scores'] = scores
    return results

def get_urban_area_endpoint(city_name):
        cities_endpoint = ''
        url = f'{cities_endpoint}?search={city_name}'
        r = requests.get(url)
        r = r.json()
        geoname_url = r['_embedded']['city:search-results'][0]['_links']['city:item']['href']
        r2 = requests.get(geoname_url)
        r2 = r2.json()
        ua_endpoint = r2['_links']['city:urban_area']['href']
        return ua_endpoint
        return None

def get_area_details(ua_endpoint):
        r = requests.get(ua_endpoint + 'details/')
        r = r.json()

        result = {}

        for cat in r['categories']:
            result[cat['label']] = {}
            for i in cat['data']:
                name = i['label']
                key = [k for k in i.keys() if 'value' in k][0]
                score = i[key]
                # result[name] = score
                result[cat['label']][name] = score
        return result
        return 'not_found'

def get_area_images(ua_endpoint):
        r = requests.get(ua_endpoint + 'images/')
        r = r.json()
        return r['photos']
        return 'not_found'

def get_area_scores(ua_endpoint):
        r = requests.get(ua_endpoint + 'scores/')
        r = r.json()
        result = {}
        for i in r['categories']:
            name = i['name']
            score = i['score_out_of_10']
            result[name] = score
        return result
        return 'not_found'

Return the Result

city_name = 'Boston'

results = get_teleport_data(city_name)

Get Images for the City


Show the City Scores



This is it, for more examples on how to use the Transport API with Python, just go to the official documentation website.

5/5 - (2 votes)