Xtream Codes

https://github.com/worldofiptvcom/xtream-codes-api
Admin
Xtream Codes is a complete IPTV panel management system that provides APIs for live TV streaming,...
Tokens:69,635
Snippets:539
Trust Score:2.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Live TV Categories API Examples

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/enigma2-api/live-bouquets.md

Use these examples to fetch a list of live TV categories. These categories can be used to organize your bouquets. Ensure you replace placeholder credentials with your actual username and password.

```bash
curl "http://server:25461/enigma2.php?username=user&password=pass&type=get_live_categories"
```

```python
import requests

response = requests.get(
    "http://server:25461/enigma2.php",
    params={
        "username": "user",
        "password": "pass",
        "type": "get_live_categories"
    }
)
categories = response.json()
```

```php
<?php
$params = http_build_query([
    'username' => 'user',
    'password' => 'pass',
    'type' => 'get_live_categories'
]);

$response = file_get_contents("http://server:25461/enigma2.php?$params");
$categories = json_decode($response, true);
```

```javascript
const params = new URLSearchParams({
  username: 'user',
  password: 'pass',
  type: 'get_live_categories'
});

const response = await fetch(`http://server:25461/enigma2.php?${params}`);
const categories = await response.json();
```

--------------------------------

### Get Live Channels with Player API

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/overview.md

Example of how to retrieve a list of live TV channels using the Player API.

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123&action=get_live_streams"
```

--------------------------------

### cURL Examples

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/vod-streams.md

Examples of how to call the Get VOD Streams API using cURL.

```bash
# Get all movies
curl -X GET "http://server:25461/player_api.php?username=demo&password=test123&action=get_vod_streams"

# Get movies by category
curl -X GET "http://server:25461/player_api.php?username=demo&password=test123&action=get_vod_streams&category_id=10"
```

--------------------------------

### Start Local Development Server

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/README.md

Starts a local development server for live preview. Changes are reflected without server restart.

```bash
yarn start
```

--------------------------------

### Get Reseller Credits API Response Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/reseller-management.md

Example JSON response for retrieving reseller credits. It provides a breakdown of the reseller's credit status.

```json
{
  "credits": 100,
  "used_credits": 50,
  "available_credits": 50
}
```

--------------------------------

### Get Series Info with Player API

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/overview.md

Example of how to retrieve detailed information about a specific TV series using the Player API.

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123&action=get_series_info&series_id=123"
```

--------------------------------

### Example Stream URLs

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/streaming/overview.md

These examples demonstrate how to construct full stream URLs for different content types and protocols, including authentication.

```bash
# Live TV - MPEG-TS
http://server:25461/user/pass/12345.ts
```

```bash
# Live TV - HLS
http://server:25461/user/pass/12345.m3u8
```

```bash
# VOD Movie
http://server:25461/movie/user/pass/67890.mkv
```

```bash
# Series Episode
http://server:25461/series/user/pass/11111.mp4
```

--------------------------------

### VOD Start

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/overview.md

Starts VOD encoding. This action requires the `vod` action and `start` sub-action.

```APIDOC
## GET /api.php?action=vod&sub=start

### Description
Starts the VOD encoding process.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be `vod`
- **sub** (string) - Required - Must be `start`

### Request Example
```bash
curl "http://server:25461/api.php?action=vod&sub=start"
```

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains details about the VOD encoding operation.
```

--------------------------------

### List All Servers Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/overview.md

Example of how to list all servers using the Admin API. Ensure requests are made from an authorized server IP.

```bash
# List all servers (from authorized server IP)
curl "http://server:25461/api.php?action=server&sub=list"
```

--------------------------------

### Start Swagger UI with Docker

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/openapi.md

Use this command to start Swagger UI and load the OpenAPI specification. Ensure the YAML file is accessible in the specified volume.

```bash
# Start Swagger UI with Docker
docker run -p 8080:8080 -e SWAGGER_JSON=/openapi/xtream-codes-api.yaml -v $(pwd):/openapi swaggerapi/swagger-ui
```

--------------------------------

### Install Dependencies

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/README.md

Installs project dependencies using Yarn.

```bash
yarn
```

--------------------------------

### Panel API Authentication Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/panel-api/overview.md

Example of how to authenticate with the Panel API using username and password via curl.

```bash
curl "http://server:25461/panel_api.php?username=demo&password=test123"
```

--------------------------------

### Install and Use OpenAPI Generator CLI

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/openapi.md

Install the OpenAPI Generator CLI globally and then use it to generate client libraries for various languages. Specify the input OpenAPI spec file and the desired output directory.

```bash
# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g
```

```bash
# Generate Python client
openapi-generator-cli generate -i xtream-codes-api.yaml -g python -o ./python-client
```

```bash
# Generate JavaScript client
openapi-generator-cli generate -i xtream-codes-api.yaml -g javascript -o ./js-client
```

```bash
# Generate PHP client
openapi-generator-cli generate -i xtream-codes-api.yaml -g php -o ./php-client
```

--------------------------------

### Get Live Categories using JavaScript

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/live-categories.md

Asynchronously retrieve live TV categories using the `fetch` API in JavaScript. This example demonstrates how to construct the URL with search parameters and handle the JSON response.

```javascript
async function getLiveCategories(server, username, password) {
    const url = new URL(`${server}/player_api.php`);
    url.searchParams.set('username', username);
    url.searchParams.set('password', password);
    url.searchParams.set('action', 'get_live_categories');

    const response = await fetch(url);
    return await response.json();
}

