RAIDR/API Reference/Analysis

Analyze link

posthttp://127.0.0.1:8787/api/v1/links/analyze

Runs the full link budget between two stored nodes over sampled terrain: FSPL, diffraction, atmospheric and rain loss, fade margin, antenna gains, SNR, achievable rate, selected modulation, and a closure verdict.

Request

application/json

This endpoint expects an object.

tx_node_idstring <uuid>Required

Transmitting node.

rx_node_idstring <uuid>Required

Receiving node.

samplesintegerOptional

Terrain samples along the path. Clamped to the range.

8 to 4096 · Defaults to 256

Response

200 · application/json

Terrain profile and the full link result. Returns an object.

profileTerrainProfileOptional
resultobjectOptional

The LinkResult: every loss term, SNR, achievable rate, selected modulation, and verdict.

Errors

400
Problem

Malformed request.

404
Problem

Resource not found.