gtfs

➡️ Installation | Quick Start | TypeScript Support | Configuration | Query Methods ⬅️





Import and Export GTFS transit data into SQLite. Query or change routes, stops, times, fares and more.

---

node-GTFS loads transit data in GTFS format into a SQLite database and provides some methods to query for agencies, routes, stops, times, fares, calendars and other GTFS data. It also offers spatial queries to find nearby stops, routes and agencies and can convert stops and shapes to geoJSON format. Additionally, this library can export data from the SQLite database back into GTFS (csv) format.

The library also supports importing GTFS-Realtime data into the same database. In order to keep the realtime database fresh, it uses SQLITE REPLACE which makes it very effective.

You can use it as a command-line tool or as a node.js module.

This library has four parts: the GTFS import script, GTFS export script and GTFS-Realtime update script and the query methods

Installation

To use this library as a command-line utility, install it globally with npm:

npm install gtfs -g

This will add the gtfs-import and gtfs-export scripts to your path.

If you are using this as a node module as part of an application, include it in your project's package.json file.

npm install gtfs

Quick Start

Command-line examples

gtfs-import --gtfsUrl https://www.bart.gov/dev/schedules/google_transit.zip

or

gtfs-import --gtfsPath /path/to/your/gtfs.zip

or

gtfs-import --gtfsPath /path/to/your/unzipped/gtfs

or

gtfs-import --configPath /path/to/your/custom-config.json

gtfs-export --configPath /path/to/your/custom-config.json

Code example

import { importGtfs } from 'gtfs';
import { readFile } from 'fs/promises';
import path from 'node:path';

const config = JSON.parse(
  await readFile(path.join(import.meta.dirname, 'config.json'))
);

try {
  await importGtfs(config);
} catch (error) {
  console.error(error);
}

Example Applications

	GTFS-to-HTML uses `node-gtfs` for downloading, importing and querying GTFS data. It provides a good example of how to use this library and is used by over a dozen transit agencies to generate the timetables on their websites.
	GTFS-to-geojson creates geoJSON files for transit routes for use in mapping. It uses `node-gtfs` for downloading, importing and querying GTFS data. It provides a good example of how to use this library.
	GTFS-to-chart generates a stringline chart in D3 for all trips for a specific route using data from an agency's GTFS. It uses `node-gtfs` for downloading, importing and querying GTFS data.
	GTFS Accessibility Validator checks for accessiblity-realted fields and files and flags any issues. It uses `node-gtfs` for downloading, importing and querying GTFS data.
	GTFS-Text-to-Speech app tests GTFS stop name pronunciation for text-to-speech. It uses `node-gtfs` for loading stop names from GTFS data.
	Transit Departures Widget creates a realtime transit departures widget from GTFS and GTFS-Realtime data.

Command-Line Usage

The gtfs-import command-line utility will import GTFS into SQLite3.

The gtfs-export command-line utility will create GTFS from data previously imported into SQLite3.

gtfs-import Command-Line options

configPath

Allows specifying a path to a configuration json file. By default, node-gtfs will look for a config.json file in the directory it is being run from. Using a config.json file allows you specify more options than CLI arguments alone - see below.

gtfs-import --configPath /path/to/your/custom-config.json

gtfsPath

Specify a local path to GTFS, either zipped or unzipped.

gtfs-import --gtfsPath /path/to/your/gtfs.zip

or

gtfs-import --gtfsPath /path/to/your/unzipped/gtfs

gtfsUrl

Specify a URL to a zipped GTFS file.

gtfs-import --gtfsUrl https://www.bart.gov/dev/schedules/google_transit.zip

TypeScript Support

Basic TypeScript typings are included with this library. Please open an issue if you find any inconsistencies between the declared types and underlying code.

Configuration

Copy config-sample.json to config.json and then add your projects configuration to config.json.

cp config-sample.json config.json

option	type	description
agencies	array	An array of GTFS files to be imported, and which files to exclude.
csvOptions	object	Options passed to csv-parse for parsing GTFS CSV files. Optional.
db	database instance	An existing database instance to use instead of relying on node-gtfs to connect. Optional.
downloadTimeout	integer	The number of milliseconds to wait before throwing an error when downloading GTFS. Optional.
exportPath	string	A path to a directory to put exported GTFS files. Optional, defaults to gtfs-export/.
gtfsRealtimeExpirationSeconds	integer	Amount of time in seconds to allow GTFS-Realtime data to be stored in database before allowing to be deleted. Optional, defaults to 0.
ignoreDuplicates	boolean	Whether or not to ignore unique constraints on ids when importing GTFS, such as trip_id, calendar_id. Optional, defaults to false.
ignoreErrors	boolean	Whether or not to ignore errors during the import process. If true, when importing multiple agencies, failed agencies will be skipped. Optional, defaults to false.
sqlitePath	string	A path to an SQLite database. Optional, defaults to using an in-memory database.
verbose	boolean	Whether or not to print output to the console. Optional, defaults to true.

agencies

{Array} Specify the GTFS files to be imported in an agencies array. GTFS files can be imported via a url or a local path.

For GTFS files that contain more than one agency, you only need to list each GTFS file once in the agencies array, not once per agency that it contains.

agencies options

