Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/h-exx/natex-api
Ticket finder library for National Express UK
https://github.com/h-exx/natex-api
nationalexpress nodejs reverse-engineering
Last synced: about 7 hours ago
JSON representation
Ticket finder library for National Express UK
- Host: GitHub
- URL: https://github.com/h-exx/natex-api
- Owner: h-exx
- License: mit
- Created: 2022-08-27T13:26:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-05T08:54:52.000Z (about 2 years ago)
- Last Synced: 2024-10-31T17:52:10.450Z (8 days ago)
- Topics: nationalexpress, nodejs, reverse-engineering
- Language: JavaScript
- Homepage: https://npmjs.com/natex-api
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# natex-api
Ticket finder library for National Express UK
#### fyi, this currently does not display connections correctly, only the first journey
Changelog
- **0.0.2-5** - 🐛 whoops. forgot a couple things. bugfixes
- **0.0.1** - :tada: Released with all core features
# EXAMPLES
```js
import * as natex from 'natex-api';
natex.stationSearch('london'); // Expected input: a place
/* Expected output:
[
{
locationName: 'LONDON (Most Popular)',
locationCode: '57000',
isAirport: false,
latitude: null, // these are null as the location is not a specific location. most locations will have a latitude and longitude
longitude: null,
},
{
locationName: 'London Central (LONDON VICTORIA Coach Station',
locationCode: '57366',
isAirport: false,
latitude: '51.492670', // these are null as the location is not a specific location. most locations will have a latitude and longitude
longitude: '-0.149220',
},
{
...
}
]
*/
natex.routeSearch(41000, 57000, { // Expected input: Departure ID, Arrival ID, optional: options (specified below)
leaving: {
departAfterOrArriveBy: 'DEPART_AFTER' // options: DEPART_AFTER, ARRIVE_BY default: DEPART_AFTER
date: "20/09/2022", // default: Date.now()
time: "00:00" // default: Date.now()
},
passengers: {
adults: 1, // default: 1
children: 0, // default: 0
infants: 0 // default: 0
},
coachCards: {
youthCoachcard: 0, // default: 0
seniorCoachard: 0, // default: 0
disabledCoachcard: 0 // default: 0
}
});
/* Expected output:
[
{
departureID: "41065",
departureName: "BRISTOL Bus & Coach Station",
destinationID: "57366",
destinationName: "LONDON VICTORIA Coach Station",
busNumber: "040",
isAvailable: true
departureDateTime: "2022-09-20T12:00:00"
arrivalDateTime: "2022-09-20T15:00:00"
fare: {
amount: "8.90" // Will always be pounds
discount: "0"
},
seats: {
lowAvailability: false
seatStock: 29,
maxCapacity: 72,
unbookReason: null
}
},
{
departureID: "41065",
departureName: "BRISTOL Bus & Coach Station",
destinationID: "57286",
destinationName: "HEATHROW Airport London T2,3 (LHR)",
busNumber: "201",
isAvailable: false
departureDateTime: "2022-09-20T13:00:00"
arrivalDateTime: "2022-09-20T15:05:00"
fare: {
amount: "54" // Will always be pounds
discount: "0"
},
seats: {
lowAvailability: false
seatStock: 0,
maxCapacity: 53,
unbookReason: "Seat Availability"
}
},
{
...
}
]
*/
```
# TODO
### core features
- [x] Station Search
- [x] Route search
### additional core feature
- [ ] Display multiple connections for Route Search
### additional features
- [ ] Bypass ratelimit of route search of 3req/m
- [ ] Ability to search for return journeys
- afaik National Express dont have a discount on returns
- [ ] Look for all Journey stops