API Response Schemas

Query parameters — GET /query

Parameter	Required	Description
`station`	Yes	4 alphanumeric characters (case-insensitive)
`start_time`	Yes	ISO 8601 UTC timestamp
`end_time`	Yes	ISO 8601 UTC timestamp (inclusive range, max 7 days)
`sv`	No	Satellite filter (e.g. `G01`); recommended for full-day queries on busy stations

Query success response (HTTP 200)

{
  "data": [
    {
      "epoch": "2024-05-29T01:00:00Z",
      "sv": "G01",
      "id_arc": 1,
      "lat_ipp": -36.85,
      "lon_ipp": 174.76,
      "azi": 45.2,
      "ele": 30.1,
      "bias": 0.5,
      "stec": 12.3,
      "vtec": 8.7,
      "veq": 9.1
    }
  ],
  "meta": {
    "row_count": 1,
    "truncated": false
  }
}

Meta object

Field	Type	Description
`row_count`	Integer	Number of rows in the `data` array
`truncated`	Boolean	`true` if rows were capped by `QUERY_MAX_ROWS` (default 2000) or trimmed under the Lambda response limit (~5.5 MB)

Catalog response — stations (HTTP 200)

GET /catalog

{
  "stations": ["AUCK", "AVLN", "WGTN"]
}

Catalog response — dates (HTTP 200)

GET /catalog?station=AUCK

{
  "dates": [
    { "year": 2024, "doy": 150 },
    { "year": 2024, "doy": 149 }
  ]
}

Error responses

HTTP 400

{
  "error": "Missing required parameter: station"
}

HTTP 404

{
  "error": "Job not found: \{job_id\}"
}

HTTP 500

{
  "error": "Internal server error"
}

Catalog endpoints return HTTP 500 when DATA_LAKE_BUCKET is missing or when listing fails.

Reprocess request — POST /reprocess

{
  "station": "AUCK",
  "year": 2024,
  "doy": 150,
  "parameters": {
    "NAV_DAY_OFFSET": 2
  }
}

Field	Type	Required	Description
`station`	String	Yes	4 alphanumeric characters
`year`	Integer	Yes	2000–2099
`doy`	Integer	Yes	1–366
`parameters`	Object	No	Override parameters (see SQS Message Schemas)

Reprocess response — POST (HTTP 202)

{
  "job_id": "uuid-v4",
  "status": "queued",
  "trace_id": "uuid-v4"
}

Reprocess response — GET /reprocess/{job_id} (HTTP 200)

{
  "job_id": "uuid-v4",
  "station": "AUCK",
  "year": 2024,
  "doy": 150,
  "status": "completed",
  "output_key": "processed/tec/station=auck/year=2026/doy=179/auck1790.parquet",
  "trace_id": "uuid-v4",
  "created_at": "2024-05-29T00:00:00Z",
  "updated_at": "2024-05-29T00:05:00Z"
}

Example curl commands

export API_URL="$(terraform -chdir=terraform output -raw api_url)"

curl "${API_URL}/catalog"
curl -s "${API_URL}/catalog?station=auck" | jq .
curl -s "${API_URL}/query?station=auck&start_time=2026-06-28T00:00:00Z&end_time=2026-06-28T23:59:59Z&sv=G01" | jq .meta

See REST API Usage for operational guidance.