// Usage
const server = "http://server:25461";
const categories = await getLiveCategories(server, "demo", "test123");

categories.forEach(category => {
    console.log(`[${category.category_id}] ${category.category_name}`);
});
```

--------------------------------

### Create Stream Link - Response Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/itv-actions.md

Example JSON response when creating a stream link, containing playback information.

```json
{
  "js": {
    "id": 123,
    "cmd": "ffmpeg http://server/live/user/pass/123.ts"
  }
}
```

--------------------------------

### Stream Start

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/overview.md

Starts a specific stream. This action requires the `stream` action and `start` sub-action, along with server and stream IDs.

```APIDOC
## GET /api.php?action=stream&sub=start

### Description
Starts a specific stream.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be `stream`
- **sub** (string) - Required - Must be `start`
- **server_id** (integer) - Required - The ID of the server where the stream is located.
- **stream_id** (string) - Required - The ID of the stream to start.

### Request Example
```bash
curl "http://server:25461/api.php?action=stream&sub=start&server_id=1&stream_id=live/channel1"
```

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains details about the stream operation.
```

--------------------------------

### List Resellers API Response Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/reseller-management.md

Example JSON response when listing resellers. It shows the structure of the returned data, including reseller details.

```json
{
  "resellers": [
    {
      "id": 5,
      "username": "reseller1",
      "credits": 100,
      "created_users": 45
    }
  ]
}
```

--------------------------------

### Response Examples

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/error-codes.md

Examples of JSON responses for various scenarios, including successful and failed authentication, and expired or banned accounts.

```APIDOC
## Response Examples

### Successful Authentication

```json
{
  "user_info": {
    "username": "demo",
    "password": "test123",
    "auth": 1,
    "status": "Active",
    "exp_date": "1735689600",
    "is_trial": "0",
    "active_cons": "1",
    "created_at": "1609459200",
    "max_connections": "2"
  }
}
```

### Failed Authentication

```json
{
  "user_info": {
    "auth": 0,
    "status": "Expired",
    "message": "Account has expired"
  }
}
```

### Expired Account Response

```json
{
  "user_info": {
    "username": "demo",
    "auth": 0,
    "status": "Expired",
    "exp_date": "1609459200",
    "message": "Your subscription has expired"
  }
}
```

### Banned Account Response

```json
{
  "user_info": {
    "username": "demo",
    "auth": 0,
    "status": "Banned",
    "message": "Your account has been suspended"
  }
}
```
```

--------------------------------

### Get Short EPG Data

Source: https://context7.com/worldofiptvcom/xtream-codes-api/llms.txt

Retrieves upcoming program guide data for a live stream. Use the 'limit' parameter to control the number of upcoming programs returned. The 'now_playing' flag indicates the current program, and 'has_archive' indicates replay availability.

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123&action=get_short_epg&stream_id=123&limit=6"
```

```python
from datetime import datetime
import requests

def get_short_epg(server, username, password, stream_id, limit=4):
    r = requests.get(f"{server}/player_api.php", params={
        "username": username, "password": password,
        "action": "get_short_epg", "stream_id": stream_id, "limit": limit
    })
    return r.json()

server = "http://server:25461"
epg = get_short_epg(server, "demo", "test123", 123, limit=6)

for prog in epg.get("epg_listings", []):
    start = datetime.fromtimestamp(prog["start_timestamp"]).strftime("%H:%M")
    end   = datetime.fromtimestamp(prog["stop_timestamp"]).strftime("%H:%M")
    now   = " ◀ NOW" if prog["now_playing"] else ""
    arch  = " [catchup]" if prog["has_archive"] else ""
    print(f"{start}–{end}  {prog['title']}{now}{arch}")
    if prog["description"]:
        print(f"  {prog['description'][:80]}...")

# EPG-based catchup URL format:
# http://server:25461/timeshift/{user}/{pass}/{duration_mins}/{YYYY-MM-DD:HH-MM}/{stream_id}.ts
```

--------------------------------

### Generate Episode Stream URLs (JavaScript)

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/streaming/series.md

This JavaScript example uses the Fetch API to get series information and then constructs stream URLs for each episode. It dynamically determines the file extension, defaulting to 'mkv' if not specified.

