Meshview API Documentation

This page describes all REST endpoints provided by Meshview.

/api/nodes

GET /api/nodes

Returns a list of mesh nodes.

Query Parameters

ParameterDescription
roleFilter by node role
channelFilter by channel
hw_modelHardware model filter
days_activeOnly nodes seen within X days
Example:
/api/nodes?days_active=3

/api/packets

GET /api/packets

Fetch packets with many filters. Returns decoded packet data.

Query Parameters

ParameterDescription
packet_idReturn exactly one packet
limitMax number of results (1–100)
sinceOnly packets newer than import_time_us
from_node_idFilter by sender node
to_node_idFilter by destination node
node_idLegacy: match either from or to
portnumFilter by port number
containsSubstring filter for payload
Example:
/api/packets?from_node_id=123&limit=100

/api/packets_seen/{packet_id}

GET /api/packets_seen/<packet_id>

Returns list of gateways that heard the packet (RSSI/SNR/hops).

Example:
/api/packets_seen/3314808102

/api/stats

GET /api/stats

Returns aggregated packet statistics for a node or globally.

Query Parameters

ParameterDescription
period_type"hour" or "day"
lengthHow many hours/days
nodeNode ID for combined sent+seen stats
from_nodeFilter by sender
to_nodeFilter by receiver
portnumFilter by port
channelFilter by channel
Example:
/api/stats?node=1128180332&period_type=day&length=1

/api/stats/count

GET /api/stats/count

Returns total packets and total packet_seen entries. When no filters are provided, it returns global totals. When filters are specified, they narrow the time, channel, direction, or specific packet.

Query Parameters

ParameterDescription
period_type"hour" or "day"
lengthNumber of hours or days (depends on period_type)
channelFilter by channel
from_nodeOnly packets sent by this node
to_nodeOnly packets received by this node
packet_idFilter seen counts for specific packet_id
Example:
/api/stats/count?from_node=1128180332&period_type=day&length=1

/api/edges

GET /api/edges

Returns traceroute and/or neighbor edges for graph rendering.

Query Parameters

ParameterDescription
type"traceroute", "neighbor", or omitted for both
Example:
/api/edges?type=neighbor

/api/config

GET /api/config

Returns Meshview configuration (site, MQTT, cleanup, etc.).

/api/config

/api/lang

GET /api/lang

Returns translated text for the UI.

Parameters

langLanguage code (e.g. "en")
sectionOptional UI section (firehose, map, top...)
/api/lang?lang=en§ion=firehose

/health

GET /health

Returns API + database status.

/version

GET /version

Returns Meshview version and Git revision.




Meshview API — generated documentation