Skip to main content

HomeNetworkIQ API Docs

Welcome to the HomeNetworkIQ API documentation.

These docs cover how to ingest TR-181 derived telemetry (TRData) and how to integrate with HomeNetworkIQ using:

  • HTTPS endpoints
  • NATS subjects for event-style ingestion

Quick start​

  1. Obtain a JWT Bearer token (see Security → JWT & key management).
  2. Choose a transport:
    • HTTPS POST for straightforward integrations
    • NATS publish for event-driven pipelines
  3. Send a TRData payload that conforms to the published JSON Schema.

What you’ll find here​

  • API Reference
    • TR-181 TRData Ingest (HTTPS + NATS)
  • Security
    • JWT and key management (placeholder; implementation details coming)
  • SDKs
    • Mobile App SDK (coming soon)

Support / access​

If you need tenant provisioning, subject naming confirmation, or JWT issuance access, contact your HomeNetworkIQ administrator.