```javascript
// Get series info
const params = new URLSearchParams({
  username: 'user',
  password: 'pass',
  action: 'get_series_info',
  series_id: '100'
});

const response = await fetch(`http://server:25461/player_api.php?${params}`);
const seriesInfo = await response.json();

// Build episode URLs
const episodes = seriesInfo.episodes || {};
for (const [season, seasonEpisodes] of Object.entries(episodes)) {
  console.log(`Season ${season}:`);
  for (const episode of seasonEpisodes) {
    const ext = episode.container_extension || 'mkv';
    const url = `http://server:25461/series/user/pass/${episode.id}.${ext}`;
    console.log(`  ${episode.title}: ${url}`);
  }
}

```

--------------------------------

### Start Stream

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/stream-management.md

Starts a specific live stream identified by its ID.

```APIDOC
## Start Stream

### Description
Starts a specific live stream.

### Method
GET

### Endpoint
/api.php?action=stream&sub=start&stream_id={id}

### Parameters
#### Query Parameters
- **stream_id** (integer) - Required - The unique identifier of the stream to start.
```

--------------------------------

### Get Live Categories using Python

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/live-categories.md

Use the `requests` library to call the API and retrieve live TV categories. The function handles constructing the URL and parsing the JSON response. Remember to install the `requests` library if you haven't already.

```python
import requests

def get_live_categories(server, username, password):
    """Get all live TV categories."""
    response = requests.get(f"{server}/player_api.php", params={
        "username": username,
        "password": password,
        "action": "get_live_categories"
    })
    return response.json()

# Usage
server = "http://server:25461"
categories = get_live_categories(server, "demo", "test123")

for category in categories:
    print(f"[{category['category_id']}] {category['category_name']}")
```

--------------------------------

### Start a Live Stream

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/stream-management.md

Use this endpoint to initiate a live stream. Requires the stream ID.

```http
GET /api.php?action=stream&sub=start&stream_id={id}
```

--------------------------------

### Get Full Data

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/panel-api/full-data.md

Fetches all user information, server details, categories, and available channels.

```APIDOC
## GET /panel_api.php

### Description
Returns comprehensive data including user info, server info, all categories, and available channels in a single request.

### Method
GET

### Endpoint
/panel_api.php

### Parameters
#### Query Parameters
- **username** (string) - Required - User's login username
- **password** (string) - Required - User's login password

### Response
#### Success Response (200)
- **user_info** (object) - Contains detailed user information.
- **server_info** (object) - Contains details about the server.
- **categories** (object) - Contains lists of live, movie, and series categories.
- **available_channels** (array) - A list of all available channels.

### Response Example
```json
{
  "user_info": {
    "username": "demo",
    "password": "test123",
    "message": "",
    "auth": 1,
    "status": "Active",
    "exp_date": "1735689600",
    "is_trial": "0",
    "active_cons": "1",
    "created_at": "1609459200",
    "max_connections": "2",
    "allowed_output_formats": ["ts", "m3u8"]
  },
  "server_info": {
    "url": "http://server.example.com",
    "port": "25461",
    "https_port": "25463",
    "server_protocol": "http",
    "rtmp_port": "25462",
    "timezone": "Europe/London",
    "timestamp_now": 1735084800,
    "time_now": "2025-12-24 12:00:00"
  },
  "categories": {
    "live": [
      {"category_id": "1", "category_name": "Sports", "parent_id": 0},
      {"category_id": "2", "category_name": "News", "parent_id": 0}
    ],
    "movie": [
      {"category_id": "10", "category_name": "Action", "parent_id": 0},
      {"category_id": "11", "category_name": "Comedy", "parent_id": 0}
    ],
    "series": [
      {"category_id": "20", "category_name": "Drama", "parent_id": 0}
    ]
  },
  "available_channels": [
    {
      "num": 1,
      "name": "BBC One HD",
      "stream_type": "live",
      "stream_id": 123,
      "stream_icon": "http://example.com/icons/bbc1.png",
      "epg_channel_id": "bbc.one.uk",
      "added": "1609459200",
      "category_id": "1",
      "tv_archive": 1,
      "tv_archive_duration": 7
    }
  ]
}
```
```

--------------------------------

### Get Profile

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/authentication.md

Retrieves the device profile and settings. Requires a valid session token.

```APIDOC
## Get Profile

Returns device profile and settings.

### Method
GET

### Endpoint
/portal.php?type=stb&action=get_profile

### Headers
- **Authorization** (string) - Required - Bearer token obtained from handshake.
- **Cookie** (string) - Required - Device MAC address in the format `mac=XX:XX:XX:XX:XX:XX`.
```

--------------------------------

### Get STB Modules

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/stb-actions.md

Retrieves a list of available modules such as tv, vod, and series.

```http
GET /portal.php?type=stb&action=get_modules
```

--------------------------------

### Get Short EPG

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/epg.md

Retrieves Electronic Program Guide (EPG) data for a specific live stream. This endpoint provides detailed information about upcoming programs, including titles, descriptions, start and end times, and catch-up availability.

```APIDOC
## GET /player_api.php?action=get_short_epg

