amtrack_rs
| Crates.io | amtrack_rs |
| lib.rs | amtrack_rs |
| version | 0.1.4 |
| source | src |
| created_at | 2024-10-11 02:21:57.240777 |
| updated_at | 2024-10-11 04:50:23.707306 |
| description | A fully open-source Rust-based API and Package for fetching live train and station data from Amtrak. |
| homepage | |
| repository | https://github.com/qpxdesign/amtrack_rs/ |
| max_upload_size | |
| id | 1404823 |
| size | 788,827 |
Quinn Patwardhan (QpxDesign)
documentation
README
Amtrack: a Fully-Open Source Amtrak GetTrains & GetStations API and Package
This project aims to be a complete remake of piemadd's amtrak npm package, with exactly the same fields and structure. Piemadd's actual API is closed-source, and they only provide a wrapper package written in Javascript. Other rust packages that claim to provide a rust-interface to this data just use piemadd's closed-source API. This package and api is different: it fetches data directly from Amtrak, and gives you access to all raw and formatted headers. You are welcome to use the API in your projects. Please note that the API is behind a redis cache-layer, as to avoid overuse of Amtrak's API and to drastically improve speeds. The cache layer typically only adds 10-15 seconds of delay at worst. The package does not have this cache layer, and you are welcome to use it to quickly create and host your own API.
API
We offer three API Endpoints:
https://amtrak-api.marcmap.app/get-trains, which fetches live train data from Amtrak and formattes it identically toapi.amtraker.comhttps://amtrak-api.marcmap.app/get-stations, which gets station metadata from a static file and formats it identically toapi.amtraker.com(we use a static file as Amtrak stations very rarely change, but we plan on adding updated station data soon)https://amtrak-api.marcmap.app/get-trains-raw, raw, decrypted live train data
Package
- Our package has two functions:
GetTrains()andGetStations(), which are the same as ourget-trainsandget-stationsendpoints (only without the cache layer).GetTrainsreturnsOption<GetTrainsResponse>, andGetStationsreturns a stringified JSON file as:Option<String>.
Install With:
cargo add amtrack_rs
Usage Limits
None! If things get crazy, I might add some IP-based rate limiting, but I highly doubt that will happen. If you want to support this project, or my other transit-based projects, please consider sponsoring me, or just star this project! If you use it in an app or website, please put a link to my website somewhere. (i.e. "data provided by https://quinnpatwardhan.com/") Not at all a requirement, just if you're willing.