Skip to content

2BAD/ryanair

Repository files navigation

Ryanair API

NPM version License GitHub Build Status Code coverage Written in TypeScript Postman Collection

Unofficial typescript client for the Ryanair API that allows you to easily retrieve information about airports, flights and prices.

Install

npm install @2bad/ryanair

Warning: This package is native ESM and no longer provides a CommonJS export. If your project uses CommonJS, you will have to convert to ESM or use the dynamic import() function. Please don't open issues for questions regarding CommonJS / ESM.

Usage

import { airports, fares, flights } from '@2bad/ryanair'

// Get information about the closest airport based on your IP address
const airport = await airports.getClosest()

// Get a list of available dates from a specific destination
const dates = await flights.getDates('BER', 'DUB')

// Or the cheapest one-way fares between two airports for a given start date
const cheapest = await fares.getCheapestPerDay('BER', 'DUB', '2023-10-10')

API

IATA codes

IATA codes are three-letter codes used by the International Air Transport Association (IATA) to identify airports, airlines, and other entities in the aviation industry. These codes are used primarily for ticketing, scheduling, and other administrative purposes.

Airport codes are the most common type of IATA code. They consist of three letters, with the first two letters representing the country and the third letter representing the airport. For example, LAX is the IATA code for Los Angeles International Airport in the United States.

For a full list of available IATA codes, please visit this page.

Error handling

Each function throws an Error if the request to the API fails or the response is invalid. Make sure to handle them or use try-catch statement.

Disclaimer

Please note that this is not an official library and has no affiliation with Ryanair. The wrapper is based on publicly available API, terms of use and limitations of the Ryanair API apply.

Contributing

We welcome contributions! If you find a bug or want to request a new feature, please open an issue. If you want to submit a bug fix or new feature, please open a pull request.

About

Unofficial typescript client for the Ryanair API that allows you to easily retrieve information about airports, flights and prices.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages