Xtream Code API implementation

[JUL1EN094]

Hello everyone,

It would be very useful for me to have the Xtream code api implemented into this wonderful app I'm using everyday. I know a lot of users who will be very happy to have it as well and I already saw the request in other threads (like #202 (comment))

On my side I don't have the required skills to add it myself and so it would be great if a dev could work with me on this new feature. It is not so easy to find documentation and so on on the web, but I'm able to explain how it works and provide all required informations.

Is there any developper interested ?

============================================
Please find below the idea of Xtream code :

• User has to provide these informations : username, password and base_url. He needs as well to define a name for this xtream connection
  

• With these informations, we can get a full list of Lives, Serie and Movie streams. It can provide as well EPG and Replay, depending on the code provider.

============================================
2 possible ways to work with it

1. We can download directly an m3u file with all streams in it. It downloads all streams ordered by type (Live, Serie or Movie) and subcategories.

2. Or we can manage the browsing ourself by creating Lives, Series, Movies and Replays sub-folder for each xtream connection created. Then we are able to download the list of categories and related streams to each one. In this case we don't obtain the results with a m3u but in json format.

How I'm currently working with it and Fermata

Currently I do that MANUALLY to be able to use my xtream code in the app. I don't know if it's the best way but at least it works :

1. I download the full m3u file
2. Then I split it into three m3u file : Live, Serie and Movie --> Why : because the whole file is sometimes too big and can cause a memory issue on my mobile when I import it to the app
3. Then I check and remove/replace no ASCII characters in these 3 files.
4. At the end, I'm able to import these 3 m3u files in Fermata, either in the 'Folders' or in the 'TV' tab. Both works well.

The difficulty is lists can be updated everyday and so I have to repeat these steps each time I want to have updated playlist files in Fermata.

============================================
Please find below documentation

PARAMETERS :

• username --> <user> | ex: Mike
• password --> <pwd> | ex: 1234
• base_url --> <url> | ex: http://xtreamcode.ex

GET WHOLE STREAMS M3U (get.php) :

• Request : <url>/get.php?username=<user>&password=<pwd>&type=m3u_plus&output=ts
• Exemple : http://xtreamcode.ex/get.php?username=Mike&password=1234&type=m3u_plus&output=ts

LIVES (player_api.php) :

Get All live streams list :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_live_streams
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_live_streams

Get live categories list :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_live_categories
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_live_categories

Get streams list of a specific live category :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_live_streams&category_id=<X>
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_live_streams&category_id=25

MOVIES (VOD) (player_api.php) :

Get All VOD streams list :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_vod_streams
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_vod_streams

Get VOD categories list :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_vod_categories
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_vod_categories

Get stream list of a specific VOD category :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_vod_streams&category_id=<X>
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_vod_streams&category_id=4526

Get VOD stream infos :

• Request : <url>/player_api.php?username=<user>&password=c&action=get_vod_info&vod_id=<X>
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_vod_info&vod_id=999

SERIES (player_api.php) :

Get All serie streams list :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_series
• Exemple : <http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_series

Get serie categories list :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_series_categories
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_series_categories

Get streams list of a specific series category :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_series&category_id=<X>
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_series&category_id=214>

Get a serie infos :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_series_info&series=<X>
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_series_info&series=865421

EPG (xmltv.php or player_api.php) :

Get full EPG list for ALL Streams :

• Request : <url>/xmltv.php?username=<user>&password=<pwd>
• Exemple : http://xtreamcode.ex/xmltv.php?username=Mike&password=1234

Get short EPG for a dedicated live streams :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_short_epg&stream_id=36475

• can add &limit=<X> param (default=4)

• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_short_epg&stream_id=55555

Get full EPG for a dedicated live stream :

• Request : <url>/player_api.php?username=<user>&password=<pwd>&action=get_simple_date_table&stream_id=<X>
• Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_simple_date_table&stream_id=55555

[AndreyPavlenko]

Thanks for the doc. It seems doable, but requires some time for development and a server for testing.

[JUL1EN094]

My pleasure. I'll be happy to help with this feature as much as I can.

