Channels (regions/channels)

Channels are represented as objects with the following fields (NOTE: All fields are read-only).

Name

Type

Comment

id

integer

The channel's ID

name

string

The channel's name

name_short

string

The short version of the channel's name (only use if screen space is scarce)

network_id

integer

The IceTV network ID

region_id

integer

The IceTV region ID

is_hd

integer

0 = Channel is an SD channel, 1 = Channel is a HD channel

lcns

string

Comma separated list of Logical Channel Numbers (LCN's) available for this channel

region_name

string

The IceTV region name

network_name

string

The IceTV network name

is_hidden

integer

Has the user hidden this channel

icon_src

string

The URL of the icon for this channel

icon_width

integer

 

icon_height

integer

 

dvb

array

Array of DVB triplet elements

DVB triplet are represented as objects with the following fields (NOTE: All fields are read-only).

Name

Type

Comment

original_network_id

integer

The DVB original network ID for the stream (ONID)

transport_stream_id

integer

The DVB transport stream ID for the stream (TSID)

service_id

integer

The DVB series ID for the stream (SID)

Get the channels for a specific region

URL

https://api.icetv.com.au/regions/#/channels

Method

GET

Query String

hide_dvb_triplets=1

Exclude DVB Triplet information from response

Returns

200 OK & Document (XML or JSON)

 

404 Not Found

 

503 Service Unavailable

Request - URL
GET https://api.icetv.com.au/regions/1/channels?api_key=API_KEY&application_version=APPLICATION_VERSION
XML - Example of response
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE regions SYSTEM "http://iceguide.icetv.com.au/iceguide/regions.dtd">
<regions>
<region id="1" name="NSW - Sydney" city="Sydney" state="NSW" country="Australia" timezone="Australia/Sydney" />
<channel id="2" name="ABC1" name_short="ABC1" network_id="2" region_id="1" is_hd="0" lcns="2,21" region_name="NSW - Sydney" network_name="ABC" is_hidden="0" icon_src="abc1.gif" icon_width="0" icon_height="0">
<dvb original_network_id="4112" transport_stream_id="545" service_id="545" />
<dvb original_network_id="4112" transport_stream_id="545" service_id="547" />
</channel>
 
--- truncated ---
<channel id="1700" name="Eleven" name_short="Eleven" network_id="12" region_id="1" is_hd="0" lcns="11" region_name="NSW - Sydney" network_name="Ten" is_hidden="0" icon_src="eleven.png" icon_width="0" icon_height="0">
<dvb original_network_id="4116" transport_stream_id="1538" service_id="1576" />
</channel>
</regions>
JSON - Example of response
{
"regions": [
{
"id": 1,
"name": "NSW - Sydney",
"city": "Sydney",
"state": "NSW",
"country": "Australia",
"timezone": "Australia/Sydney"
}
],
"channels": [
{
"id": 2,
"name": "ABC1",
"name_short": "ABC1",
"network_id": 2,
"region_id": 1,
"is_hd": 0,
"lcns": "2,21",
"region_name": "NSW - Sydney",
"network_name": "ABC",
"is_hidden": 0,
"icon_src": "abc1.gif",
"icon_width": 0,
"icon_height": 0,
"dvb": [
{
"original_network_id": 4112,
"transport_stream_id": 545,
"service_id": 545
},
{
"original_network_id": 4112,
"transport_stream_id": 545,
"service_id": 547
}
]
},
 
--- truncated ---
{
"id": 1700,
"name": "Eleven",
"name_short": "Eleven",
"network_id": 12,
"region_id": 1,
"is_hd": 0,
"lcns": "11",
"region_name": "NSW - Sydney",
"network_name": "Ten",
"is_hidden": 0,
"icon_src": "eleven.png",
"icon_width": 0,
"icon_height": 0,
"dvb": [
{
"original_network_id": 4116,
"transport_stream_id": 1538,
"service_id": 1576
}
]
}
]
}

Get the channels for all regions

URL

https://api.icetv.com.au/regions/channels

Method

GET

Query String

hide_dvb_triplets=1

Exclude DVB Triplet information from response

Returns

200 OK & Document (XML or JSON)

 

404 Not Found

 

503 Service Unavailable

Request - URL
GET https://api.icetv.com.au/regions/channels?api_key=API_KEY&application_version=APPLICATION_VERSION
XML - Example of response
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE regions SYSTEM "http://iceguide.icetv.com.au/iceguide/regions.dtd">
<regions>
<region id="1" name="NSW - Sydney" city="Sydney" state="NSW" country="Australia" timezone="Australia/Sydney" />
 
--- truncated ---
<region id="49" name="QLD - Wide Bay" city="Wide Bay" state="QLD" country="Australia" timezone="Australia/Brisbane" />
<channel id="2" name="ABC1" name_short="ABC1" network_id="2" region_id="1" is_hd="0" lcns="2,21" region_name="NSW - Sydney" network_name="ABC" is_hidden="0" icon_src="abc1.gif" icon_width="0" icon_height="0">
<dvb original_network_id="4112" transport_stream_id="545" service_id="545" />
<dvb original_network_id="4112" transport_stream_id="545" service_id="547" />
</channel>
 
--- truncated ---
<channel id="2522" name="GEM" name_short="GEM" network_id="13" region_id="20" is_hd="1" lcns="80,90" region_name="NT - Regional NT" network_name="WIN" is_hidden="0" icon_src="gem.png" icon_width="0" icon_height="0" />
<channel id="2523" name="GO!" name_short="GO!" network_id="13" region_id="20" is_hd="0" lcns="88,99" region_name="NT - Regional NT" network_name="WIN" is_hidden="0" icon_src="go.png" icon_width="0" icon_height="0" />
</regions>
JSON - Example of response
{
"regions": [
{
"id": 1,
"name": "NSW - Sydney",
"city": "Sydney",
"state": "NSW",
"country": "Australia",
"timezone": "Australia/Sydney"
},
 
--- truncated ---
{
"id": 49,
"name": "QLD - Wide Bay",
"city": "Wide Bay",
"state": "QLD",
"country": "Australia",
"timezone": "Australia/Brisbane"
}
],
"channels": [
{
"id": 2,
"name": "ABC1",
"name_short": "ABC1",
"network_id": 2,
"region_id": 1,
"is_hd": 0,
"lcns": "2,21",
"region_name": "NSW - Sydney",
"network_name": "ABC",
"is_hidden": 0,
"icon_src": "abc1.gif",
"icon_width": 0,
"icon_height": 0,
"dvb": [
{
"original_network_id": 4112,
"transport_stream_id": 545,
"service_id": 545
},
{
"original_network_id": 4112,
"transport_stream_id": 545,
"service_id": 547
}
]
},
 
--- truncated ---
{
"id": 2523,
"name": "GO!",
"name_short": "GO!",
"network_id": 13,
"region_id": 20,
"is_hd": 0,
"lcns": "88,99",
"region_name": "NT - Regional NT",
"network_name": "WIN",
"is_hidden": 0,
"icon_src": "go.png",
"icon_width": 0,
"icon_height": 0
}
]
}