### Description
Returns Electronic Program Guide (EPG) data for a specific channel.

### Method
GET

### Endpoint
/player_api.php?action=get_short_epg

### Parameters
#### Query Parameters
- **username** (string) - Required - User's login username
- **password** (string) - Required - User's login password
- **action** (string) - Required - Must be `get_short_epg`
- **stream_id** (integer) - Required - Live stream ID
- **limit** (integer) - Optional - Number of EPG entries (default: 4)

### Response
#### Success Response (200)
- **epg_listings** (array) - An array of EPG entries.
  - **id** (string) - EPG entry ID
  - **epg_id** (string) - EPG channel ID
  - **title** (string) - Program title
  - **lang** (string) - Language code
  - **start** (string) - Start time (YYYY-MM-DD HH:MM:SS)
  - **end** (string) - End time (YYYY-MM-DD HH:MM:SS)
  - **description** (string) - Program description
  - **channel_id** (string) - Channel identifier
  - **start_timestamp** (integer) - Start Unix timestamp
  - **stop_timestamp** (integer) - End Unix timestamp
  - **now_playing** (integer) - 1 = currently playing, 0 = not
  - **has_archive** (integer) - 1 = catchup available, 0 = no

### Response Example
```json
{
  "epg_listings": [
    {
      "id": "12345",
      "epg_id": "67",
      "title": "Morning News",
      "lang": "en",
      "start": "2025-12-24 06:00:00",
      "end": "2025-12-24 09:00:00",
      "description": "The latest news, weather, and sports updates.",
      "channel_id": "bbc.one.uk",
      "start_timestamp": 1735020000,
      "stop_timestamp": 1735030800,
      "now_playing": 0,
      "has_archive": 1
    }
  ]
}
```
```

--------------------------------

### Get EPG

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/itv-actions.md

Retrieves Electronic Program Guide (EPG) information for channels. Supports getting short EPG by channel ID or EPG info for a specified period.

```APIDOC
## Get EPG

### Description
Retrieves Electronic Program Guide (EPG) information for channels. Supports getting short EPG by channel ID or EPG info for a specified period.

### Method
GET

### Endpoint
/portal.php?type=itv&action=get_short_epg&ch_id=123
/portal.php?type=itv&action=get_epg_info&period=3

### Parameters
#### Query Parameters
- **ch_id** (integer) - Optional - The ID of the channel to get EPG for.
- **period** (integer) - Optional - The period in hours for which to retrieve EPG information.
```

--------------------------------

### Play a Stream using ffplay

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/intro.md

This example demonstrates how to play a stream using ffplay or a similar media player. Replace USER, PASS, and the stream ID with your actual credentials and stream information.

```bash
# Using VLC, ffplay, or any media player
ffplay "http://server:25461/live/USER/PASS/123.ts"
```

--------------------------------

### Get Modules

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/stb-actions.md

Retrieves a list of available modules on the STB, such as tv, vod, series, etc.

```APIDOC
## Get Modules

### Description
Returns available modules (tv, vod, series, etc.).

### Method
GET

### Endpoint
/portal.php?type=stb&action=get_modules
```

--------------------------------

### Get Short EPG

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/overview.md

Retrieves Electronic Program Guide (EPG) information for a specific live TV channel.

```APIDOC
## Get Short EPG

### Action
`get_short_epg`

### Description
Get EPG for a channel

### Request Example

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123&action=get_short_epg&channel_id=1"
```
```

--------------------------------

### Create User Account

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/user-management.md

Create a new user account with specified credentials and parameters. Ensure all required fields like username and password are provided. Optional parameters include max connections, expiration date, and bouquet assignments.

```bash
curl -X POST "http://server:25461/api.php" \
  -d "action=user" \
  -d "sub=create" \
  -d "username=newuser" \
  -d "password=password123" \
  -d "max_connections=2" \
  -d "exp_date=1767225600" \
  -d "bouquet=[1,2,3]"
```

--------------------------------

### Get Movies by Category with Player API

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/overview.md

Example of how to retrieve a list of movies filtered by category ID using the Player API.

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123&action=get_vod_streams&category_id=10"
```

--------------------------------

### Get Short EPG Data

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/epg.md

Fetches a limited list of EPG (Electronic Program Guide) data for a specific stream. This is useful for displaying upcoming or current programs.

```APIDOC
## getShortEpg

### Description
Fetches a limited list of EPG data for a specific stream.

### Method
POST (inferred from fetch usage, though not explicitly stated)

### Endpoint
`/player_api.php`

### Parameters
#### Query Parameters
- **username** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.
- **action** (string) - Required - Must be set to `get_short_epg`.
- **stream_id** (integer) - Required - The ID of the stream to get EPG data for.
- **limit** (integer) - Optional - The maximum number of EPG entries to return. Defaults to 4.

