manrs

- python class for the manrs api
git clone git://git.acid.vegas/manrs.git
Log | Files | Refs | Archive | README | LICENSE

README.md (1599B)

      1 # MANRS API
      2 ![](logo.png)
      3 
      4 This is a Python wrapper for the [MANRS](https://www.manrs.org/) API, designed to simplify the process of making requests to the MANRS Public API. This class assists in querying data related to routing security, such as ROAs by ASN or country, ASN info, IXP info, and conformance details for CDNs, IXPs, network operators, and equipment vendors.
      5 
      6 The official documentation for the MANRS API can be found [here](https://manrs.stoplight.io/docs/manrs-public-api)
      7 
      8 ## Features:
      9 - Query ROAs by ASN or country.
     10 - Retrieve information about all known ASNs and their holders.
     11 - Fetch data about Internet Exchange Points *(IXPs)*.
     12 - Get conformance details for different entities participating in MANRS.
     13 
     14 ## How to Use:
     15 **Note:** You must [request access](https://www.manrs.org/resources/api) to get an API key!
     16 
     17 1. **Initialization**: Instantiate the `MANRS` class with your API key.
     18 ```python
     19 import manrs
     20 
     21 api = manrs.API('YOUR_API_KEY')
     22 ```
     23 
     24 2. **Making Calls:** Use the provided methods to make calls to the MANRS API. For instance, to get ROAs by ASN:
     25 ```python
     26 response = api.roa_by_asn('AS16661')
     27 ```
     28 
     29 3. **Development Mode:** If you're working in a development environment, set the `dev` flag to `True` during initialization.
     30 ```
     31 api = manrs.API('YOUR_API_KEY', dev=True)
     32 ```
     33 ___
     34 
     35 ###### Mirrors for this repository: [acid.vegas](https://git.acid.vegas/manrs) • [SuperNETs](https://git.supernets.org/acidvegas/manrs) • [GitHub](https://github.com/acidvegas/manrs) • [GitLab](https://gitlab.com/acidvegas/manrs) • [Codeberg](https://codeberg.org/acidvegas/manrs)