option	type	description
url	string	The URL to a zipped GTFS file. Required if path not present.
path	string	A path to a zipped GTFS file or a directory of unzipped .txt files. Required if url is not present.
headers	object	An object of HTTP headers in key:value format to use when fetching GTFS from the url specified. Optional.
prefix	string	A prefix to be added to every ID field maintain uniqueness when importing multiple GTFS from multiple agencies. Optional.
exclude	array	An array of GTFS file names (without .txt) to exclude when importing. Optional.
realtimeAlerts	object	An object containing a url field for GTFS-Realtime alerts and a headers field in key:value format to use when fetching GTFS-Realtime data. Optional.
realtimeTripUpdates	object	An object containing a url field for GTFS-Realtime trip updates and a headers field in key:value format to use when fetching GTFS-Realtime data. Optional.
realtimeVehiclePositions	object	An object containing a url field for GTFS-Realtime vehicle positions and a headers field in key:value format to use when fetching GTFS-Realtime data. Optional.

• Specify a url to download GTFS:

{
  "agencies": [
    {
      "url": "https://www.bart.gov/dev/schedules/google_transit.zip"
    }
  ]
}

• Specify a download URL with custom headers using the headers field:

{
  "agencies": [
    {
      "url": "https://www.bart.gov/dev/schedules/google_transit.zip",
      "headers": {
        "Content-Type": "application/json",
        "Authorization": "bearer 1234567890"
      }
    }
  ]
}

• Specify a path to a zipped GTFS file:

{
  "agencies": [
    {
      "path": "/path/to/the/gtfs.zip"
    }
  ]
}

• Specify a path to an unzipped GTFS file:

{
  "agencies": [
    {
      "path": "/path/to/the/unzipped/gtfs/"
    }
  ]
}

• If you don't want all GTFS files to be imported, you can specify an array of files to exclude. This can save a lot of time for larger GTFS.

{
  "agencies": [
    {
      "path": "/path/to/the/unzipped/gtfs/",
      "exclude": ["shapes", "stops"]
    }
  ]
}

• Specify urls for GTFS-Realtime updates. realtimeAlerts, realtimeTripUpdates and realtimeVehiclePositions fields accept an object with a url and optional headers field to specify HTTP headers to include with the request, usually for authorization purposes.

{
  "agencies": [
    {
      "url": "https://www.bart.gov/dev/schedules/google_transit.zip",
      "realtimeAlerts": {
        "url": "https://api.bart.gov/gtfsrt/alerts.aspx",
        "headers": {
          "Authorization": "bearer 123456789"
        }
      },
      "realtimeTripUpdates": {
        "url": "https://api.bart.gov/gtfsrt/tripupdate.aspx",
        "headers": {
          "Authorization": "bearer 123456789"
        }
      },
      "realtimeVehiclePositions": {
        "url": "https://api.bart.gov/gtfsrt/vehiclepositions.aspx",
        "headers": {
          "Authorization": "bearer 123456789"
        }
      }
    }
  ]
}

• Specify multiple agencies to be imported into the same database

{
  "agencies": [
    {
      "path": "/path/to/the/gtfs.zip"
    },
    {
      "path": "/path/to/the/othergtfs.zip"
    }
  ]
}

• When importing multiple agencies their IDs may overlap. Specify a prefix to be added to every ID field to maintain uniqueness.

{
  "agencies": [
    {
      "path": "/path/to/the/gtfs.zip",
      "prefix": "A"
    },
    {
      "path": "/path/to/the/othergtfs.zip",
      "prefix": 10000
    }
  ]
}

csvOptions

{Object} Add options to be passed to csv-parse with the key csvOptions. This is an optional parameter.

For instance, if you wanted to skip importing invalid lines in the GTFS file:

    "csvOptions": {
      "skip_lines_with_error": true
    }

See full list of options.

db

{Database Instance} When passing configuration to importGtfs in javascript, you can pass a db parameter with an existing database instance. This is not possible using a json configuration file Optional.

// Using better-sqlite3 to open database
import { importGtfs } from 'gtfs';
import Database from 'better-sqlite3';

const db = new Database('/path/to/database');

importGtfs({
  agencies: [
    {
      path: '/path/to/the/unzipped/gtfs/',
    },
  ],
  db: db,
});

// Using `openDb` from node-gtfs to open database
import { importGtfs, openDb } from 'gtfs';

const db = openDb({
  sqlitePath: '/path/to/database',
});

importGtfs({
  agencies: [
    {
      path: '/path/to/the/unzipped/gtfs/',
    },
  ],
  db: db,
});

downloadTimeout

{Integer} A number of milliseconds to wait when downloading GTFS before throwing an error. Optional.

{
  "agencies": [
    {
      "path": "/path/to/the/unzipped/gtfs/"
    }
  ],
  "downloadTimeout": 5000
}

exportPath

{String} A path to a directory to put exported GTFS files. If the directory does not exist, it will be created. Used when running gtfs-export script or exportGtfs(). Optional, defaults to gtfs-export/ where `` is a sanitized, snake-cased version of the first agency_name in agency.txt.

{
  "agencies": [
    {
      "path": "/path/to/the/unzipped/gtfs/"
    }
  ],
  "exportPath": "~/path/to/export/gtfs"
}

gtfsRealtimeExpirationSeconds

{Integer} Amount of time in seconds to allow GTFS-Realtime data to be stored in database before allowing to be deleted. Defaults to 0 (old GTFS-Realtime is deleted immediately when new data arrives). Note that if new data arrives for the same trip update, vehicle position or service alert before the expiration time, it will overwrite the existing data. The gtfsRealtimeExpirationSeconds only affects when data is deleted.

{
  "agencies": [
    {
      "url": "https://www.bart.gov/dev/schedules/google_transit.zip",
      "realtimeAlerts": {
        "url": "https://api.bart.gov/gtfsrt/alerts.aspx"
      },
      "realtimeTripUpdates": {
        "url": "https://api.bart.gov/gtfsrt/tripupdate.aspx"
      },
      "realtimeVehiclePositions": {
        "url": "https://api.bart.gov/gtfsrt/vehiclepositions.aspx"
      }
    }
  ],
  "gtfsRealtimeExpirationSeconds": false
}

