Xtream API Reference¶

This page summarizes common Xtream-compatible request patterns supported by tunlx.

Every proxy also publishes this API as a live Swagger UI from its own card (OpenAPI), pre-filled with that proxy's real base URL.

The built-in OpenAPI explorer

Parameters¶

username: account username (example: Mike)
password: account password (example: 1234)
base_url: your tunlx proxy/service URL (example: http://proxy.example:8080)

Playlist (`get.php`)¶

Request:

<base_url>/get.php?username=<username>&password=<password>&type=m3u_plus&output=ts

Example:

http://proxy.example:8080/get.php?username=Mike&password=1234&type=m3u_plus&output=ts

Live (`player_api.php`)¶

Get all live streams¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_live_streams

Get live categories¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_live_categories

Get live streams for one category¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_live_streams&category_id=<id>

Movies / VOD (`player_api.php`)¶

Get all VOD streams¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_vod_streams

Get VOD categories¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_vod_categories

Get VOD streams for one category¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_vod_streams&category_id=<id>

Get VOD details¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_vod_info&vod_id=<id>

Series (`player_api.php`)¶

Get all series¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_series

Get series categories¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_series_categories

Get series for one category¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_series&category_id=<id>

Get series details¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_series_info&series_id=<id>

EPG (`xmltv.php` and `player_api.php`)¶

Get full XMLTV EPG¶

<base_url>/xmltv.php?username=<username>&password=<password>

Get short EPG for a stream¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_short_epg&stream_id=<id>&limit=<n>

limit is optional (default: 4).

Get detailed EPG table for a stream¶

<base_url>/player_api.php?username=<username>&password=<password>&action=get_simple_data_table&stream_id=<id>

Compatibility note: tunlx also accepts the legacy action alias get_simple_date_table and normalizes it internally.