### Request Example
```javascript
const server = "http://server:25461";
const epg = await getShortEpg(server, "demo", "test123", 123, 6);
```

### Response
#### Success Response (200)
- **epg_listings** (array) - An array of EPG program objects.
  - **title** (string) - The title of the program.
  - **description** (string) - The description of the program.
  - **start_timestamp** (integer) - The start time of the program as a Unix timestamp.
  - **stop_timestamp** (integer) - The end time of the program as a Unix timestamp.
  - **now_playing** (integer) - Indicates if the program is currently playing (1 if true, 0 if false).

#### Response Example
```json
{
  "epg_listings": [
    {
      "title": "Program Title",
      "description": "A brief description of the program.",
      "start_timestamp": 1678886400,
      "stop_timestamp": 1678890000,
      "now_playing": 0
    }
  ]
}
```
```

--------------------------------

### Start a Stream (Admin API)

Source: https://context7.com/worldofiptvcom/xtream-codes-api/llms.txt

Initiate a specific stream using its ID via the Admin API. This action is only permitted from authorized server IPs.

```bash
# Start a stream
curl "http://server:25461/api.php?action=stream&sub=start&stream_id=123"
```

--------------------------------

### Get EPG Information - API Request

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/itv-actions.md

Retrieve Electronic Program Guide (EPG) data for channels. Supports fetching short EPG for a channel or detailed info for a period.

```http
GET /portal.php?type=itv&action=get_short_epg&ch_id=123
```

```http
GET /portal.php?type=itv&action=get_epg_info&period=3
```

--------------------------------

### Get EPG Data (Panel API)

Source: https://context7.com/worldofiptvcom/xtream-codes-api/llms.txt

This Python function retrieves Electronic Program Guide (EPG) data for a specific stream ID using the Panel API. Requires the 'requests' library.

```python
def panel_get_epg(server, username, password, stream_id):
    """Get EPG via Panel API."""
    r = requests.get(f"{server}/panel_api.php", params= {
        "username": username, "password": password,
        "action": "get_epg", "stream_id": stream_id
    })
    return r.json()
```

--------------------------------

### Build Static Website

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/README.md

Generates static content for hosting. Output is placed in the 'build' directory.

```bash
yarn build
```

--------------------------------

### Authenticate with Xtream Codes API

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/intro.md

This command-line example shows how to authenticate with the Player API using your username and password.

```bash
curl "http://server:25461/player_api.php?username=USER&password=PASS"
```

--------------------------------

### Get EPG Data with Python

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/panel-api/get-epg.md

This Python function utilizes the requests library to fetch EPG data from the Panel API. It takes server details, credentials, and a stream ID as input, and prints the start time and title for each program in the EPG listing. Error handling for missing 'epg_listings' is included.

```python
import requests

def get_epg(server, username, password, stream_id):
    response = requests.get(f"{server}/panel_api.php", params={
        "username": username,
        "password": password,
        "action": "get_epg",
        "stream_id": stream_id
    })
    return response.json()

# Usage
epg = get_epg("http://server:25461", "demo", "test123", 123)
for program in epg.get('epg_listings', []):
    print(f"{program['start']} - {program['title']}")
```

--------------------------------

### Deploy Website (SSH)

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/README.md

Deploys the website using SSH. Assumes SSH is configured for Git operations.

```bash
USE_SSH=true yarn deploy
```

--------------------------------

### Stream VOD with JavaScript

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/streaming/vod.md

This JavaScript example demonstrates how to fetch VOD information, construct the stream URL, and set it as the source for an HTML5 video element for playback in a web browser.

```javascript
// Get VOD info first
const infoParams = new URLSearchParams({
  username: 'user',
  password: 'pass',
  action: 'get_vod_info',
  vod_id: '67890'
});

const infoResponse = await fetch(`http://server:25461/player_api.php?${infoParams}`);
const vodInfo = await infoResponse.json();
const extension = vodInfo.movie_data?.container_extension || 'mkv';

// Build stream URL for video player
const streamUrl = `http://server:25461/movie/user/pass/67890.${extension}`;

// Use in HTML5 video element
const video = document.getElementById('video');
video.src = streamUrl;
video.play();
```

--------------------------------

### Stream Management Response Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/stream-management.md

Example JSON response structure for stream-related API calls.

```json
{
  "result": true,
  "streams": [
    {
      "id": 123,
      "name": "BBC One",
      "status": "online",
      "current_viewers": 45
    }
  ]
}
```

--------------------------------

### HLS Chunking Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/streaming/live-tv.md

Demonstrates the structure of an HLS playlist returned when requesting a stream with the `.m3u8` extension.

```APIDOC
## HLS Chunking

When requesting a stream with the `.m3u8` extension, the server returns an HLS playlist containing URLs for individual stream segments.