ignoreDuplicates

{Boolean} If you don't want node-GTFS to throw an error when it encounters a duplicate id on GTFS import. If true, it will skip importing duplicate records where unique constraints are violated, such astrip_id, stop_id, calendar_id. Useful if importing GTFS from multiple sources into one SQlite database that share routes or stops. Defaults to false.

{
  "agencies": [
    {
      "path": "/path/to/the/unzipped/gtfs/"
    }
  ],
  "ignoreDuplicates": false
}

ignoreErrors

{Boolean} When importing GTFS from multiple agencies, if you don't want node-GTFS to throw an error and instead skip failed GTFS importants proceed to the next agency. Defaults to false.

{
  "agencies": [
    {
      "path": "/path/to/the/unzipped/gtfs/"
    }
  ],
  "ignoreErrors": true
}

sqlitePath

{String} A path to an SQLite database. Optional, defaults to using an in-memory database with a value of :memory:.

    "sqlitePath": "/dev/sqlite/gtfs"

verbose

{Boolean} If you don't want the import script to print any output to the console, you can set verbose to false. Defaults to true.

{
  "agencies": [
    {
      "path": "/path/to/the/unzipped/gtfs/"
    }
  ],
  "verbose": false
}

If you want to route logs to a custom function, you can pass a function that takes a single text argument as logFunction. This can't be defined in config.json but instead passed in a config object to importGtfs(). For example:

import { importGtfs } from 'gtfs';

const config = {
  agencies: [
    {
      url: 'https://www.bart.gov/dev/schedules/google_transit.zip',
      exclude: ['shapes'],
    },
  ],
  logFunction: function (text) {
    // Do something with the logs here, like save it or send it somewhere
    console.log(text);
  },
};

await importGtfs(config);

gtfs-import Script

The gtfs-import script reads from a JSON configuration file and imports the GTFS files specified to a SQLite database. Read more on setting up your configuration file.

Run the gtfs-import script from command-line

gtfs-import

By default, it will look for a config.json file in the project root. To specify a different path for the configuration file:

gtfs-import --configPath /path/to/your/custom-config.json

Use importGtfs script in code

Use importGtfs() in your code to run an import of a GTFS file specified in a config.json file.

import { importGtfs } from 'gtfs';
import { readFile } from 'fs/promises';
import path from 'node:path';

const config = JSON.parse(
  await readFile(path.join(import.meta.dirname, 'config.json'))
);

await importGtfs(config);

Configuration can be a JSON object in your code

import { importGtfs } from 'gtfs';

const config = {
  sqlitePath: '/dev/sqlite/gtfs',
  agencies: [
    {
      url: 'https://www.bart.gov/dev/schedules/google_transit.zip',
      exclude: ['shapes'],
    },
  ],
};

await importGtfs(config);

gtfsrealtime-update Script

The gtfsrealtime-update script requests GTFS-Realtime data and importings into a SQLite database. GTFS-Realtime data can compliment GTFS Static data. Read more about GTFS-Realtime configuration.

Run the gtfsrealtime-update script from command-line

gtfsrealtime-update

By default, it will look for a config.json file in the project root. To specify a different path for the configuration file:

gtfsrealtime-update --configPath /path/to/your/custom-config.json

Use updateGtfsRealtime script in code

Use updateGtfsRealtime() in your code to run an update of a GTFS-Realtime data specified in a config.json file.

import { updateGtfsRealtime } from 'gtfs';
import { readFile } from 'fs/promises';
import path from 'node:path';

const config = JSON.parse(
  await readFile(path.join(import.meta.dirname, 'config.json'))
);

await updateGtfsRealtime(config);

gtfs-export Script

The gtfs-export script reads from a JSON configuration file and exports data in GTFS format from a SQLite database. Read more on setting up your configuration file.

This could be used to export a GTFS file from SQLite after changes have been made to the data in the database manually.

Make sure to import GTFS data into SQLite first

Nothing will be exported if there is no data to export. See the GTFS import script.

Run the gtfs-export script from Command-line

gtfs-export

By default, it will look for a config.json file in the project root. To specify a different path for the configuration file:

gtfs-export --configPath /path/to/your/custom-config.json

Command-Line options

Specify path to config JSON file

You can specify the path to a config file to be used by the export script.

gtfs-export --configPath /path/to/your/custom-config.json

Show help

Show all command-line options

gtfs-export --help

Use exportGtfs script in code

Use exportGtfs() in your code to run an export of a GTFS file specified in a config.json file.

import { exportGtfs } from 'gtfs';

const config = {
  sqlitePath: '/dev/sqlite/gtfs',
  agencies: [
    {
      url: 'https://www.bart.gov/dev/schedules/google_transit.zip',
      exclude: ['shapes'],
    },
  ],
};

await exportGtfs(config);

Query Methods

This library includes many methods you can use in your project to query GTFS data. In addition to standard static GTFS, node-gtfs supports the following extensions to GTFS:

• GTFS-Realtime - Realtime alerts, vehicle positions and predictions
• GTFS-Ride - Passenger counts
• Operational Data Standard (ODS) - Deadheads and personnel info
• GTFS-Timetables - Information for creating human-readable timetables

There are also methods for retrieving stops and shapes in geoJSON format.

Most query methods accept three optional arguments: query, fields, sortBy and options.

For more advanced queries, you can use advancedQuery or raw SQL queries using query method from better-sqlite3.