For testing, I just found these accounts. Don't know if they will works for a long time but it's seems at this time, at least to test calls and get lists :

url : https://starplustv.site
username : 69754974281040
password : 247129511903

url : http://6oclock.xyz
username : oVTsSvYjZu
password : cAXDNm9LY9

I found as well that, maybe can be usefull : https://github.com/zGrav/xtream-iptv-player/blob/master/src/main/java/Network/XtreamCodesApi.java

[AndreyPavlenko]

Thanks. I'll look at it when I have some time. As the starting point, I could try optimizing the memory consumption with large m3u lists. When it's done, we can use the api to get the entire playlist.

[JUL1EN094]

Yes if we can manage the memory it could be the easiest way : get the full m3u, manage special characters + memory optimization and that's it.

In addition :

• I suggest having a cache + a refresh button/option instead of downloading a new file everytime.
• Regarding memory optimization : I think accounts shared above are providing small/medium .m3u file but I'll be able to share a hudge one to test if needed.

[AndreyPavlenko]

The cache is already implemented.

[jkc567]

Hello, can I help implement this requirement (Xtream Api), do you still need it? If so, contact me

[asar-s]

Thanks for the help.
This worked for me.

[zimotech10]

I can't add my device with api. Help me.

[kevmax1]

Hi @AndreyPavlenko,
Please did you know how i can get the link for specific live, vod, series for my player ?

[AndreyPavlenko]

The Xtream code api examples, but I can't check.

[aguilarcarboni]

I am interested, is there anyway we can create a library for this? Doesn't seem too hard

[AndreyPavlenko]

Sorry, but currently I don't have time for that.

[zimotech10]

yes

[wlmirand]

@AndreyPavlenko Are you available to provide information about Xstream Api?
I have a personal goal which is to implement a working proxy, but for that id like to have a basic knowledge about what is Xtream Api and how it works... Maybe get access to some documentation.

[bLightZP]

I am actually implementing the Xtream Codes API into Zoom Player.

The original post includes all the information you need to write a proxy.

From my testing at the moment, there are some incompatibility between different providers and portions of the API are not supported by all providers.

When using this entry point, some providers ignore the "&limit" parameter:
/player_api.php?username=&password=&action=get_short_epg&stream_id=36475&limit=

And the returned JSON is not identical between providers, requiring workarounds and additional safety checks.

Not all providers support the get/xmltv entry points:
/xmltv.php?username=&password=
/get.php?username=&password=&type=m3u_plus&output=ts

[AndreyPavlenko]

@AndreyPavlenko Are you available to provide information about Xstream Api? I have a personal goal which is to implement a working proxy, but for that id like to have a basic knowledge about what is Xtream Api and how it works... Maybe get access to some documentation.

Sorry, I'm not an expert in this, but the description above seems very good and clear.

[fankloano]

I am actually implementing the Xtream Codes API into Zoom Player.

The original post includes all the information you need to write a proxy.

From my testing at the moment, there are some incompatibility between different providers and portions of the API are not supported by all providers.

When using this entry point, some providers ignore the "&limit" parameter: /player_api.php?username=&password=&action=get_short_epg&stream_id=36475&limit=

And the returned JSON is not identical between providers, requiring workarounds and additional safety checks.

Not all providers support the get/xmltv entry points: /xmltv.php?username=&password= /get.php?username=&password=&type=m3u_plus&output=ts

There are other was to get the EPG for a channel. Eventually I can help you?

[bLightZP]

There is a typo here:
Request : /player_api.php?username=&password=&action=get_simple_date_table&stream_id=
Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_simple_date_table&stream_id=55555

It's not "date", it's "data" 🤦‍♂️

[fankloano]

There is a typo here: Request : /player_api.php?username=&password=&action=get_simple_date_table&stream_id= Exemple : http://xtreamcode.ex/player_api.php?username=Mike&password=1234&action=get_simple_date_table&stream_id=55555

It's not "date", it's "data" 🤦‍♂️

Just saw that you already know how to get the EPG :-) werde you successful in implementing the xtream api into your Player?