### Example HLS Playlist
```m3u8
#EXTM3U
#EXT-X-VERSION:3
#EXT-X-TARGETDURATION:10
#EXT-X-MEDIA-SEQUENCE:0
#EXTINF:10.0,
http://server:25461/hls/user/pass/12345/seg-0.ts
#EXTINF:10.0,
http://server:25461/hls/user/pass/12345/seg-1.ts
```

### Segment URL Format
`http://server:25461/hls/{username}/{password}/{stream_id}/seg-{sequence_number}.ts`
```

--------------------------------

### Get VOD Info Endpoint

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/vod-info.md

This section details the GET request to retrieve VOD information.

```APIDOC
## GET /player_api.php?action=get_vod_info

### Description
Returns detailed information about a specific movie, including metadata, cast, and plot.

### Method
GET

### Endpoint
/player_api.php

### Parameters
#### Query Parameters
- **username** (string) - Required - User's login username
- **password** (string) - Required - User's login password
- **action** (string) - Required - Must be `get_vod_info`
- **vod_id** (integer) - Required - Movie/VOD stream ID

### Response
#### Success Response (200)
- **info** (object) - Contains movie metadata.
  - **movie_image** (string) - URL to movie poster
  - **tmdb_id** (string) - TheMovieDB identifier
  - **backdrop_path** (array) - URLs to backdrop images
  - **youtube_trailer** (string) - YouTube video ID for trailer
  - **genre** (string) - Movie genres
  - **plot** (string) - Movie description/synopsis
  - **cast** (string) - Cast members
  - **rating** (string) - Rating out of 10
  - **director** (string) - Director(s)
  - **releasedate** (string) - Release date
  - **duration_secs** (integer) - Duration in seconds
  - **duration** (string) - Formatted duration (HH:MM:SS)
  - **video** (object) - Video codec information
    - **codec_name** (string) - Codec name
    - **width** (integer) - Video width
    - **height** (integer) - Video height
  - **audio** (object) - Audio codec information
    - **codec_name** (string) - Codec name
    - **channels** (integer) - Number of audio channels
  - **bitrate** (integer) - Video bitrate in kbps
- **movie_data** (object) - Contains basic movie data.
  - **stream_id** (integer) - Unique stream identifier
  - **name** (string) - Movie title
  - **added** (string) - Timestamp when added
  - **category_id** (string) - Category ID
  - **container_extension** (string) - File format
  - **custom_sid** (string) - Custom service ID
  - **direct_source** (string) - Direct source URL

### Response Example
```json
{
  "info": {
    "movie_image": "http://example.com/posters/matrix.jpg",
    "tmdb_id": "603",
    "backdrop_path": [
      "http://example.com/backdrops/matrix1.jpg",
      "http://example.com/backdrops/matrix2.jpg"
    ],
    "youtube_trailer": "vKQi3bBA1y8",
    "genre": "Action, Sci-Fi",
    "plot": "A computer hacker learns about the true nature of reality...",
    "cast": "Keanu Reeves, Laurence Fishburne, Carrie-Anne Moss",
    "rating": "8.7",
    "director": "Lana Wachowski, Lilly Wachowski",
    "releasedate": "1999-03-31",
    "duration_secs": 8160,
    "duration": "02:16:00",
    "video": {
      "codec_name": "h264",
      "width": 1920,
      "height": 1080
    },
    "audio": {
      "codec_name": "aac",
      "channels": 6
    },
    "bitrate": 5000
  },
  "movie_data": {
    "stream_id": 456,
    "name": "The Matrix",
    "added": "1609459200",
    "category_id": "10",
    "container_extension": "mkv",
    "custom_sid": "",
    "direct_source": ""
  }
}
```
```

--------------------------------

### Get Profile Endpoint

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/authentication.md

This GET endpoint retrieves the device profile and settings after successful authentication.

```http
GET /portal.php?type=stb&action=get_profile
```

--------------------------------

### Using the Token

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/authentication.md

Demonstrates how to include the obtained session token in subsequent API requests using the Authorization header and a Cookie.

```APIDOC
## Using the Token

Include in all subsequent requests:

```bash
curl "http://server:25461/portal.php?type=stb&action=get_profile" \
  -H "Authorization: Bearer A1B2C3D4E5F6789012345678" \
  -H "Cookie: mac=00:1A:79:XX:XX:XX"
```
```

--------------------------------

### Create New User (Admin API)

Source: https://context7.com/worldofiptvcom/xtream-codes-api/llms.txt

Create a new user account via the Admin API. This requires specifying username, password, maximum connections, expiration date, and optionally a bouquet. The API is IP-restricted.

```bash
# Create a new user
curl -X POST "http://server:25461/api.php" \
  -d "action=user&sub=create&username=newuser&password=password123&max_connections=2&exp_date=1767225600&bouquet=[1,2,3]"