Database Setup

To use any of the query methods, first open the database using openDb before making any queries:

import { openDb } from 'gtfs';
import { readFile } from 'fs/promises';
import path from 'node:path';

const config = JSON.parse(
  await readFile(path.join(import.meta.dirname, 'config.json'))
);

const db = openDb(config);

If you no longer need a database (especially if using an in-memory database) you can use closeDb:

import { closeDb, openDb } from 'gtfs';
const db = openDb(config);

// Do some stuff here

// Close database connection when done.
closeDb(db);

Deleting a Database

You can use deleteDb to delete a sqlite3 database from the filesystem.

import { deleteDb, openDb } from 'gtfs';
const db = openDb(config);

// Do some stuff here

// Delete the database
deleteDb(db);

Examples

For example, to get a list of all routes with just route_id, route_short_name and route_color sorted by route_short_name:

import { closeDb, openDb, getRoutes } from 'gtfs';
import { readFile } from 'fs/promises';
import path from 'node:path';

const config = JSON.parse(
  await readFile(path.join(import.meta.dirname, 'config.json'))
);

const db = openDb(config);
const routes = getRoutes(
  {}, // No query filters
  ['route_id', 'route_short_name', 'route_color'], // Only return these fields
  [['route_short_name', 'ASC']], // Sort by this field and direction
  { db: db }, // Options for the query. Can specify which database to use if more than one are open
);

closeDb(db);

To get a list of all trip_ids for a specific route:

import { closeDb, openDb, getTrips } from 'gtfs';
import { readFile } from 'fs/promises';
import path from 'node:path';

const config = JSON.parse(
  await readFile(path.join(import.meta.dirname, 'config.json'))
);

const db = openDb(config);
const trips = getTrips(
  {
    route_id: '123',
  },
  ['trip_id'],
);

closeDb(db);

To get a few stops by specific stop_ids:

import { closeDb, openDb, getStops } from 'gtfs';
import { readFile } from 'fs/promises';
import path from 'node:path';

const config = JSON.parse(
  await readFile(path.join(import.meta.dirname, 'config.json'))
);
const db = openDb(config);
const stops = getStops(
  {
    stop_id: [
      '123',
      '234'
      '345'
    ]
  }
);

closeDb(db);

Static GTFS Files

getAgencies(query, fields, sortBy, options)

Returns an array of agencies that match query parameters. Details on agency.txt

import { getAgencies } from 'gtfs';

// Get all agencies
const agencies = getAgencies();

// Get a specific agency
const agencies = getAgencies({
  agency_id: 'caltrain',
});

getAreas(query, fields, sortBy, options)

Returns an array of areas that match query parameters. Details on areas.txt

import { getAreas } from 'gtfs';

// Get all areas
const areas = getAreas();

// Get a specific area
const areas = getAreas({
  area_id: 'area1',
});

getAttributions(query, fields, sortBy, options)

Returns an array of attributions that match query parameters. Details on attributions.txt

import { getAttributions } from 'gtfs';

// Get all attributions
const attributions = getAttributions();

// Get a specific attribution
const attributions = getAttributions({
  attribution_id: '123',
});

getBookingRules(query, fields, sortBy, options)

Returns an array of booking rules that match query parameters. Details on booking_rules.txt

import { getBookingRules } from 'gtfs';

// Get all booking rules
const bookingRules = getBookingRules();

// Get a specific booking rule
const bookingRules = getBookingRules({
  booking_rule_id: '1234',
});

getRoutes(query, fields, sortBy, options)

Returns an array of routes that match query parameters. Details on routes.txt

import { getRoutes } from 'gtfs';

// Get all routes, sorted by route_short_name
const routes = getRoutes({}, [], [['route_short_name', 'ASC']]);

// Get a specific route
const routes = getRoutes({
  route_id: 'Lo-16APR',
});

/*
 * `getRoutes` allows passing a `stop_id` as part of the query. This will
 * query stoptimes and trips to find all routes that serve that `stop_id`.
 */
const routes = getRoutes(
  {
    stop_id: '70011',
  },
  [],
  [['stop_name', 'ASC']],
);

getStops(query, fields, sortBy, options)

Returns an array of stops that match query parameters. Details on stops.txt

import { getStops } from 'gtfs';

// Get all stops
const stops = getStops();

// Get a specific stop by stop_id
const stops = getStops({
  stop_id: '70011',
});

/*
 * `getStops` allows passing a `route_id` in the query and it will
 * query trips and stoptimes to find all stops served by that `route_id`.
 */
const stops = getStops({
  route_id: 'Lo-16APR',
});

/*
 * `getStops` allows passing a `trip_id` in the query and it will query
 * stoptimes to find all stops on that `trip_id`.
 */
const stops = getStops({
  trip_id: '37a',
});

/*
 * `getStops` allows passing a `shape_id` in the query and it will query
 * trips and stoptimes to find all stops that use that `shape_id`.
 */
const stops = getStops({
  shape_id: 'cal_sf_tam',
});

/*
 * `getStops` allows passing a `bounding_box_side_m` value in the options
 * parameter object. If included, it will return all stops within a square
 * bounding box around the `stop_lat` and `stop_lon` parameters passed to
 * the query using the size in meters specified.
 */
const stops = getStops(
  {
    stop_lat: 37.58764,
    stop_lon: -122.36265,
  },
  [],
  [],
  {
    bounding_box_side_m: 1000
  }
);

getStopsAsGeoJSON(query, options)

Returns geoJSON object of stops that match query parameters. Stops will include all properties of each stop from stops.txt and stop_attributes.txt if present. All valid queries for getStops() work for getStopsAsGeoJSON().

