Home

Awesome

generate-db-shop-urls

Magically generate Deutsche Bahn ticket URLs. Given a journey queried with hafas-client@5, it tries to generate a matching ticket link in the Deutsche Bahn shop. Caveats:

npm version Prosperity/Apache license support me via GitHub Sponsors chat with me on Twitter

Installing

npm install generate-db-shop-urls

Usage

generate-db-shop-urls expects one (outbound) or two (outbound & returning) journeys queried with hafas-client@5 as input.

const createHafas = require('db-hafas')
const generateTicketLink = require('generate-db-shop-urls')

const berlin = '8096003'
const hamburg = '8000157'
const hafas = createHafas('my-awesome-program')

const outbound = await hafas.journeys(berlin, hamburg, {
	departure: new Date('2017-05-18T05:00+0200'),
	results: 1,
})
const returning = await hafas.journeys(hamburg, berlin, {
	departure: new Date('2017-05-19T12:00+0200'),
	results: 1,
})

const link = await generateTicketLink(outbound.journeys[0], {
	returning:  returning.journeys[0],
})
console.log(link)

API

async (outbound, opt = {}) => {}

opt overrides the default options which look as follows:

{
	// type of BahnCard, '0' = no bahncard
	// see https://gist.github.com/juliuste/202bb04f450a79f8fa12a2ec3abcd72d
	bahncard: '0',
	class: '2', // '1' or '2'
	age: 40, // age of the traveller
	returning: null // returning journey to match (optional)
}

License

This project is dual-licensed: My contributions are licensed under the Prosperity Public License, contributions of other people are licensed as Apache 2.0.

This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.

Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn’t count as use for a commercial purpose.

Get in touch with me to buy a commercial license or read more about why I sell private licenses for my projects.

The DB Haltestellendaten dataset used by this project is licensed under CC-BY 4.0.

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.

By contributing, you agree to release your modifications under the Apache 2.0 license.