/telraam-data

A friendly Python package to download traffic count data from Telraam.net.

Primary LanguagePythonMIT LicenseMIT

telraam-data

A friendly Python package to download traffic count data from Telraam.net.

The telraam_data package enables you to retrieve traffic count data from the Telraam Project API into pandas.DataFrame objects.

Examples

Downloading hourly counts for one segment

from telraam_data import download_segment
data = download_segment(segment_id=1003073114, fmt="per-hour")
data.to_excel("hourly-counts.xls")

Downloading daily counts for all segments

data = download_segment(segment_id="all", fmt="per-day")
data.to_csv("daily-counts.csv")

Plotting weekly average counts for all segments

data = download_segment("all", time_start="2020-01-01 00:00:00Z",
                        time_end="2021-01-01 00:00:00Z", fmt="per-day")
weekly_average = data.set_index('date').resample('7D').mean() * 7
weekly_average.plot(y=["car", "bike", "pedestrian"], marker='o')

Installation

If you have a working version of Python on your system, you can install the package using:

pip install telraam-data

Notes

  • This is a third-party package not officially affiliated with the Telraam project.
  • The Telraam API is documented at https://telraam-api.net.
  • Telraam's data is made available under the CC BY 4.0 license. Thanks Telraam!