MTA Realtime API JSON Proxy

MTAPI is a small HTTP server that converts the MTA's realtime subway feed from Protocol Buffers/GTFS to JSON. The app also adds caching and makes it possible to retrieve information by location and train line.

Active Development

This project is under active development and any part of the API may change. Feedback is very welcome.

Running the backend

MTAPI is a Flask app designed to run under Python 3.10+.

Create a settings.cfg file. A sample is provided as settings.cfg.sample.
Set up your environment and install dependencies.

$ pyenv virtualenv 3.10.4 MTAPI
$ pyenv activate MTAPI`  
$ poetry install`

Run the server

$ python app.py

If your configuration is named something other than settings.cfg, set the MTAPI_SETTINGS env variable to your configuration path.

This app makes use of Python threads. If running under uWSGI include the --enable-threads flag.

Endpoints

Endpoints to retrieve train data and sample input and output are listed here.

Settings

STATIONS_FILE (required)
Path to the JSON file containing station information. See Generating a Stations File for more info.
default: None
CROSS_ORIGIN
Add CORS headers to the HTTP output.
default: "*" when in debug mode, None otherwise
MAX_TRAINS
Limits the number of trains that will be listed for each station.
default: 10
MAX_MINUTES
Limits how far in advance train information will be listed.
default: 30
CACHE_SECONDS
How frequently the app will request fresh data from the MTA API.
default: 60
THREADED
Enable background data refresh. This will prevent requests from hanging while new data is retreived from the MTA API.
default: True
DEBUG
Standard Flask option. Will enabled enhanced logging and wildcard CORS headers.
default: False

Generating a Stations File

The MTA provides several static data files about the subway system but none include canonical information about each station. MTAPI includes a script that will parse the stops.txt and transfers.txt datasets provided by the MTA and attempt to group the different train stops into subway stations. MTAPI will use this JSON file for station names and locations. The grouping is not perfect and editing the resulting files is encouraged.

Usage:

$ python make_stations_csv.py stops.txt transfers.txt > stations.csv
# edit groupings in stations.csv
$ python make_stations_json.py stations.csv > stations.json
# edit names in stations.json

Help

Submit a GitHub Issues request.

Projects

Here are some projects that use MTAPI.

http://wheresthefuckingtrain.com

License

The project is made available under the BSD license.

maqzi/MTAPI