import { getStopsAsGeoJSON } from 'gtfs';

// Get all stops for an agency as geoJSON
const stopsGeojson = getStopsAsGeoJSON();

// Get all stops for a specific route as geoJSON
const stopsGeojson = getStopsAsGeoJSON({
  route_id: 'Lo-16APR',
});

// Get all stops within a 1000m bounding box as geoJSON
const stopsGeojson = getStopsAsGeoJSON(
  {
    stop_lat: 37.58764,
    stop_lon: -122.36265,
  },
  {
    bounding_box_side_m: 1000,
  },
);

getStoptimes(query, fields, sortBy, options)

Returns an array of stop_times that match query parameters. Details on stop_times.txt

import { getStoptimes } from 'gtfs';

// Get all stoptimes
const stoptimes = getStoptimes();

// Get all stoptimes for a specific stop
const stoptimes = getStoptimes({
  stop_id: '70011',
});

// Get all stoptimes for a specific trip, sorted by stop_sequence
const stoptimes = getStoptimes(
  {
    trip_id: '37a',
  },
  [],
  [['stop_sequence', 'ASC']],
);

// Get all stoptimes for a specific stop and service_id
const stoptimes = getStoptimes({
  stop_id: '70011',
  service_id: 'CT-16APR-Caltrain-Weekday-01',
});

/*
 * `getStoptimes` allows passing a `date` in the query to return
 * only stoptimes for a specific day.
 */
const stoptimes = getStoptimes({
  stop_id: '70011',
  date: 20160704
});

/*
 * `getStoptimes` allows passing a `start_time` and/or and 
 * `end_time` in the query to return only stoptimes after 
 * start_time and before end_time. This can be combined with the 
 * `date` parameter to get upcoming stoptimes
 */
const stoptimes = getStoptimes({
  stop_id: '70011',
  date: 20160704,
  start_time: '11:30:00',
  end_time: '11:45:00'
});

getTrips(query, fields, sortBy, options)

Returns an array of trips that match query parameters. Details on trips.txt

import { getTrips } from 'gtfs';

// Get all trips
const trips = getTrips();

// Get trips for a specific route and direction
const trips = getTrips({
  route_id: 'Lo-16APR',
  direction_id: 0
});

// Get trips for direction '' or null
const trips = getTrips({
  route_id: 'Lo-16APR',
  direction_id: null
});

// Get trips for a specific route and direction limited by a service_id
const trips = getTrips({
  route_id: 'Lo-16APR',
  direction_id: 0,
  service_id: '
});

getShapes(query, fields, sortBy, options)

Returns an array of shapes that match query parameters. Details on shapes.txt

import { getShapes } from 'gtfs';

// Get all shapes for an agency
const shapes = getShapes();

/*
 * `getShapes` allows passing a `route_id` in the query and it will query
 * trips to find all shapes served by that `route_id`.
 */
const shapes = getShapes({
  route_id: 'Lo-16APR',
});

/*
 * `getShapes` allows passing a `trip_id` in the query and it will query
 * trips to find all shapes served by that `trip_id`.
 */
const shapes = getShapes({
  trip_id: '37a',
});

/*
 * `getShapes` allows passing a `service_id` in the query and it will query
 * trips to find all shapes served by that `service_id`.
 */
const shapes = getShapes({
  service_id: 'CT-16APR-Caltrain-Sunday-02',
});

getShapesAsGeoJSON(query, options)

Returns a geoJSON object of shapes that match query parameters. Shapes will include all properties of each route from routes.txt and route_attributes.txt if present. All valid queries for getShapes() work for getShapesAsGeoJSON().

import { getShapesAsGeoJSON } from 'gtfs';

// Get geoJSON of all routes in an agency
const shapesGeojson = getShapesAsGeoJSON();

// Get geoJSON of shapes for a specific route
const shapesGeojson = getShapesAsGeoJSON({
  route_id: 'Lo-16APR',
});

// Get geoJSON of shapes for a specific trip
const shapesGeojson = getShapesAsGeoJSON({
  trip_id: '37a',
});

// Get geoJSON of shapes for a specific `service_id`
const shapesGeojson = getShapesAsGeoJSON({
  service_id: 'CT-16APR-Caltrain-Sunday-02',
});

// Get geoJSON of shapes for a specific `shape_id`
const shapesGeojson = getShapesAsGeoJSON({
  shape_id: 'cal_sf_tam',
});

getCalendars(query, fields, sortBy, options)

Returns an array of calendars that match query parameters. Details on calendar.txt

import { getCalendars } from 'gtfs';

// Get all calendars for an agency
const calendars = getCalendars();

// Get calendars for a specific `service_id`
const calendars = getCalendars({
  service_id: 'CT-16APR-Caltrain-Sunday-02',
});

getServiceIdsByDate(date, options)

Returns an array of service_ids for a specified date. It queries both calendars.txt and calendar_dates.txt to calculate which service_ids are effective for that date, including exceptions. The date field is an integer in yyyymmdd format.

import { getServiceIdsByDate } from 'gtfs';

// Get service_ids for a specifc date
const serviceIds = getServiceIdsByDate(20240704);

getCalendarDates(query, fields, sortBy, options)

Returns an array of calendar_dates that match query parameters. Details on calendar_dates.txt

import { getCalendarDates } from 'gtfs';

// Get all calendar_dates for an agency
const calendarDates = getCalendarDates();

// Get calendar_dates for a specific `service_id`
const calendarDates = getCalendarDates({
  service_id: 'CT-16APR-Caltrain-Sunday-02',
});

