Xtream-Masters API
Player API · Reference

Player API Documentation

Complete reference for the Xtream-Masters Player API — every endpoint, its parameters, and a full authentication example.

/player_api.php Username & password JSON UTF-8
Start here

API overview

All requests are GET calls to the Player API on your streaming server. Authenticate with the account username and password.

Base URL http://your.dns:stream_port/
Authentication Username & password
Response format JSON
Encoding UTF-8
Reference

Player API endpoints

Jump to a section from the sidebar, or filter below. Replace X with your actual values (username, password, category id, stream id, etc.).

Authentication 1 endpoint

GET

Authentication

Returns user information and authentication status.

http://your.dns:stream_port/player_api.php?username=X&password=X

Live Streams 2 endpoints

GET

Live Stream Categories

Retrieve all available live stream categories.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_live_categories
GET

Live Streams

Retrieve all live streams.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_live_streams

Retrieve live streams for a specific category.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_live_streams&category_id=X

VOD Streams 4 endpoints

GET

VOD Stream Categories

Retrieve all available VOD categories.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_categories
GET

VOD Streams

Retrieve all VOD streams.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_streams

Retrieve VOD streams for a specific category.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_streams&category_id=X
GET

Latest VOD Streams

Retrieve the 100 latest added VODs.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_latest
GET

VOD Info

Retrieve detailed information for a specific VOD.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_info&vod_id=X

Series 4 endpoints

GET

Series Categories

Retrieve all available series categories.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series_categories
GET

Series Streams

Retrieve all series.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series

Retrieve series for a specific category.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series&category_id=X
GET

Latest Series Streams

Retrieve the 100 latest added series.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series_latest
GET

Series Info

Retrieve detailed information for a specific series.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series_info&series_id=X

EPG Data 3 endpoints

GET

Short EPG for Live Streams

Retrieve short EPG information for a stream.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_short_epg&stream_id=X

Retrieve short EPG information with a custom limit.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_short_epg&stream_id=X&limit=X
GET

All EPG for Live Streams

Retrieve complete EPG data for a stream.

http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_simple_data_table&stream_id=X
GET

Full EPG List for All Streams

Retrieve complete XMLTV EPG data for all streams.

http://your.dns:stream_port/xmltv.php?username=X&password=X

Utilities 1 endpoint

GET

ActiveCode Password

Retrieve ActiveCode password.

http://your.dns:stream_port/player_api.php?action=getactivecodepass

No endpoints in this category.

Walkthrough

Example request

Authenticate a user and read back their account information.

Authentication request

Send the username and password to the Player API and it returns the account status and server details.

GET /player_api.php?username=your_username&password=your_password HTTP/1.1
Host: your.dns:stream_port
Accept: application/json
Response 
{
  "user_info": {
    "username": "demo_user",
    "password": "demo_pass",
    "message": "User authenticated successfully",
    "auth": 1,
    "status": "Active",
    "exp_date": "1672531199",
    "is_trial": "0",
    "active_cons": "1",
    "created_at": "1577836800",
    "max_connections": "3",
    "allowed_output_formats": ["m3u8", "ts", "rtmp"]
  },
  "server_info": {
    "url": "http://your.dns",
    "port": "stream_port",
    "https_port": "443",
    "server_protocol": "http",
    "rtmp_port": "1935",
    "timezone": "UTC",
    "timestamp_now": 1670000000,
    "time_now": "2022-12-03 10:00:00"
  }
}