cadmium-yellow

A client library for the unofficial Nexus Tyne and Wear Metro real time information API

3 stable releases

2024.3.2 Mar 22, 2024
2024.3.1 Mar 21, 2024
2024.3.0 Mar 20, 2024
Download history 65/week @ 2024-06-18 54/week @ 2024-06-25 18/week @ 2024-07-02 6/week @ 2024-07-09 10/week @ 2024-07-16 23/week @ 2024-07-23 19/week @ 2024-07-30 33/week @ 2024-08-06 29/week @ 2024-08-13 31/week @ 2024-08-20 17/week @ 2024-08-27 1/week @ 2024-09-10 13/week @ 2024-09-17 27/week @ 2024-09-24 31/week @ 2024-10-01

72 downloads per month
Used in metty

MIT license

17KB
255 lines

cadmium-yellow

CI Crates.io Version docs.rs

A client library for the unofficial Nexus Tyne and Wear Metro real time information API.

Usage notes

Keep in mind that this API is for the Pop app and not a public API. When using it, poll the API in a manner that you would expect to come from the Pop app, i.e. quite sporadic, mostly no traffic apart from a few requests over a few minutes.

Things you could use this API for:

  • A better mobile app
  • A command line tool
  • Home automation integration, tied into e.g. a "leaving home" routine

Things you bloody well should not use this API for:

  • A departure board for your living room
  • A widget that tells you when to leave to catch the next Metro (regardless of if you actually have to leave or not)
  • Anything else that wastes requests collecting data that is of zero practical use to anyone

Dependencies

~4–17MB
~238K SLoC