getFareAttributes(query, fields, sortBy, options)

Returns an array of fare_attributes that match query parameters. Details on fare_attributes.txt

import { getFareAttributes } from 'gtfs';

// Get all `fare_attributes` for an agency
const fareAttributes = getFareAttributes();

// Get `fare_attributes` for a specific `fare_id`
const fareAttributes = getFareAttributes({
  fare_id: '123',
});

getFareLegRules(query, fields, sortBy, options)

Returns an array of fare_leg_rules that match query parameters. Details on fare_leg_rules.txt

import { getFareLegRules } from 'gtfs';

// Get all fare leg rules
const fareLegRules = getFareLegRules();

// Get fare leg rules for a specific fare product
const fareLegRules = getFareLegRules({
  fare_product_id: 'product1',
});

getFareMedia(query, fields, sortBy, options)

Returns an array of fare_media that match query parameters. Details on fare_media.txt

import { getFareMedia } from 'gtfs';

// Get all fare media
const getFareMedia = getFareMedia();

// Get a specific fare media
const fareMedia = getFareMedia({
  fare_media_id: 'media1',
});

getFareProducts(query, fields, sortBy, options)

Returns an array of fare_products that match query parameters. Details on fare_products.txt

import { getFareProducts } from 'gtfs';

// Get all fare products
const fareProducts = getFareProducts();

// Get a specific fare product
const fareProducts = getFareProducts({
  fare_product_id: 'product1',
});

getFareRules(query, fields, sortBy, options)

Returns an array of fare_rules that match query parameters. Details on fare_rules.txt

import { getFareRules } from 'gtfs';

// Get all `fare_rules` for an agency
const fareRules = getFareRules();

// Get fare_rules for a specific route
const fareRules = getFareRules({
  route_id: 'Lo-16APR',
});

getFareTransferRules(query, fields, sortBy, options)

Returns an array of fare_transfer_rules that match query parameters. Details on fare_transfer_rules.txt

import { getFareTransferRules } from 'gtfs';

// Get all fare transfer rules
const fareTransferRules = getFareTransferRules();

// Get a all fare transfer rules for a specific fare product
const fareTransferRules = getFareTransferRules({
  fare_product_id: 'product1',
});

getFeedInfo(query, fields, sortBy, options)

Returns an array of feed_info that match query parameters. Details on feed_info.txt

import { getFeedInfo } from 'gtfs';

// Get feed_info
const feedInfo = getFeedInfo();

getFrequencies(query, fields, sortBy, options)

Returns an array of frequencies that match query parameters. Details on frequencies.txt

import { getFrequencies } from 'gtfs';

// Get all frequencies
const frequencies = getFrequencies();

// Get frequencies for a specific trip
const frequencies = getFrequencies({
  trip_id: '1234',
});

getLevels(query, fields, sortBy, options)

Returns an array of levels that match query parameters. Details on levels.txt

import { getLevels } from 'gtfs';

// Get all levels
const levels = getLevels();

getLocationGroups(query, fields, sortBy, options)

Returns an array of location groups that match query parameters. Details on location_groups.txt

import { getLocationGroups } from 'gtfs';

// Get all location groups
const locationGroups = getLocationGroups();

// Get a specific location group
const locationGroups = getLocationGroups({
  location_group_id: '1234',
});

getLocationGroupStops(query, fields, sortBy, options)

Returns an array of location group stops that match query parameters. Details on location_group_stops.txt

import { getLocationGroupStops } from 'gtfs';

// Get all location group stops
const locationGroupStops = getLocationGroupStops();

// Get location group stops for a specific stop_id
const locationGroups = getLocationGroupStops({
  stop_id: '1234',
});

getLocations(query, fields, sortBy, options)

Returns an array of locations that match query parameters. Each location is text that can be parsed into a geojson object. Details on locations.geojson

import { getLocations } from 'gtfs';

// Get all locations
const locations = getLocations();

getPathways(query, fields, sortBy, options)

Returns an array of pathways that match query parameters. Details on pathways.txt

import { getPathways } from 'gtfs';

// Get all pathways
const pathways = getPathways();

getTimeframes(query, fields, sortBy, options)

Returns an array of timeframes that match query parameters. Details on timeframes.txt

import { getTimeframes } from 'gtfs';

// Get all timeframes
const timeframes = getTimeframes();

getTransfers(query, fields, sortBy, options)

Returns an array of transfers that match query parameters. Details on transfers.txt

import { getTransfers } from 'gtfs';

// Get all transfers
const transfers = getTransfers();

// Get transfers for a specific stop
const transfers = getTransfers({
  from_stop_id: '1234',
});

getTranslations(query, fields, sortBy, options)

Returns an array of translations that match query parameters. Details on translations.txt

import { getTranslations } from 'gtfs';

// Get all translations
const translations = getTranslations();

getStopAreas(query, fields, sortBy, options)

Returns an array of stop_areas that match query parameters. Details on stop_areas.txt

import { getStopAreas } from 'gtfs';

// Get all stop areas
const stopAreas = getStopAreas();

getNetworks(query, fields, sortBy, options)

Returns an array of networks that match query parameters. Details on networks.txt

import { getNetworks } from 'gtfs';

// Get all networks
const networks = getNetworks();

// Get networks for a specific network_id
const networks = getNetworks({
  network_id: '1234',
});

getRouteNetworks(query, fields, sortBy, options)

Returns an array of route_networks that match query parameters. Details on route_networks.txt

import { getRouteNetworks } from 'gtfs';

// Get all route_networks
const routeNetworks = getRouteNetworks();

