> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/euzu/tuliprox/llms.txt > Use this file to discover all available pages before exploring further. # Xtream Codes API > Full Xtream Codes-compatible API for media players. Supports player_api.php, stream URLs, catchup/timeshift, and short EPG. tuliprox exposes a complete Xtream Codes-compatible API. Any player that works with an Xtream Codes provider (e.g., Tivimate, IPTV Smarters, OTT Navigator) can connect to tuliprox directly. ## Player API endpoint All three paths are equivalent: | Method | Path | | -------------- | ----------------- | | `GET` / `POST` | `/player_api.php` | | `GET` / `POST` | `/panel_api.php` | | `GET` / `POST` | `/xtream` | ### Authentication parameters Username from `api-proxy.yml`. Required unless `token` is used. Password for the user. Required unless `token` is used. Token credential. Accepted in place of `username` + `password`. The API action to perform. Omit or leave empty to retrieve account info. *** ## Actions ### Account info Omit `action` or set `action=get_account_info`. Returns user credentials, server info, and active connection count. ```bash theme={null} curl "http://localhost:8901/player_api.php?username=alice&password=s3cr3t" ``` The authenticated username. The authenticated password. Welcome message from server config. Authentication status: `1` = authenticated. Account status (e.g., `Active`). Unix timestamp of account expiry. `0` or `1`. Number of currently active connections. Account creation timestamp. Connection limit for this user. Server base URL. Server port. HTTPS port if applicable. `http` or `https`. RTMP port (not used by tuliprox). Server timezone string. Current server Unix timestamp. Current server time as string. *** ### Live categories ``` action=get_live_categories ``` ```bash theme={null} curl "http://localhost:8901/player_api.php?username=alice&password=s3cr3t&action=get_live_categories" ``` Returns a JSON array of category objects. Unique category identifier. Human-readable category name. Parent category ID, `0` for top-level. *** ### VOD categories ``` action=get_vod_categories ``` *** ### Series categories ``` action=get_series_categories ``` *** ### Live streams ``` action=get_live_streams ``` Optional. Filter streams to a specific category. ```bash theme={null} curl "http://localhost:8901/player_api.php?username=alice&password=s3cr3t&action=get_live_streams&category_id=1" ``` *** ### VOD streams ``` action=get_vod_streams ``` Optional. Filter by category. *** ### Series ``` action=get_series ``` Optional. Filter by category. *** ### VOD info ``` action=get_vod_info ``` The virtual stream ID of the VOD item. ```bash theme={null} curl "http://localhost:8901/player_api.php?username=alice&password=s3cr3t&action=get_vod_info&vod_id=5678" ``` *** ### Series info ``` action=get_series_info ``` The virtual stream ID of the series. *** ### Short EPG ``` action=get_short_epg ``` or equivalently: ``` action=get_epg ``` The virtual stream ID of the live channel. Maximum number of EPG entries to return. Defaults to `4`. ```bash theme={null} curl "http://localhost:8901/player_api.php?username=alice&password=s3cr3t&action=get_short_epg&stream_id=1234&limit=4" ``` *** ### Catchup table ``` action=get_catchup_table ``` The virtual stream ID of the live channel. Start time for the catchup window. End time for the catchup window. *** ## Stream URLs Stream URLs are embedded in the playlist items returned by the player API. Media players follow them automatically. ### Live stream (alt path) ``` GET /{username}/{password}/{stream_id} ``` ### Live stream ``` GET /live/{username}/{password}/{stream_id} ``` ### Movie / VOD ``` GET /movie/{username}/{password}/{stream_id} ``` ### Series episode ``` GET /series/{username}/{password}/{stream_id} ``` The virtual stream ID, optionally with a file extension (e.g., `12345.ts`, `12345.mkv`). *** ## Catchup / timeshift stream ### Path-based ``` GET /timeshift/{username}/{password}/{duration}/{start}/{stream_id} ``` Duration of the timeshift segment. Start time of the timeshift segment (format used by the provider). ### Query-based ``` GET /timeshift.php?username=...&password=...&stream=...&duration=...&start=... POST /timeshift.php GET /streaming/timeshift.php?username=...&password=...&stream=...&duration=...&start=... ``` The virtual stream ID of the live channel. Duration of the timeshift window. Start time of the timeshift window. *** ## Resource endpoints Serves associated resources (e.g., cover images, logos) for Xtream playlist items. ``` GET /resource/live/{username}/{password}/{stream_id}/{resource} GET /resource/movie/{username}/{password}/{stream_id}/{resource} GET /resource/series/{username}/{password}/{stream_id}/{resource} ``` *** ## Token stream (web UI) The web UI uses a short-lived JWT access token to stream content without exposing user credentials in URLs. ``` GET /token/{token}/{target_id}/{cluster}/{stream_id} ``` Short-lived JWT access token issued by the web UI. Internal numeric target ID. One of `live`, `movie`, `series`, or `timeshift`. The virtual stream ID. This endpoint is intended for the built-in web player. Do not use it in external automation as tokens expire quickly.