Player API Documentation

Complete reference for Xtream-Masters Player API endpoints and implementation

API Overview
Base URL: http://your.dns:stream_port/
Authentication: Username & Password
Format: JSON
Encoding: UTF-8

Xtream API Endpoints

Player API Endpoints
Action Endpoint
Authentication
http://your.dns:stream_port/player_api.php?username=X&password=X
Returns user information and authentication status
GET Live Stream Categories
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_live_categories
Retrieve all available live stream categories
GET VOD Stream Categories
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_categories
Retrieve all available VOD categories
GET SERIES Categories
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series_categories
Retrieve all available series categories
GET LIVE Streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_live_streams
Retrieve all live streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_live_streams&category_id=X
Retrieve live streams for a specific category
GET VOD Streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_streams
Retrieve all VOD streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_streams&category_id=X
Retrieve VOD streams for a specific category
GET Latest VOD Streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_latest
Retrieve the 100 latest added VODs
GET VOD Info
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_vod_info&vod_id=X
Retrieve detailed information for a specific VOD
GET SERIES Streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series
Retrieve all series
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series&category_id=X
Retrieve series for a specific category
GET Latest SERIES Streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series_latest
Retrieve the 100 latest added series
GET SERIES Info
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_series_info&series_id=X
Retrieve detailed information for a specific series
GET short_epg for LIVE Streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_short_epg&stream_id=X
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&limit=X
Retrieve short EPG information with custom limit
GET ALL EPG for LIVE Streams
http://your.dns:stream_port/player_api.php?username=X&password=X&action=get_simple_data_table&stream_id=X
Retrieve complete EPG data for a stream
GET ActiveCode Password
http://your.dns:stream_port/player_api.php?action=getactivecodepass
Retrieve ActiveCode password
Full EPG List for all Streams
xmltv.php?username=X&password=X
Retrieve complete XMLTV EPG data for all streams

Example Request

Authentication Request

This example shows how to authenticate a user and retrieve their account information.

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"
  }
}