// Get route_networks for a specific network_id
const routeNetworks = getRouteNetworks({
  network_id: '1234',
});

GTFS-Timetables files

getTimetables(query, fields, sortBy, options)

Returns an array of timetables that match query parameters. This is for the non-standard timetables.txt file used in GTFS-to-HTML. Details on timetables.txt

import { getTimetables } from 'gtfs';

// Get all timetables for an agency
const timetables = getTimetables();

// Get a specific timetable
const timetables = getTimetables({
  timetable_id: '1',
});

getTimetableStopOrders(query, fields, sortBy, options)

Returns an array of timetable_stop_orders that match query parameters. This is for the non-standard timetable_stop_order.txt file used in GTFS-to-HTML. Details on timetable_stop_order.txt

import { getTimetableStopOrders } from 'gtfs';

// Get all timetable_stop_orders
const timetableStopOrders = getTimetableStopOrders();

// Get timetable_stop_orders for a specific timetable
const timetableStopOrders = getTimetableStopOrders({
  timetable_id: '1',
});

getTimetablePages(query, fields, sortBy, options)

Returns an array of timetable_pages that match query parameters. This is for the non-standard timetable_pages.txt file used in GTFS-to-HTML. Details on timetable_pages.txt

import { getTimetablePages } from 'gtfs';

// Get all timetable_pages for an agency
const timetablePages = getTimetablePages();

// Get a specific timetable_page
const timetablePages = getTimetablePages({
  timetable_page_id: '2',
});

getTimetableNotes(query, fields, sortBy, options)

Returns an array of timetable_notes that match query parameters. This is for the non-standard timetable_notes.txt file used in GTFS-to-HTML. Details on timetable_notes.txt

import { getTimetableNotes } from 'gtfs';

// Get all timetable_notes for an agency
const timetableNotes = getTimetableNotes();

// Get a specific timetable_note
const timetableNotes = getTimetableNotes({
  note_id: '1',
});

getTimetableNotesReferences(query, fields, sortBy, options)

Returns an array of timetable_notes_references that match query parameters. This is for the non-standard timetable_notes_references.txt file used in GTFS-to-HTML. Details on timetable_notes_references.txt

import { getTimetableNotesReferences } from 'gtfs';

// Get all timetable_notes_references for an agency
const timetableNotesReferences = getTimetableNotesReferences();

// Get all timetable_notes_references for a specific timetable
const timetableNotesReferences = getTimetableNotesReferences({
  timetable_id: '4',
});

GTFS-Realtime

In order to use GTFS-Realtime query methods, you must first run the GTFS-Realtime update script or function to pull data into your database.

getServiceAlerts(query, fields, sortBy, options)

Returns an array of GTFS Realtime service alerts that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest service alerts from GTFS-Realtime feeds and store in your database, use the GTFS-Realtime update script or function.

More details on Service Alerts

import { getServiceAlerts } from 'gtfs';

// Get service alerts
const serviceAlerts = getServiceAlerts();

getTripUpdates(query, fields, sortBy, options)

Returns an array of GTFS Realtime trip updates that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest trip updates from GTFS-Realtime feeds and store in your database, use the GTFS-Realtime update script or function.

More details on Trip Updates

import { getTripUpdates } from 'gtfs';

// Get all trip updates
const tripUpdates = getTripUpdates();

getStopTimeUpdates(query, fields, sortBy, options)

Returns an array of GTFS Realtime stop time updates that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest stop time updates from GTFS-Realtime feeds and store in your database, use the GTFS-Realtime update script or function.

More details on Stop Time Updates

import { getStopTimeUpdates } from 'gtfs';

// Get all stop time updates
const stopTimeUpdates = getStopTimeUpdates();

getVehiclePositions(query, fields, sortBy, options)

Returns an array of GTFS Realtime vehicle positions that match query parameters. Note that this does not refresh the data from GTFS-Realtime feeds, it only fetches what is stored in the database. In order to fetch the latest vehicle positions from GTFS-Realtime feeds and store in your database, use the GTFS-Realtime update script or function.

More details on Vehicle Positions

import { getVehiclePositions } from 'gtfs';

// Get all vehicle position data
const vehiclePositions = getVehiclePositions();

GTFS+ Files

getCalendarAttributes(query, fields, sortBy, options)

Returns an array of calendar_attributes that match query parameters.

import { getCalendarAttributes } from 'gtfs';

// Get all calendar attributes
const calendarAttributes = getCalendarAttributes();

// Get calendar attributes for specific service
const calendarAttributes = getCalendarAttributes({
  service_id: '1234',
});

getDirections(query, fields, sortBy, options)

Returns an array of directions that match query parameters.

import { getDirections } from 'gtfs';

// Get all directions
const directions = getDirections();

// Get directions for a specific route
const directions = getDirections({
  route_id: '1234',
});

// Get directions for a specific route and direction
const directions = getDirections({
  route_id: '1234',
  direction_id: 1,
});

getRouteAttributes(query, fields, sortBy, options)

Returns an array of route_attributes that match query parameters.

import { getRouteAttributes } from 'gtfs';

// Get all route attributes
const routeAttributes = getRouteAttributes();

// Get route attributes for specific route
const routeAttributes = getRouteAttributes({
  route_id: '1234',
});

getStopAttributes(query, fields, sortBy, options)

Returns an array of stop_attributes that match query parameters.

import { getStopAttributes } from 'gtfs';

// Get all stop attributes
const stopAttributes = getStopAttributes();

// Get stop attributes for specific stop
const stopAttributes = getStopAttributes({
  stop_id: '1234',
});

GTFS-Ride Files

