https://github.com/juliuste/mav

Magyar Államvasutak (MÁV, Hungarian State Railways) API client.
https://github.com/juliuste/mav

library public-transport railway

Last synced: 6 months ago
JSON representation

Magyar Államvasutak (MÁV, Hungarian State Railways) API client.

• Host: GitHub
• URL: https://github.com/juliuste/mav
• Owner: juliuste
• License: isc
• Created: 2017-11-14T05:02:54.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-28T19:13:44.000Z (over 5 years ago)
• Last Synced: 2024-10-17T05:41:16.989Z (12 months ago)
• Topics: library, public-transport, railway
• Language: JavaScript
• Size: 88.9 KB
• Stars: 15
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

          
# mav

Client for the [Magyar Államvasutak](https://www.mavcsoport.hu) (MÁV, Hungarian State Railways) REST API. Unofficial, please ask MÁV for permission before using this module in production.

[![npm version](https://img.shields.io/npm/v/mav.svg)](https://www.npmjs.com/package/mav)

[![Build Status](https://travis-ci.org/juliuste/mav.svg?branch=master)](https://travis-ci.org/juliuste/mav)

[![Greenkeeper badge](https://badges.greenkeeper.io/juliuste/mav.svg)](https://greenkeeper.io/)

[![license](https://img.shields.io/github/license/juliuste/mav.svg?style=flat)](LICENSE)

[![chat on gitter](https://badges.gitter.im/juliuste.svg)](https://gitter.im/juliuste)

## Installation

```shell

npm install --save mav

```

## Usage

This package mostly returns data in the [*Friendly Public Transport Format*](https://github.com/public-transport/friendly-public-transport-format):

- [`stations()`](docs/stations.md) - List of operated stations

- [`departures(station, date = new Date())`](docs/departures.md) - Departures at a given station

- [`trains(trainId)`](docs/trains.md) - Schedule for a given train

- [`journeys(origin, destination, date = new Date())`](docs/journeys.md) - Journeys between stations

## See also

- [build-mav-gtfs](https://github.com/juliuste/build-mav-gtfs) - Generate MÁV GTFS using this module

## Contributing

If you found a bug or want to propose a feature, feel free to visit [the issues page](https://github.com/juliuste/mav/issues).