Frames · Stellar Link

GET/api/v1/frames

List#

Query parameters

protocol

string · nullable

profile

string · nullable

since

string · date-time · nullable

until

string · date-time · nullable

limit

integer

≥ 0

Responses

200OKapplication/json

granularityrequired

string

What ONE entry is. "dma_block" today: the producer pushes one entry per DMA block, so an entry is 4096 useful bytes cut at a boundary that has no relation to any protocol frame. Calling that a frame is the defect STE-989 is about; naming it is the honest half of the fix. For packet granularity use /ws/frames?framing=slot&slot_len=N.

clockrequired

string

How to read timestamp. "boot_relative": the board has no RTC and no NTP, so times start at the epoch on every boot. A control centre would otherwise take them for wall-clock.

empty_reason

string · nullable

null when the page is non-empty. Otherwise WHY it is empty.

framesrequired

array of FrameDRO

FrameDRO · 7 fields

idrequired

string · uuid

timestamprequired

string · date-time

profile

string · nullable

protocolrequired

string

fec_statusrequired

string

crc_ok

boolean · nullable

payload_hexrequired

string

Request

curl "http://192.168.2.1:8080/api/v1/frames"

import requests

BASE_URL = "http://192.168.2.1:8080"

response = requests.get(f"{BASE_URL}/api/v1/frames")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";

let response = reqwest::Client::new()
    .get(format!("{base_url}/api/v1/frames"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "granularity": "string",
  "clock": "string",
  "empty_reason": "string",
  "frames": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "timestamp": "2026-09-29T08:30:00Z",
      "profile": "string",
      "protocol": "string",
      "fec_status": "string",
      "crc_ok": true,
      "payload_hex": "string"
    }
  ]
}

DELETE/api/v1/frames

Purge#

Responses

200OKapplication/json

purgedrequired

integer

≥ 0

Request

curl -X DELETE "http://192.168.2.1:8080/api/v1/frames"

import requests

BASE_URL = "http://192.168.2.1:8080"

response = requests.delete(f"{BASE_URL}/api/v1/frames")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";

let response = reqwest::Client::new()
    .delete(format!("{base_url}/api/v1/frames"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "purged": 0
}

GET/api/v1/frames/{id}

Get one#

Path parameters

idrequired

string · uuid

Frame id

Responses

200OKapplication/json

idrequired

string · uuid

timestamprequired

string · date-time

profile

string · nullable

protocolrequired

string

fec_statusrequired

string

crc_ok

boolean · nullable

payload_hexrequired

string

404not foundapplication/json

ApiErrorDRO

Request

curl "http://192.168.2.1:8080/api/v1/frames/3fa85f64-5717-4562-b3fc-2c963f66afa6"

import requests

BASE_URL = "http://192.168.2.1:8080"
id = "3fa85f64-5717-4562-b3fc-2c963f66afa6"  # Frame id

response = requests.get(f"{BASE_URL}/api/v1/frames/{id}")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";
let id = "3fa85f64-5717-4562-b3fc-2c963f66afa6"; // Frame id

let response = reqwest::Client::new()
    .get(format!("{base_url}/api/v1/frames/{id}"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timestamp": "2026-09-29T08:30:00Z",
  "profile": "string",
  "protocol": "string",
  "fec_status": "string",
  "crc_ok": true,
  "payload_hex": "string"
}

{}