See full documentation of GTFS Ride.

getBoardAlights(query, fields, sortBy, options)

Returns an array of board_alight that match query parameters. Details on board_alight.txt

import { getBoardAlights } from 'gtfs';

// Get all board_alight
const boardAlights = getBoardAlights();

// Get board_alight for a specific trip
const boardAlights = getBoardAlights({
  trip_id: '123',
});

getRideFeedInfo(query, fields, sortBy, options)

Returns an array of ride_feed_info that match query parameters. Details on ride_feed_info.txt

import { getRideFeedInfo } from 'gtfs';

// Get all ride_feed_info
const rideFeedInfos = getRideFeedInfo();

getRiderTrips(query, fields, sortBy, options)

Returns an array of rider_trip that match query parameters. Details on rider_trip.txt

import { getRiderTrips } from 'gtfs';

// Get all rider_trip
const riderTrips = getRiderTrips();

// Get rider_trip for a specific trip
const riderTrips = getRiderTrips({
  trip_id: '123',
});

getRidership(query, fields, sortBy, options)

Returns an array of ridership that match query parameters. Details on ridership.txt

import { getRidership } from 'gtfs';

// Get all ridership
const riderships = getRidership();

// Get ridership for a specific route
const riderships = getRidership({
  route_id: '123',
});

getTripCapacities(query, fields, sortBy, options)

Returns an array of trip_capacity that match query parameters. Details on trip_capacity.txt

import { getTripCapacities } from 'gtfs';

// Get all trip_capacity
const tripCapacities = getTripCapacities();

// Get trip_capacity for a specific trip
const tripCapacities = getTripCapacities({
  trip_id: '123',
});

Operational Data Standard (ODS) Files

getDeadheads(query, fields, sortBy, options)

Returns an array of deadheads that match query parameters. Details on deadheads.txt

import { getDeadheads } from 'gtfs';

// Get all deadheads
const deadheads = getDeadheads();

// Get deadheads for a specific block
const deadheads = getDeadheads({
  block_id: '123',
});

getDeadheadTimes(query, fields, sortBy, options)

Returns an array of deadhead_times that match query parameters. Details on deadhead_times.txt

import { getDeadheadTimes } from 'gtfs';

// Get all deadhead_times
const deadheadTimes = getDeadheadTimes();

// Get deadhead_times for a specific deadhead
const deadheadTimes = getDeadheadTimes({
  deadhead_id: '123',
});

getOpsLocations(query, fields, sortBy, options)

Returns an array of ops_locations that match query parameters. Details on ops_locations.txt

import { getOpsLocations } from 'gtfs';

// Get all ops_locations
const opsLocations = getOpsLocations();

// Get a specific ops_locations
const opsLocations = getOpsLocations({
  ops_location_id: '123',
});

getRunsPieces(query, fields, sortBy, options)

Returns an array of runs_pieces that match query parameters. Details on runs_pieces.txt

import { getRunsPieces } from 'gtfs';

// Get all runs_pieces
const runsPieces = getRunsPieces();

getRunEvents(query, fields, sortBy, options)

Returns an array of run_events that match query parameters. Details on run_events.txt

import { getRunEvents } from 'gtfs';

// Get all run_events
const runEvents = runEvents();

// Get a run_events for a specific piece
const runEvents = runEvents({
  piece_id: '123',
});

Other Non-standard GTFS Files

getTripsDatedVehicleJourneys(query, fields, sortBy, options)

Returns an array of trips_dated_vehicle_journey that match query parameters. This is for the non-standard trips_dated_vehicle_journey.txt file. Details on trips_dated_vehicle_journey.txt

import { getTripsDatedVehicleJourneys } from 'gtfs';

// Get all trips_dated_vehicle_journey
const tripsDatedVehicleJourneys = getTripsDatedVehicleJourneys();

Advanced Query Methods

advancedQuery(table, advancedQueryOptions)

Queries the database with support for table joins and custom tables and returns an array of data.

import { advancedQuery } from 'gtfs';

// Example `advancedQuery` joining stop_times with trips.
const advancedQueryOptions = {
  query: {
    'stop_times.trip_id': tripId,
  },
  fields: ['stop_times.trip_id', 'arrival_time'],
  join: [
    {
      type: 'INNER',
      table: 'trips',
      on: 'stop_times.trip_id=trips.trip_id',
    },
  ],
};

const stoptimes = advancedQuery('stop_times', advancedQueryOptions);

Raw SQLite Query

Use the openDb function to get the db object, and then use any query method from better-sqlite3 to query GTFS data.

import { openDb } from 'gtfs';
const db = openDb(config);

// Get a specific trip
const trip = db.prepare('SELECT * FROM trips WHERE trip_id = ?').get('123');

// Get all stops
const stops = db.prepare('SELECT * from stops').all();

// Get all calendar_ids for specific date
const calendarIds = db
  .prepare(
    'SELECT service_id from calendar WHERE start_date <= $date AND end_date >= $date'
  )
  .all({ date: 20150101 });

// Find all stops for route_id=18 by joining tables
const stopIds = db
  .prepare(
    'SELECT DISTINCT stops.stop_id from stops INNER JOIN stop_times ON stops.stop_id = stop_times.stop_id INNER JOIN trips on trips.trip_id = stop_times.trip_id WHERE trips.route_id = ?'
  )
  .all('18');

// Execute raw SQL
const sql = "DELETE FROM trips where trip_id = '329'";
db.exec(sql);

Contributing

Pull requests are welcome, as is feedback and reporting issues.

Tests

To run tests:

npm test

To run a specific test:

npm test -- get-stoptimes