koleo icon indicating copy to clipboard operation
koleo copied to clipboard

Client for the Polish Koleo (PKP) train API.

koleo

JavaScript client for the Polish Koleo (PKP) train API. Complies with the friendly public transport format. Inofficial, using endpoints by Koleo. Ask them for permission before using this module in production.

You should probably refer to the newer bilkom package instead.

npm version Build Status Greenkeeper badge dependency status license fptf version chat on gitter

Installation

npm install koleo

Usage

const koleo = require('koleo')

This package contains data in the Friendly Public Transport Format and provides the following methods:

  • stations() to get a list of all operated stations such as Warszawa Centralna or Gdańsk Glowny.
  • operators() to get a list of all operators/brands.
  • journeys(origin, destination, date) to get routes between stations.
  • price(journeyId) to get pricing information for a specific journey.

Similar Projects

  • bilkom - Client for the new polish Bilkom (PKP) API (includes price information)
  • pkp-ic - Client for the PKP Intercity API (doesn't have prices)
  • meinfernbus – Client for the Flixbus/Meinfernbus API
  • db-hafas - Client for the german railways (DB) API
  • db-prices - Client for the german railways (DB) price API

Contributing

If you found a bug, want to propose a feature or feel the urge to complain about your life, feel free to visit the issues page.