Skip to main content

Network Data API

Project description

NIAPI Logo - Light NIAPI Logo - Dark

Project Status
CI/CD Latest Release ci Documentation Building CodeQL
Package PyPI - Version PyPI - Support Python Versions
Quality codecov Coverage Quality Gate Status Maintainability Rating Reliability Rating Security Rating Known Vulnerabilities
Community Twitter
Meta Litestar Framework linting - Ruff code style - Black types - Mypy License - MIT GitHub Sponsors


niapi - Network Information API

Table of Contents



pip install niapi


Install the project:

pip install -e .

Run the project:

NOTE: From within the virtual environment

app run -r --debug

Using the CLI:

# via curl
➜ curl --request GET \
        --url '' \
        --header 'Content-Type: application/json'
# via App CLI
app calculate ""

Using the API

  1. Browse to:
  2. Use the auto-generated API docs to interact with the API

From around the web:

Browse to and use the front page form, API, or curl to interact with the API.


See CONTRIBUTING.rst for more information.

Start the app:

app run-all

Start the TailwindCSS watcher:

tailwindcss -i niapi/domain/web/resources/input.css -o niapi/domain/web/resources/style.css --watch






home.png home-dark.png img.png

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

niapi-0.5.0.tar.gz (92.1 kB view hashes)

Uploaded Source

Built Distribution

niapi-0.5.0-py3-none-any.whl (98.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page