Gettng Started
Welcome to the otnet API! You can use our API to access otnet API endpoints, which can get information on various channels in our database.
Authentication
To authorize, use this code:
# With shell, you can just pass the correct header with each request
curl api_endpoint_here \
-H "X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0"
Make sure to replace
kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0
with your API key.
otnet uses API keys to allow access to the API. You can register a new otnet API key at our developer portal.
otnet expects for the API key to be included in all API requests to the server in a header that looks like the following:
X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0
Channels
Get Channel
curl https://otnet.io/v1/channels \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {
"id": 1,
"managing_editor": "Channel",
"atom_link": "",
"itunes_explicit": "no",
"itunes_category": "Music",
"itunes_owner_name": "",
"itunes_owner_email": "",
"author": "Channel",
"title": "Channel",
"subtitle": "",
"description": "",
"language": "en",
"link": "",
"copyright": "@Channel",
"created_date": "2019-09-29 16:01:39",
"timezone": "UTC",
"otnet": "draft",
"otnet_name": "",
"otnet_monthly_cost": 0.99,
"otnet_trial_period": 3600,
"otnet_show_popular": "no",
"otnet_show_people": "no",
"otnet_theme": "podcast",
"otnet_comments": "none",
"images": [],
"links": [
{
"href": "/v1/channels/1/images",
"rel": "images",
"type": "GET"
}
]
}
}
This endpoint retrieves all channels.
HTTP Request
GET https://otnet.io/v1/channels
Update Channel
curl https://otnet.io/v1/channels \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"data": {}
}
This endpoint retrieves all channels.
HTTP Request
GET https://otnet.io/v1/channels
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
title | string | Optional | Channel title |
language | string | Optional | The language the channel uses for all its information and descriptions. (e.g., “en”, “en-US”, “es”, etc.). ISO 639 alpha-2 or alpha-3 language code string. |
link | url | Optional | Link to your channel |
description | string | Optional | Channel description |
copyright | string | Optional | Channel copyright (used for mrss) |
timezone | timezone | Optional | Timezon for example Europe/Brussels |
managing_editor | string | Optional | managing_editor |
atom_link | url | Optional | Channel atom_link |
itunes_explicit | string | Optional | yes,no |
itunes_category | string | Optional | https://help.apple.com/itc/podcasts_connect/#/itc9267a2f12 |
itunes_owner_name | string | Optional | iTunes owner name |
itunes_owner_email | string | Optional | iTunes owner email |
itunes_subtitle | string | Optional | The content you specify in the itunes:subtitle tag appears in the Description column on the iTunes Store. |
Players
Get Players
curl https://otnet.io/v1/players \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
# GET a single player
curl https://otnet.io/v1/players?code=pol7jg \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 7,
"pages": 0
},
"data": [
{
"id": 1,
"code": "pylojh",
"type": "movie",
"title": "Aladdin",
"views": 9,
"seasons_id": 0,
"episode_number": 0,
"release_date": "2019-09-29 16:02:05",
"created_date": "2019-09-29 16:02:05",
"modified_date": "2019-09-29 16:39:47",
"short_description": "Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah.",
"long_description": "Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah. While visiting her exotic palace, Aladdin stumbles upon a magic oil lamp that unleashes a powerful, wisecracking, larger-than-life genie. As Aladdin and the genie start to become friends, they must soon embark on a dangerous mission to stop the evil sorcerer Jafar from overthrowing young Jasmines kingdom.",
"rating": "",
"rating_source": "",
"duration": 220,
"cost_per_stream": 0,
"status": "published",
"images": [
{
"id": 3,
"type": "poster",
"ref": "landscape",
"mime_type": "image/png",
"extension": "png",
"status": "published",
"created_date": "2019-09-29 16:14:37",
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454.png",
"src320x180": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-320x180.png",
"src480x270": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-480x270.png",
"src852x480": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-852x480.png",
"src1280x720": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-1280x720.png",
"src1920x1080": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-1920x1080.png",
"sizes": [
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-1920x1080.png",
"width": 1920,
"height": 1080,
"size": "s1920x1080"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-1280x720.png",
"width": 1280,
"height": 720,
"size": "s1280x720"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-852x480.png",
"width": 852,
"height": 480,
"size": "s852x480"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-480x270.png",
"width": 480,
"height": 270,
"size": "s480x270"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-320x180.png",
"width": 320,
"height": 180,
"size": "s320x180"
}
],
"links": [
{
"href": "/v1/players/pylojh/images?id=3",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/players/pylojh/images?ref=landscape",
"rel": "Self",
"type": "GET"
}
]
},
{
"id": 4,
"type": "poster",
"ref": "portrait",
"mime_type": "image/png",
"extension": "png",
"status": "published",
"created_date": "2019-09-29 16:15:22",
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806.png",
"src180x320": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-180x320.png",
"src270x480": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-270x480.png",
"src480x852": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-480x852.png",
"src720x1280": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-720x1280.png",
"src1080x1920": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-1080x1920.png",
"sizes": [
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-1080x1920.png",
"width": 1080,
"height": 1920,
"size": "s1080x1920"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-720x1280.png",
"width": 720,
"height": 1280,
"size": "s720x1280"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-480x852.png",
"width": 480,
"height": 852,
"size": "s480x852"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-270x480.png",
"width": 270,
"height": 480,
"size": "s270x480"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697737185d90d8969f5b83.50056806-180x320.png",
"width": 180,
"height": 320,
"size": "s180x320"
}
],
"links": [
{
"href": "/v1/players/pylojh/images?id=4",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/players/pylojh/images?ref=portrait",
"rel": "Self",
"type": "GET"
}
]
}
],
"persons": [],
"categories": [],
"playlists": [],
"genres": [
{
"id": 1,
"title": "action",
"status": "published",
"links": [
{
"href": "/v1/taxonomies/3/terms?id=1",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/players?terms_id=1",
"rel": "Term Players",
"type": "GET"
}
]
}
],
"tags": [],
"links": [
{
"href": "/v1/players?code=pylojh",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/players/pylojh/media",
"rel": "media",
"type": "GET"
},
{
"href": "/v1/players/pylojh/tracks",
"rel": "tracks",
"type": "GET"
},
{
"href": "/v1/players/pylojh/images",
"rel": "images",
"type": "GET"
},
{
"href": "/v1/players/pylojh/terms",
"rel": "terms",
"type": "GET"
},
{
"href": "/v1/players/pylojh/persons",
"rel": "persons",
"type": "GET"
}
]
}
]
}
This endpoint retrieves all players.
HTTP Request
GET https://otnet.io/v1/players
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
code | string | Optional | If set returns a single player |
type | string | Optional | Returns players of a certain type movie,series,episode,live,shortFormVideo,tvSpecial |
terms_id | integer | Optional | Returns players associated with a term |
seasons_id | integer | Optional | Returns players/episodes associated with a season |
episode_number | integer | Optional | Returns players associated with a episode |
status | string | Optional | published,future,draft,pending,private,trash |
page | integer | Optional | Use for pagination |
offset | integer | Optional | Use for pagination |
limit | integer | Optional | Limits your results |
order | integer | Optional | Order your results with asc,desc |
orderkey | integer | Optional | Order players based on the following keys created_date,parent_id |
search | integer | Optional | Returns players based on a search query |
Create Player
curl https://otnet.io/v1/players \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d title="Test title" \
-d type="movie" \
-d short_description="How to make bacon"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {}
}
This endpoint creates a new player.
HTTP Request
POST https://otnet.io/v1/players
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
seasons_id | integer | Optional | Season Id |
episode_number | integer | Optional | Episode Number |
type | string | Required | all,movie,series,episode,live,shortFormVideo,tvSpecial |
title | string | Required | Title |
short_description | string | Required | short_description |
long_description | string | Optional | long_description |
rating | string | Optional | 12,12A,14+,14A,15,18,18+,18A,A,AA,C,C8,E,G,NC17,PG,PG13,R,R18,TV14,TVG,TVMA,TVPG,TVY,TVY14,TVY7,U,Uc,UNRATED |
rating_source | string | Optional | BBFC,CHVRS,CPR,MPAA,UK_CP,USA_PR |
cost_per_stream | float | Optional | The cost of one stream |
advertisements | url | Optional | VAST adverts url |
google_ua_code | string | Optional | Google Ua Code |
duration | integer | Optional | Runtime in seconds. |
language | string | Optional | The language the channel uses for all its information and descriptions. (e.g., “en”, “en-US”, “es”, etc.). ISO 639 alpha-2 or alpha-3 language code string. |
ad_breaks | string | Optional | One or more time codes. Represents a time duration from the beginning of the video where an ad shows up. Conforms to the format: {hh}:{mm}:{ss}. |
back_button | string | Optional | on,off |
share_buttons | string | Optional | on,off |
skip_buttons | string | Optional | on,off |
autoplay | string | Optional | on,off |
playback_rates | string | Optional | on,off |
decryption | string | Optional | Hex code used to decrypt segments |
certificate_uri | url | Optional | Certificate url |
license_uri | url | Optional | license_uri url |
validity_period_start | string | Optional | The date when the content should become available in the ISO 8601 format: {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}+{TZ}. E.g.: 2015-11-11T22:21:37+00:00 |
validity_period_end | string | Optional | The date when the content is no longer available in the ISO 8601 format: {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}+{TZ}. E.g.: 2015-11-11T22:21:37+00:00 |
release_date | date | Optional | release_date |
status | string | Required | published,future,draft,pending,private,trash |
Update Player
curl https://otnet.io/v1/players \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d id=26 \
-d rating="18A"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {}
}
This endpoint updates an existing player.
HTTP Request
PUT https://otnet.io/v1/players
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | Player id to update |
seasons_id | integer | Optional | Season Id |
episode_number | integer | Optional | Episode Number |
type | string | Optional | all,movie,series,episode,live,shortFormVideo,tvSpecial |
title | string | Optional | Title |
short_description | string | Optional | short_description |
long_description | string | Optional | long_description |
rating | string | Optional | 12,12A,14+,14A,15,18,18+,18A,A,AA,C,C8,E,G,NC17,PG,PG13,R,R18,TV14,TVG,TVMA,TVPG,TVY,TVY14,TVY7,U,Uc,UNRATED |
rating_source | string | Optional | BBFC,CHVRS,CPR,MPAA,UK_CP,USA_PR |
cost_per_stream | float | Optional | The cost of one stream |
advertisements | url | Optional | VAST adverts url |
google_ua_code | string | Optional | Google Ua Code |
duration | integer | Optional | Runtime in seconds. |
language | string | Optional | The language the channel uses for all its information and descriptions. (e.g., “en”, “en-US”, “es”, etc.). ISO 639 alpha-2 or alpha-3 language code string. |
ad_breaks | string | Optional | One or more time codes. Represents a time duration from the beginning of the video where an ad shows up. Conforms to the format: {hh}:{mm}:{ss}. |
back_button | string | Optional | on,off |
share_buttons | string | Optional | on,off |
skip_buttons | string | Optional | on,off |
autoplay | string | Optional | on,off |
playback_rates | string | Optional | on,off |
decryption | string | Optional | Hex code used to decrypt segments |
certificate_uri | url | Optional | Certificate url |
license_uri | url | Optional | license_uri url |
validity_period_start | string | Optional | The date when the content should become available in the ISO 8601 format: {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}+{TZ}. E.g.: 2015-11-11T22:21:37+00:00 |
validity_period_end | string | Optional | The date when the content is no longer available in the ISO 8601 format: {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}+{TZ}. E.g.: 2015-11-11T22:21:37+00:00 |
release_date | date | Optional | release_date |
status | string | Required | published,future,draft,pending,private,trash |
Delete Player
curl https://otnet.io/v1/players \
-X DELETE -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d id=26
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC"
}
This endpoint deletes a specific player.
HTTP Request
DELETE https://otnet.io/v1/players
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the player to delete |
Players:Media
Get Player Media
curl https://otnet.io/v1/players/:code/media \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 1,
"pages": 0
},
"data": [
{
"id": 1,
"type": "video",
"ref": "default",
"region": "",
"language": "en",
"src": "https://player.vimeo.com/external/360804747.m3u8?s=25ec1f611c259742f31ef0cc2e84703901862e23",
"mime_type": "application/x-mpegURL",
"quality": "UHD",
"video_type": "HLS",
"extension": "m3u8",
"file_size": 0,
"duration": 0,
"bitrate": 0,
"fps": 0,
"cost_per_stream": 0,
"advertisements": "",
"google_ua_code": "",
"token": "8b474f4a4571b5842e4e2c7d2155a02cf76eb404b404ce4090223fd673b3164e",
"status": "published",
"created_date": "2019-09-29 16:02:05",
"links": [
{
"href": "/v1/players/pylojh/media?id=1",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/players/pylojh/media?ref=default",
"rel": "Self",
"type": "GET"
}
]
}
]
}
This endpoint retrieves player media.
HTTP Request
GET https://otnet.io/v1/players/:code/media
URL Parameters
Parameter | Type | Required | Description |
---|---|---|---|
code | string | Required | Player code to update (must be added to url) |
id | integer | Optional | Returns a single media |
ref | string | Optional | Returns a piece of media based on its reference key |
page | integer | Optional | Use for pagination |
offset | integer | Optional | Use for pagination |
limit | integer | Optional | Limits your results |
order | integer | Optional | Order your results with asc,desc |
orderkey | integer | Optional | Order players based on the following keys created_date,parent_id |
search | integer | Optional | Returns players based on a search query |
Create Player Media
curl https://otnet.io/v1/players \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d src="https://media.com/test.mp4" \
-d ref="roku"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {}
}
This endpoint creates player media.
HTTP Request
POST https://otnet.io/v1/players/:code/media
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
src | url | Required | Valid url to your media |
ref | string | Required | A unique reference word to utilize your media |
duration | integer | Optional | Runtime in seconds. |
cost_per_stream | float | Optional | Amount one full stream will cost |
advertisements | url | Optional | VAST advertising url |
google_ua_code | string | Optional | Google Ua Code |
status | string | Required | published,future,draft,pending,private,trash |
Update Player Media
curl https://otnet.io/v1/players/:code/media \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d ref="portrait"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {}
}
This endpoint updates player media.
HTTP Request
PUT https://otnet.io/v1/players/:code/media
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | Media to update |
src | url | Optional | Valid url to your media |
ref | string | Optional | A unique reference word to utilize your media |
duration | integer | Optional | Runtime in seconds. |
cost_per_stream | float | Optional | Amount one full stream will cost |
advertisements | url | Optional | VAST advertising url |
google_ua_code | string | Optional | Google Ua Code |
status | string | Optional | published,future,draft,pending,private,trash |
Players:Tracks
Get Player Tracks
curl https://otnet.io/v1/players/:code/tracks \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 1,
"pages": 0
},
"data": [
{
"id": 1,
"type": "text",
"ref": "default",
"region": "",
"src": "https://dxeerwurlpsta.cloudfront.net/timed.vtt",
"mime_type": "text/vtt",
"kind": "captions",
"label": "English",
"language": "en",
"extension": "vtt",
"status": "published",
"created_date": "2019-09-29 16:02:06",
"links": [
{
"href": "/v1/players/pylojh/tracks?id=1",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/players/pylojh/tracks?ref=default",
"rel": "Self",
"type": "GET"
}
]
}
]
}
This endpoint retrieves player tracks.
HTTP Request
GET https://otnet.io/v1/players/:code/tracks
URL Parameters
Parameter | Type | Required | Description |
---|---|---|---|
code | string | Required | Player code to update (must be added to url) |
id | integer | Optional | Returns a single caption |
ref | string | Optional | Returns a piece of caption based on its reference key |
page | integer | Optional | Use for pagination |
offset | integer | Optional | Use for pagination |
limit | integer | Optional | Limits your results |
order | integer | Optional | Order your results with asc,desc |
orderkey | integer | Optional | Order players based on the following keys created_date,parent_id |
search | integer | Optional | Returns players based on a search query |
Create Player Tracks
curl https://otnet.io/v1/players/:code/tracks \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d src="https://media.com/test.vtt" \
-d ref="roku",
-d language="en"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {}
}
This endpoint creates player tracks.
HTTP Request
POST https://otnet.io/v1/players/:code/tracks
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
src | url | Required | Valid url to your media srt,vtt |
ref | string | Required | A unique reference word to utilize your media |
language | string | Required | A language code for the subtitle (e.g., “en”, “es-mx”, “fr”, etc). ISO 639-2 or alpha-3 language code string. |
status | string | Required | published,future,draft,pending,private,trash |
Update Player Tracks
curl https://otnet.io/v1/players/:code/tracks \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d ref="portrait"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {}
}
This endpoint updates player captions.
HTTP Request
PUT https://otnet.io/v1/players/:code/captions
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | Caption to update |
src | url | Optional | Valid url to your media srt,vtt |
ref | string | Optional | A unique reference word to utilize your media |
language | string | Optional | A language code for the subtitle (e.g., “en”, “es-mx”, “fr”, etc). ISO 639-2 or alpha-3 language code string. |
status | string | Optional | published,future,draft,pending,private,trash |
Players:Terms
Get Player Terms
curl https://otnet.io/v1/players/:code/terms \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": [
{
"id": 2,
"title": "Thillers",
"parent_id": 0,
"is_home": 0,
"status": "published",
"created_date": "2019-03-18 19:23:52",
"links": [
{
"href": "/v1/players/pokrwb/terms?id=2",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/players?termsId=2",
"rel": "Players",
"type": "GET"
}
]
},
{
"id": 1,
"title": "Action",
"parent_id": 0,
"is_home": 0,
"status": "published",
"created_date": "2019-03-18 18:36:33",
"links": [
{
"href": "/v1/players/pokrwb/terms?id=1",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/players?termsId=1",
"rel": "Players",
"type": "GET"
}
]
}
],
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 2,
"pages": 0
}
}
This endpoint retrieves a players associated terms.
HTTP Request
GET https://otnet.io/v1/players/:code/terms
URL Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Optional | Returns a single term |
Create Player Terms
curl https://otnet.io/v1/players/:code/terms \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d terms_id=12
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {
"id": 5,
"code": "pokrwb",
"terms_id": 2
}
}
This endpoint creates player term associations.
HTTP Request
POST https://otnet.io/v1/players/:code/terms
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
terms_id | integer | Required | The term id you would like to associate this player with |
Update Player Terms
curl https://otnet.io/v1/players/:code/terms \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d terms_id=2
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {
"id": 1,
"code": "pokrwb",
"terms_id": 1
}
}
This endpoint updates player term associations.
HTTP Request
PUT https://otnet.io/v1/players/:code/terms
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | Term association to update |
terms_id | integer | Required | The term id you would like to associate this player with |
Players:Images
Get Player Images
curl https://otnet.io/v1/players/:code/images \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 1,
"pages": 0
},
"data": [
{
"id": 1,
"type": "poster",
"ref": "landscape",
"mimeType": "image/jpeg",
"extension": "jpg",
"status": "published",
"created_date": "2019-07-31 12:33:04",
"src": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934.jpg",
"src320x180": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-320x180.jpg",
"src480x270": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-480x270.jpg",
"src852x480": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-852x480.jpg",
"src1280x720": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-1280x720.jpg",
"src1920x1080": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-1920x1080.jpg",
"sizes": [
{
"src": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-1920x1080.jpg",
"width": 1920,
"height": 1080,
"size": "s1920x1080"
},
{
"src": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-1280x720.jpg",
"width": 1280,
"height": 720,
"size": "s1280x720"
},
{
"src": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-852x480.jpg",
"width": 852,
"height": 480,
"size": "s852x480"
},
{
"src": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-480x270.jpg",
"width": 480,
"height": 270,
"size": "s480x270"
},
{
"src": "https://00000000000.cloudfront.net/images/orignal-15645727805d417c6c6b43e2.40804934-320x180.jpg",
"width": 320,
"height": 180,
"size": "s320x180"
}
],
"links": [
{
"href": "/v1/players/pvi5uy/images?id=1",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/players/pvi5uy/images?ref=landscape",
"rel": "Self",
"type": "GET"
}
]
}
]
}
This endpoint retrieves players images.
HTTP Request
GET https://otnet.io/v1/players/:code/images
URL Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Optional | Get a single imagea |
Create Player Images
curl https://otnet.io/v1/players/:code/terms \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d src="https://example.com/image.png" \
-d ref="landscape"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {
"id": 7,
"code": "pokrwb",
"ref": "beats",
"src": "https://media.com/test.png",
"type": "image/png",
"extension": "png",
"sizes": "",
"status": "published"
}
}
This endpoint creates player images.
HTTP Request
POST https://otnet.io/v1/players/:code/images
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
src | url | Required | gif,jpg,jpeg,png |
ref | string | Required | A unique word that references your image |
sizes | serialized | Optional | Sizes of your images |
status | string | Required | published,future,draft,pending,private,trash |
Update Player Images
curl https://otnet.io/v1/players/:code/images \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d ref="portrait"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {
"id": 8,
"code": "pokrwb",
"ref": "new",
"src": "https://media.com/test.png",
"type": "image/png",
"extension": "png",
"sizes": "",
"status": "published"
}
}
This endpoint updates player images.
HTTP Request
PUT https://otnet.io/v1/players/:code/images
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | Caption to update |
src | url | Required | gif,jpg,jpeg,png |
ref | string | Required | A unique word that references your image |
sizes | serialized | Optional | Sizes of your images |
status | string | Required | published,future,draft,pending,private,trash |
Taxonomies
Get Taxonomies
curl https://otnet.io/v1/taxonomies \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 4,
"pages": 0
},
"data": [
{
"id": 1,
"title": "categories",
"roku": "categories",
"status": "published",
"created_date": "2019-03-18 18:31:26",
"links": [
{
"href": "/v1/taxonomies?id=1",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/taxonomies/1/terms",
"rel": "Terms",
"type": "GET"
}
]
},
{
"id": 2,
"title": "playlists",
"roku": "playlists",
"status": "published",
"created_date": "2019-03-18 18:31:26",
"links": [
{
"href": "/v1/taxonomies?id=2",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/taxonomies/2/terms",
"rel": "Terms",
"type": "GET"
}
]
},
{
"id": 3,
"title": "genres",
"roku": "genres",
"status": "published",
"created_date": "2019-03-18 18:31:26",
"links": [
{
"href": "/v1/taxonomies?id=3",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/taxonomies/3/terms",
"rel": "Terms",
"type": "GET"
}
]
},
{
"id": 4,
"title": "tags",
"roku": "tags",
"status": "published",
"created_date": "2019-03-18 18:31:26",
"links": [
{
"href": "/v1/taxonomies?id=4",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/taxonomies/4/terms",
"rel": "Terms",
"type": "GET"
}
]
}
]
}
This endpoint retrieves all taxonomies.
HTTP Request
GET https://otnet.io/v1/taxonomies
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Optional | Returns a single taxonomy |
list | string | Optional | Returns the taxonomies and terms with children in list |
Create Taxonomy
curl https://otnet.io/v1/taxonomies \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d title="Genres"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {
"id": 6,
"title": "Video Tutorials",
"roku": "",
"status": "published",
"created_date": "2019-03-19 19:45:28"
}
}
This endpoint creates taxonomies.
HTTP Request
POST https://otnet.io/v1/taxonomies
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
title | string | Required | name |
roku | string | Optional | Used to reference Roku |
status | string | Required | published,future,draft,pending,private,trash |
Update Taxonomy
curl https://otnet.io/v1/taxonomies \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d id=2 \
-d status="draft"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": {
"id": 6,
"title": "Videos",
"roku": "",
"status": "published",
"created_date": "2019-03-19 19:45:28"
}
}
This endpoint updates taxonomies.
HTTP Request
PUT https://otnet.io/v1/taxonomies
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | taxonomy to update |
title | string | Required | name |
roku | string | Optional | Used to reference Roku |
status | string | Required | published,future,draft,pending,private,trash |
Taxonomies:Terms
Get Taxonomy Terms
curl https://otnet.io/v1/taxonomies/:id/terms \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "Europe/London",
"data": [
{
"id": "1",
"name": "action",
"status": "published",
"created_date": "2019-02-20 17:13:46",
"links": [
{
"href": "/v1/terms/1/players",
"rel": "self",
"type": "GET"
}
]
}
],
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 1,
"pages": 0
}
}
This endpoint retrieves all taxonomy terms.
HTTP Request
GET https://otnet.io/v1/taxonomies/:id/terms
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
terms_id | integer | Required | Returns taxonomy terms |
Create Taxonomy Term
curl https://otnet.io/v1/taxonomies/:id/terms \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d tax_id=1 \
-d title="Thrillers"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "Europe/London",
"data": {}
}
This endpoint creates taxonomy terms.
HTTP Request
POST https://otnet.io/v1/taxonomies/:id/terms
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
tax_id | integer | Required | tax_id |
title | string | Required | title |
parent_id | integer | Optional | parent_id |
is_home | integer | Optional | is_home |
status | string | Required | published,future,draft,pending,private,trash |
Update Taxonomy Term
curl https://otnet.io/v1/taxonomies/:id/terms \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d id=2 \
-d status="draft"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "Europe\/London",
"data": {}
}
This endpoint updates taxonomy terms.
HTTP Request
PUT https://otnet.io/v1/taxonomies/:id/terms
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | id |
tax_id | integer | Optional | tax_id |
title | string | Optional | title |
parent_id | integer | Optional | parent_id |
is_home | integer | Optional | is_home |
status | string | Required | published,future,draft,pending,private,trash |
Taxonomies:Terms:Images
Get Terms Images
curl https://otnet.io/v1/taxonomies/:id/terms/:id/images \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"data": [
{
"id": 2,
"type": "poster",
"ref": "square",
"mime_type": "image/png",
"extension": "png",
"status": "published",
"created_date": "2019-09-29 16:11:47",
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566.png",
"src100x100": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-100x100.png",
"src200x200": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-200x200.png",
"src400x400": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-400x400.png",
"src800x800": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-800x800.png",
"sizes": [
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-800x800.png",
"width": 800,
"height": 800,
"size": "s800x800"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-400x400.png",
"width": 400,
"height": 400,
"size": "s400x400"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-200x200.png",
"width": 200,
"height": 200,
"size": "s200x200"
},
{
"src": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697735065d90d7c2135165.89712566-100x100.png",
"width": 100,
"height": 100,
"size": "s100x100"
}
],
"links": [
{
"href": "/v1/terms/1/images?id=2",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/terms/1/images?ref=square",
"rel": "Self",
"type": "GET"
}
]
}
]
}
This endpoint retrieves a term images.
HTTP Request
GET https://otnet.io/v1/taxonomies/:id/terms/:id/images
URL Parameters
Parameter | Description |
---|---|
code | The code of the player content to retrieve |
Create Terms Images
curl https://otnet.io/v1/taxonomies/:id/terms/:id/images \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d src="https://example.com/images.png" \
-d ref="landscape"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "Europe\/London",
"data": {}
}
This endpoint creates terms images
HTTP Request
POST https://otnet.io/v1/taxonomies/:id/terms/:id/images
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
src | url | Required | gif,jpg,jpeg,png |
ref | string | Required | A unique word that references your image |
sizes | serialized | Optional | Sizes of your images |
status | string | Required | published,future,draft,pending,private,trash |
Update Terms Images
curl https://otnet.io/v1/taxonomies/:id/terms/:id/images \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d id=2 \
-d ref="portrait"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "Europe\/London",
"data": {}
}
This endpoint updates terms images
HTTP Request
PUT https://otnet.io/v1/players/:code/content/captions
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | Image to update |
src | url | Required | gif,jpg,jpeg,png |
ref | string | Required | A unique word that references your image |
sizes | serialized | Optional | Sizes of your images |
status | string | Required | published,future,draft,pending,private,trash |
Persons
Get Persons
curl https://otnet.io/v1/persons \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 1,
"pages": 0
},
"data": [
{
"id": 1,
"title": "Will Smith",
"short_description": "Willard Carroll Smith Jr. is an American actor, rapper and media personality. In April 2007, Newsweek called him \"the most powerful actor in Hollywood\". ",
"long_description": "Willard Carroll Smith Jr. is an American actor, rapper and media personality. In April 2007, Newsweek called him \"the most powerful actor in Hollywood\". ",
"role": "actor",
"status": "published",
"birth_date": "2019-09-02 17:57:10",
"created_date": "2019-09-29 16:57:38",
"images": [],
"link": [
{
"href": "/v1/persons?id=1",
"rel": "self",
"type": "GET"
},
{
"href": "/v1/persons/1/images",
"rel": "connections",
"type": "GET"
}
]
}
]
}
This endpoint retrieves all persons.
HTTP Request
GET https://otnet.io/v1/persons
Query Parameters
Parameter | Default | Description |
---|---|---|
include_cats | false | If set to true, the result will also include cats. |
available | true | If set to false, the result will include persons that have already been adopted. |
Delete Person
curl "https://otnet.io/v1/persons/2"
-X DELETE
-H "X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0vvv"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC"
}
This endpoint deletes a specific person.
HTTP Request
DELETE https://otnet.io/v1/persons
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the person to delete |
Persons:Images
Get Persons Images
curl https://otnet.io/v1/persons/:id/images \
-H 'X-API-KEY: kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0'
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "UTC",
"meta": {
"page": 1,
"offset": 0,
"perpage": 100,
"total": 1,
"pages": 0
},
"data": [
{
"id": 13,
"type": "poster",
"ref": "square",
"mime_type": "image/jpeg",
"extension": "jpg",
"status": "published",
"created_date": "2019-09-29 17:02:30",
"src": "https://www.biography.com/.image/t_share/MTE4MDAzNDEwNzQzMTY2NDc4/will-smith-9542165-1-402.jpg",
"links": [
{
"href": "/v1/persons/1/images?id=13",
"rel": "Self",
"type": "GET"
},
{
"href": "/v1/persons/1/images?ref=square",
"rel": "Self",
"type": "GET"
}
]
}
]
}
This endpoint retrieves person images.
HTTP Request
GET https://otnet.io/v1/persons/:id/images
URL Parameters
Parameter | Description |
---|---|
code | The code of the player content to retrieve |
Create Persons Images
curl https://otnet.io/v1/persons/:id/images \
-X POST -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d src="https://example.com/images.png" \
-d ref="landscape"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "Europe\/London",
"data": {}
}
This endpoint creates a new player content block.
HTTP Request
POST https://otnet.io/v1/persons/:id/images
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
src | url | Required | gif,jpg,jpeg,png |
ref | string | Required | A unique word that references your image |
sizes | serialized | Optional | Sizes of your images |
status | string | Required | published,future,draft,pending,private,trash |
Update Persons Images
curl https://otnet.io/v1/persons/:id/images \
-X PUT -H 'X-API-KEY: 888g8ww8cg0g4c0csgg0g0w8w8w0s4co4wgkkk4g' \
-d id=2 \
-d ref="portrait"
The above command returns JSON structured like this:
{
"status": true,
"message": "Success",
"timezone": "Europe\/London",
"data": {}
}
This endpoint creates a new player content block.
HTTP Request
PUT https://otnet.io/v1/persons/:id/images
ARGUMENTS
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Required | Image to update |
src | url | Required | gif,jpg,jpeg,png |
ref | string | Required | A unique word that references your image |
sizes | serialized | Optional | Sizes of your images |
status | string | Required | published,future,draft,pending,private,trash |
Feeds
Get Roku Feed
curl https://otnet.io/v1/feeds/roku?X-API-KEY=kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0
The above command returns JSON structured like this:
{
"status": true,
"providerName": "Channel",
"lastUpdated": "2019-09-29T17:03:23+00:00",
"language": "en",
"categories": [],
"playlists": [],
"movies": [{
"id": "1",
"title": "Aladdin",
"content": {
"dateAdded": "2019-09-29T16:02:05+0000",
"videos": [{
"url": "https://player.vimeo.com/external/360804747.m3u8?s=25ec1f611c259742f31ef0cc2e84703901862e23",
"quality": "UHD",
"videoType": "HLS"
}],
"captions": [{
"url": "https://dxeerwurlpsta.cloudfront.net/timed.vtt",
"language": "en",
"captionType": "CLOSED_CAPTION"
}],
"duration": 220,
"trickPlayFiles": [{
"url": "https://dxeerwurlpsta.cloudfront.net/timed.bif",
"quality": "HD"
}],
"language": "en",
"validityPeriodStart": "2019-09-29T16:02:05+0000",
"validityPeriodEnd": "2019-09-29T16:02:05+0000",
"adBreaks": ""
},
"genres": [
"action"
],
"thumbnail": "https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-852x480.png",
"releaseDate": "2019-09-29T16:02:05+0000",
"shortDescription": "Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah.",
"longDescription": "Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah. While visiting her exotic palace, Aladdin stumbles upon a magic oil lamp that unleashes a powerful, wisecracking, larger-than-life genie. As Aladdin and the genie start to become friends, they must soon embark on a dangerous mission to stop the evil sorcerer Jafar from overthrowing young Jasmines kingdom.",
"tags": [
"action"
],
"rating": [{
"rating": "",
"ratingSource": ""
}],
"credits": []
}],
"series": [{
"id": "7",
"title": "Series",
"genres": [
"action"
],
"thumbnail": "https://images.pexels.com/photos/2706872/pexels-photo-2706872.jpeg",
"releaseDate": "2019-09-29T16:21:17+0000",
"shortDescription": "Series",
"longDescription": "",
"tags": [
"action"
],
"rating": [{
"rating": "12",
"ratingSource": "BBFC"
}],
"credits": [],
"seasons": [{
"seasonNumber": 1,
"episodes": []
}]
}],
"shortFormVideos": [],
"tvSpecials": []
}
This endpoint retrieves a feed.
HTTP Request
GET https://otnet.io/v1/feeds/roku?X-API-KEY=kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0
Query Parameters
Parameter | Default | Description |
---|---|---|
ref | string | return only media with the set ref for instance if your media has a ref set to itunes append this to the url will only return itunes media https://otnet.io/v1/feeds/roku?X-API-KEY=kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0&ref=itunes |
Get Mrss Feed
curl https://otnet.io/v1/feeds/mrss?X-API-KEY=kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0
The above command returns JSON structured like this:
<?xml version="1.0"?>
<rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:media="http://search.yahoo.com/mrss/" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:creativeCommons="http://backend.userland.com/creativeCommonsRssModule" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:sy="http://purl.org/rss/1.0/modules/syndication/" version="2.0">
<channel>
<title>Channel</title>
<link/>
<generator>otnet</generator>
<docs>https://otnet.io</docs>
<language>en</language>
<copyright>@Channel</copyright>
<managingEditor>Channel</managingEditor>
<lastBuildDate>Sun, 29 Sep 2019 17:07:22 +0000</lastBuildDate>
<pubDate>Sun, 29 Sep 2019 16:01:39 +0000</pubDate>
<itunes:author>Channel</itunes:author>
<itunes:subtitle/>
<itunes:summary/>
<description><![CDATA[]]></description>
<itunes:explicit>no</itunes:explicit>
<itunes:owner>
<itunes:name/>
<itunes:email/>
</itunes:owner>
<itunes:category text="Music"/>
<image>
<title>Channel</title>
<link/>
<url>https://specials-images.forbesimg.com/imageserve/5b4501254bbe6f1becf1e1a5/416x416.jpg</url>
<width>200</width>
<height>200</height>
</image>
<itunes:image href="https://specials-images.forbesimg.com/imageserve/5b4501254bbe6f1becf1e1a5/416x416.jpg"/>
<item>
<title>Aladdin</title>
<itunes:author>Channel</itunes:author>
<itunes:subtitle>Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah.</itunes:subtitle>
<itunes:summary>Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah. While visiting her exotic palace, Aladdin stumbles upon a magic oil lamp that unleashes a powerful, wisecracking, larger-than-life genie. As Aladdin and the genie start to become friends, they must soon embark on a dangerous mission to stop the evil sorcerer Jafar from overthrowing young Jasmines kingdom.</itunes:summary>
<itunes:image href="https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-852x480.png"/>
<enclosure url="https://player.vimeo.com/external/360804747.m3u8?s=25ec1f611c259742f31ef0cc2e84703901862e23" type="application/x-mpegURL"/>
<pubDate>Sun, 29 Sep 2019 16:02:05 +0000</pubDate>
<category>All</category>
<description><![CDATA[Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah. While visiting her exotic palace, Aladdin stumbles upon a magic oil lamp that unleashes a powerful, wisecracking, larger-than-life genie. As Aladdin and the genie start to become friends, they must soon embark on a dangerous mission to stop the evil sorcerer Jafar from overthrowing young Jasmines kingdom.]]></description>
<content:encoded><![CDATA[Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah. While visiting her exotic palace, Aladdin stumbles upon a magic oil lamp that unleashes a powerful, wisecracking, larger-than-life genie. As Aladdin and the genie start to become friends, they must soon embark on a dangerous mission to stop the evil sorcerer Jafar from overthrowing young Jasmines kingdom.]]></content:encoded>
<link/>
<guid isPermaLink="false"/>
<itunes:duration>0</itunes:duration>
<media:content url="https://player.vimeo.com/external/360804747.m3u8?s=25ec1f611c259742f31ef0cc2e84703901862e23" language="en-us" duration="0.0" type="application/x-mpegURL" fileSize="0" medium="video">
<media:title type="plain">Aladdin</media:title>
<media:description type="plain">Aladdin is a lovable street urchin who meets Princess Jasmine, the beautiful daughter of the sultan of Agrabah.</media:description>
<media:thumbnail url="https://dwpurpmwfzvap.cloudfront.net/images/orignal-15697736745d90d86a6bc063.89367454-852x480.png" width="400" height="225"/>
<media:copyright url="https://creativecommons.org/licenses/by/4.0/"/>
<media:credit role="author" scheme="urn:ebu">Channel</media:credit>
</media:content>
</item>
</channel>
</rss>
This endpoint retrieves a feed.
HTTP Request
GET https://otnet.io/v1/feeds/mrss?X-API-KEY=kg4gwk0gw4cskckc4oc8gw480c0g4sk0occo0cg0
Query Parameters
Parameter | Default | Description |
---|---|---|
ref | string | return only media with the set ref for instance if your media has a ref set to itunes append this to the url will only return itunes media |
save | bool | true,false append save=true to your url to download your xml file to your computer |
Errors
The otnet API uses the following error codes:
Error Code | Meaning |
---|---|
400 | Bad Request -- Your request is invalid. |
401 | Unauthorized -- Your API key is wrong. |
403 | Forbidden -- The resource requested is hidden for administrators only. |
404 | Not Found -- The specified resource could not be found. |
405 | Method Not Allowed -- You tried to access a resource with an invalid method. |
406 | Not Acceptable -- You requested a format that isn't json. |
410 | Gone -- The resource requested has been removed from our servers. |
429 | Too Many Requests -- You're requesting too many resources! Slow down! |
500 | Internal Server Error -- We had a problem with our server. Try again later. |
503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |