https://github.com/dannixon/cadmium-yellow

A client library for the unofficial Nexus Tyne and Wear Metro real time information API
https://github.com/dannixon/cadmium-yellow

api-client transport

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dannixon/cadmium-yellow
• Owner: DanNixon
• License: mit
• Created: 2024-03-20T17:09:50.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T14:55:46.000Z (about 2 months ago)
• Last Synced: 2024-09-16T17:43:45.120Z (about 2 months ago)
• Topics: api-client, transport
• Language: Rust
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# cadmium-yellow

[![CI](https://github.com/DanNixon/cadmium-yellow/actions/workflows/ci.yml/badge.svg)](https://github.com/DanNixon/cadmium-yellow/actions/workflows/ci.yml)

[![Crates.io Version](https://img.shields.io/crates/v/cadmium-yellow)](https://crates.io/crates/cadmium-yellow)

[![docs.rs](https://img.shields.io/docsrs/cadmium-yellow)](https://docs.rs/crate/cadmium-yellow)

A client library for the [unofficial Nexus Tyne and Wear Metro real time information API](https://github.com/danielgjackson/metro-rti).

## 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