```

--------------------------------

### Create User

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/user-management.md

Create a new user account with specified details.

```APIDOC
## Create User

### Description
Create a new user account with specified details.

### Method
POST

### Endpoint
`/api.php`

### Parameters
#### Request Body
- **action** (string) - Required - Must be `user`.
- **sub** (string) - Required - Must be `create`.
- **username** (string) - Required - Username for the new user.
- **password** (string) - Required - Password for the new user.
- **max_connections** (integer) - Optional - Maximum concurrent connections allowed.
- **exp_date** (integer) - Optional - Expiration timestamp for the user account.
- **bouquet** (array) - Optional - Array of bouquet IDs to associate with the user.
- **is_trial** (integer) - Optional - Set to `1` for a trial account, `0` for a paid account.

### Request Example
```bash
curl -X POST "http://server:25461/api.php" \
  -d "action=user" \
  -d "sub=create" \
  -d "username=newuser" \
  -d "password=password123" \
  -d "max_connections=2" \
  -d "exp_date=1767225600" \
  -d "bouquet=[1,2,3]"
```
```

--------------------------------

### Live TV Streaming with HLS.js in JavaScript

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/streaming/live-tv.md

JavaScript example demonstrating how to use the HLS.js library to play HLS streams in a web browser. Requires an HTML video element.

```javascript
// HLS.js player example
import Hls from 'hls.js';

const video = document.getElementById('video');
const streamUrl = 'http://server:25461/user/pass/12345.m3u8';

if (Hls.isSupported()) {
  const hls = new Hls();
  hls.loadSource(streamUrl);
  hls.attachMedia(video);
  hls.on(Hls.Events.MANIFEST_PARSED, () => {
    video.play();
  });
}
```

--------------------------------

### Get User Info with cURL

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/user-info.md

Use cURL to make a GET request to the player API endpoint with username and password parameters.

```bash
curl -X GET "http://server:25461/player_api.php?username=demo&password=test123"
```

--------------------------------

### Server List

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/admin-api/overview.md

Lists all available servers. This action requires the `server` action and `list` sub-action.

```APIDOC
## GET /api.php?action=server&sub=list

### Description
Lists all servers managed by the system.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be `server`
- **sub** (string) - Required - Must be `list`

### Request Example
```bash
curl "http://server:25461/api.php?action=server&sub=list"
```

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the server list details.
```

--------------------------------

### Xtream Codes API Error Response Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/intro.md

An example of a JSON error response from the Xtream Codes API, indicating an issue such as an expired account.

```json
{
  "user_info": {
    "auth": 0,
    "status": "Expired",
    "message": "Account has expired"
  }
}
```

--------------------------------

### Play Live Stream with FFplay

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/live-streams.md

Use FFplay to play a live stream from its URL.

```bash
ffplay "http://server:25461/live/demo/test123/123.ts"
```

--------------------------------

### EPG-Based Catchup URL Generation (Python)

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/streaming/timeshift.md

This Python script demonstrates how to fetch EPG data for a channel and then construct catchup URLs using the `start_timestamp` and `stop_timestamp` from the EPG listings. This is useful for programmatic access to catchup content based on program schedules.

```python
# Get EPG for channel
epg_response = requests.get(
    "http://server:25461/player_api.php",
    params={
        "username": "user",
        "password": "pass",
        "action": "get_simple_data_table",
        "stream_id": 12345
    }
)
epg_data = epg_response.json()

# Build catchup URL from program start time
for program in epg_data.get("epg_listings", []):
    start_timestamp = program["start_timestamp"]
    end_timestamp = program["stop_timestamp"]
    duration = end_timestamp - start_timestamp

    catchup_url = f"http://server:25461/streaming/timeshift.php?username=user&password=pass&stream=12345&start={start_timestamp}&duration={duration}"
```

--------------------------------

### Python Error Handling Example

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/error-codes.md

A Python code example demonstrating how to handle API errors by checking HTTP status codes and specific error messages within the response.

```APIDOC
## Handling Errors

### Python Example

```python
import requests

def make_api_request(url, params):
    response = requests.get(url, params=params)

    # Check HTTP status
    if response.status_code == 401:
        raise Exception("Authentication failed")
    elif response.status_code == 403:
        raise Exception("Access forbidden")
    elif response.status_code == 406:
        raise Exception("Stream not in bouquet")

    data = response.json()

    # Check auth status in response
    if data.get("user_info", {}).get("auth") == 0:
        status = data["user_info"].get("status", "Unknown")
        message = data["user_info"].get("message", "Authentication failed")
        raise Exception(f"{status}: {message}")

    return data
```
```

--------------------------------

### Username/Password Authentication (cURL)

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/authentication.md

Demonstrates basic username and password authentication using cURL. Credentials are passed as query parameters.

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123"
```

--------------------------------

### Download and Serve M3U Playlist using PHP

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/utilities/playlists.md

