peeringdb-rs: unofficial utility crate for accessing PeeringDB data

This readme is generated from the library's doc comments using cargo-readme. Please refer to the Rust docs website for the full documentation

Accessing PeeringDB data with API calls

peeringdb_rs is a utility crate to help users accessing important data provided by PeeringDB with their public API.

This is an unofficial crate and use it with caution.

Supported Data Types

• net: [PeeringdbIx]
• org: [PeeringdbOrg]
• ix: [PeeringdbIx]
• netixlan: [PeeringdbNetixlan]

Use the public function load_peeringdb_XXXX() to get a Vec of the corresponding data objects above. For example, [load_peeringdb_net] will return a Vec of [PeeringdbNet] if success.

Each data type also has a load_peeringdb_XXXX_filtered() variant that takes PeeringDB API query parameters, so you can fetch a subset instead of the whole table. For example, load_peeringdb_netixlan_filtered(&[("ix_id", "26")]) fetches only the netixlan records of one exchange.

PeeringDB API key required

It is strongly recommended to obtain a PeeringDB API key and set the PEERINGDB_API_KEY environment variable. Without it, the API call will likely to fail due to rate limiting.

License

See PeeringDB Acceptable Use Policy for usage and license information.

The usage of this library is under MIT license.