API Reference
Endpoints, parameters, defaults, validation limits, and generated XMLTV fields.
GET /xmltv
current
Streams XMLTV as text/xml; charset=utf-8. Query
parameters are optional unless their dependencies are used.
exampleGET /xmltv?tv_count=1&programme_count=10&minute=60&gmt_time=3
| Parameter | Description | Default |
|---|---|---|
| Loading parameter catalog… | ||
Validation and limits
Invalid parameters return HTTP 400 and
{"error":"validation message"}. Unknown
/api/* routes use the same JSON envelope.
- Loading generator limits…
- Constructor interactive preview: 5,000 programmes.
Generated XMLTV fields read-only defaults
Loaded from /schema, the same catalog used by
the application.
| XML field | Source | Default / algorithm | Status |
|---|---|---|---|
| Loading field catalog… | |||
Metadata endpoints
GET /get_xml_tv_ver_2- Non-redirecting v2 compatibility alias with deprecation headers.
GET /health_check- HTTP 200,
text/plain, bodyOK. GET /version- Application version, build ID, Git ref, and commit SHA as JSON.
GET /schema- Machine-readable generated-field catalog as JSON.
GET /metrics- Prometheus metrics when
METRICS_ENABLED=true.
GET /get_xml_tv
deprecated
Retained for compatibility. New integrations should use v2; the Constructor can import and convert existing v1 URLs.
| Parameter | Description | Default |
|---|---|---|
tv_count | Number of channels | 1 |
programme_count | Past and future slots | 10 |
minute | Programme duration | 60 |
gmt_time | Timezone offset string | +0300 |
ch_id_start | First channel ID | 69 |
programme_title | Title template | Programme title text |
programme_desc | Description template | Programme desc text |
icon_link | Programme icon URL | demo logo |