This PHP script downloads an M3U playlist and saves it to a file. It also demonstrates how to serve the playlist directly by setting appropriate HTTP headers.

```php
<?php
// Download playlist
$params = http_build_query([
    'username' => 'user',
    'password' => 'pass',
    'type' => 'm3u_plus',
    'output' => 'm3u8'
]);
$playlist = file_get_contents("http://server:25461/get.php?$params");

// Save to file
file_put_contents('playlist.m3u', $playlist);

// Or serve directly
header('Content-Type: audio/x-mpegurl');
header('Content-Disposition: attachment; filename="playlist.m3u"');
echo $playlist;
```

--------------------------------

### Get Live Categories using cURL

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/live-categories.md

Make a GET request to the API endpoint to fetch live TV categories. Ensure you replace `server:25461` with your actual server address and provide valid user credentials.

```bash
curl -X GET "http://server:25461/player_api.php?username=demo&password=test123&action=get_live_categories"
```

--------------------------------

### Python: Fetch Series Info and Episode URL

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/series-info.md

These Python functions use the `requests` library to fetch series information and construct episode stream URLs. Ensure you have the `requests` library installed (`pip install requests`).

```python
import requests

def get_series_info(server, username, password, series_id):
    """Get detailed series information with episodes."""
    response = requests.get(f"{server}/player_api.php", params={
        "username": username,
        "password": password,
        "action": "get_series_info",
        "series_id": series_id
    })
    return response.json()

def get_episode_url(server, username, password, episode_id, extension):
    """Generate episode stream URL."""
    return f"{server}/series/{username}/{password}/{episode_id}.{extension}"
```

--------------------------------

### Get Series Info cURL Request

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/series-info.md

Use this cURL command to make a GET request to the `get_series_info` endpoint. Replace `server`, `demo`, `test123`, and `789` with your actual server details, username, password, and the target series ID.

```bash
curl -X GET "http://server:25461/player_api.php?username=demo&password=test123&action=get_series_info&series_id=789"
```

--------------------------------

### Deploy Website (No SSH)

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/README.md

Deploys the website without using SSH. Requires specifying the GitHub username.

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

--------------------------------

### Get EPG Data with cURL

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/panel-api/get-epg.md

Use this cURL command to make a GET request to the Panel API to retrieve EPG data for a specified stream. Ensure you replace placeholder values with your actual server details, credentials, and stream ID.

```bash
curl -X GET "http://server:25461/panel_api.php?username=demo&password=test123&action=get_epg&stream_id=123"
```

--------------------------------

### Playing Streams with Media Players

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/live-streams.md

Examples of how to play live streams using common media players.

```APIDOC
## Playing Streams

### VLC Media Player

Use the following command in VLC:
```bash
vlc "http://server:25461/live/demo/test123/123.ts"
```

### FFplay

Use the following command with FFplay:
```bash
ffplay "http://server:25461/live/demo/test123/123.ts"
```

### HTML5 with HLS.js

Embed HLS streams in a web page using HLS.js:
```html
<script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
<video id="video" controls></video>
<script>
    const video = document.getElementById('video');
    const src = 'http://server:25461/live/demo/test123/123.m3u8';

    if (Hls.isSupported()) {
        const hls = new Hls();
        hls.loadSource(src);
        hls.attachMedia(video);
    }
</script>
```
```

--------------------------------

### Default Action (Get User and Server Info)

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/overview.md

When no specific action is provided, the API returns user information and server details.

```APIDOC
## Default Action

*(default)*: Get user info and server info

### Request Example

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123"
```
```

--------------------------------

### Get Categories

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/vod-actions.md

Retrieves a list of available VOD categories.

```APIDOC
## GET /portal.php?type=vod&action=get_categories

### Description
Retrieves a list of VOD categories.

### Method
GET

### Endpoint
/portal.php?type=vod&action=get_categories
```

--------------------------------

### Get All Channels

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/itv-actions.md

Retrieves a list of all available TV channels.

```APIDOC
## Get All Channels

### Description
Retrieves a list of all available TV channels.

### Method
GET

### Endpoint
/portal.php?type=itv&action=get_all_channels
```

--------------------------------

### Get Profile

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/mag-portal/stb-actions.md

Retrieves the current STB profile settings.

```APIDOC
## Get Profile

### Description
Retrieves the current STB profile settings.

### Method
GET

### Endpoint
/portal.php?type=stb&action=get_profile
```

--------------------------------

### Get Series Categories

Source: https://github.com/worldofiptvcom/xtream-codes-api/blob/master/docs/player-api/overview.md

Retrieves a list of TV series categories.

```APIDOC
## Get Series Categories

### Action
`get_series_categories`

### Description
List series categories

### Request Example

```bash
curl "http://server:25461/player_api.php?username=demo&password=test123&action=get_series_categories"
```
```
Tokens:
Raw