Search

The response from an API search. A search result contains information about the video Episodes or Series that match the search parameters specified in the Search API request. The Wurl API supports both Episode search and Series search.

Search results are ordered based on a combination of their relevance and ChannelsRank (Wurl’s assessment of the quality of each Series or Episode).

For more information about how 'Episodes' and 'Series' are used in the Wurl Index, see the Wurl Index Hierarchy.

Request URL

Request Parameters

Param Description
q Required. One or more words to search for. When more than one keyword is specified, use '+' between each keyword.
type Required. Which type of entity to search for - 'series' or 'episode'.
size How many records to include in the result. Max size is curently set to 100.
start How many hits to skip from the beginning of the search result.
To search Series:
https://api.wurl.com/api/search?q=KEYWORDS&type=series&format=json&access_token=TOKEN
To search Episodes:
https://api.wurl.com/api/search?q=KEYWORDS&type=episode&format=json&access_token=TOKEN
To search with multiple keywords:
https://api.wurl.com/api/search?q=soccer+ronaldo&type=series&access_token=TOKEN

Properties in the API Response

Name Type Description
hits number The total number of results found. For Series search, the total number of Series matching the keyword(s). For Episode search, the total number of Episodes matching the keyword(s).
searchTerms string The keyword(s) that are the subject of this search request.

Entities in the API Response

The API response for “Search” contains an array of Entities – one for each search result. For a description of the individual elements in Episode search results, see Episode Entity. For a description of the individual elements in Series search results, see Series Entity.

Name Class Description
Series series,wurl-series The response to the Series API request contains the representation of a video Series in the Wurl Index. In the Wurl Index, each Series contains a set of Episodes. The 'Series’ publisher determines the selection and order of the Episodes in a Series.

Links in the API Response

Name Description
self The canonical or preferred url to a resource.
next The url to the next set of items.
previous The url to the previous set of items.

Sample API Response

{
  "rel": [
    "properties:http://api.wurl.com/schemas/search_response.json"
  ],
  "class": [
    "search"
  ],
  "properties": {
    "searchTerms": "soccer ronaldo",
    "hits": 5,
    "start": 0
  },
  "entities": [
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 400303,
        "description": "YouTube-Football-Channel. Der größte YouTube Fussball-Kanal mit Tutorials, Freistößen, Übungen, Tests, Reviews & Battles.\nHier gibt es wöchentlich neue Videos rund ums Thema Fussball. \nAußerdem die \"TOP 5 Goals of the WEEK\" bei der DU als Zuschauer mitmachen kannst - schicke uns deine besten Tore an diese Email-Adresse: freekickerz.fans[at]googlemail.com\n\nFür geschäftliche Anfragen | Business Inquiries: business[at]teamfk.de\nFür Fananfragen | Fan-Mail: fans[at]teamfk.de",
        "channelsRank": 82.1571750375892,
        "pubDate": "2013-09-27T01:14:07Z",
        "title": "freekickerz",
        "thumbnails": {
          "default": {
            "url": "http://lh4.googleusercontent.com/-1DXRJdsENFI/AAAAAAAAAAI/AAAAAAAAAAA/bv7F7GFrr60/s88-c-k/photo.jpg"
          }
        },
        "totalEpisodes": 65,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCC9h3H-sGrvqd2otknZntsQ/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/400303/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400303
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400303
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/400303"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 395203,
        "description": "The official home of Nike Football on YouTube.",
        "channelsRank": 80.7478749999664,
        "pubDate": "2013-09-26T15:29:30Z",
        "title": "nikefootball",
        "thumbnails": {
          "default": {
            "url": "http://lh3.googleusercontent.com/-zFjX98Klq-4/AAAAAAAAAAI/AAAAAAAAAAA/EuN_geMN-c8/s88-c-k/photo.jpg"
          }
        },
        "totalEpisodes": 137,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCNhxq7He5p-_FdBh0OaxcQg/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/395203/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395203
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395203
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/395203"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 400305,
        "description": "Billy Wingrove & Jeremy Lynch are The F2. A brand new concept of Football Freestyle double act. They present to you entertainment at the highest standard. Please subscribe, sit back and enjoy...",
        "channelsRank": 79.3963086546922,
        "pubDate": "2013-09-27T07:32:40Z",
        "title": "F2Freestylers",
        "thumbnails": {
          "default": {
            "url": "http://i1.ytimg.com/i/Kvn9VBLAiLiYL4FFJHri6g/1.jpg?v=501aabfe"
          }
        },
        "totalEpisodes": 56,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCKvn9VBLAiLiYL4FFJHri6g/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/400305/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400305
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400305
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/400305"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 395206,
        "description": "The official home of Nike Soccer on YouTube.\n\nFor more, visit NIKESOCCER.com.",
        "channelsRank": 57.5147933855647,
        "pubDate": "2013-06-07T13:49:48Z",
        "title": "nikesoccer",
        "thumbnails": {
          "default": {
            "url": "http://i1.ytimg.com/i/45H39UhBIJNlHK1JTo7vMg/1.jpg?v=5238a9e6"
          }
        },
        "totalEpisodes": 64,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UC45H39UhBIJNlHK1JTo7vMg/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/395206/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395206
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395206
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/395206"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 400304,
        "description": "SUBSCRIBE to No1 Football tutorial Channel on YouTube. Learn new techniques and skills. BEST WAY TO TALK TO ME",
        "channelsRank": 18.7295221802339,
        "pubDate": "2005-10-16T05:59:26Z",
        "title": "str",
        "thumbnails": {
          "default": {
            "url": "http://i1.ytimg.com/i/OdgoVab4B5L5s2GhQRSdqw/1.jpg?v=4fc532bd"
          }
        },
        "totalEpisodes": 1,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCOdgoVab4B5L5s2GhQRSdqw/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/400304/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400304
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400304
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/400304"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/search?q=soccer ronaldo"
    }
  ]
}

Search

The response from an API search. A search result contains information about the video Episodes or Series that match the search parameters specified in the Search API request. The Wurl API supports both Episode search and Series search.

Search results are ordered based on a combination of their relevance and ChannelsRank (Wurl’s assessment of the quality of each Series or Episode).

For more information about how 'Episodes' and 'Series' are used in the Wurl Index, see the Wurl Index Hierarchy.

Request URL

Request Parameters

Param Description
q Required. One or more words to search for. When more than one keyword is specified, use '+' between each keyword.
type Required. Which type of entity to search for - 'series' or 'episode'.
size How many records to include in the result. Max size is curently set to 100.
start How many hits to skip from the beginning of the search result.
To search Series:
https://api.wurl.com/api/search?q=KEYWORDS&type=series&format=json&access_token=TOKEN
To search Episodes:
https://api.wurl.com/api/search?q=KEYWORDS&type=episode&format=json&access_token=TOKEN
To search with multiple keywords:
https://api.wurl.com/api/search?q=soccer+ronaldo&type=series&access_token=TOKEN

Properties in the API Response

Name Type Description
hits number The total number of results found. For Series search, the total number of Series matching the keyword(s). For Episode search, the total number of Episodes matching the keyword(s).
searchTerms string The keyword(s) that are the subject of this search request.

Entities in the API Response

The API response for “Search” contains an array of Entities – one for each search result. For a description of the individual elements in Episode search results, see Episode Entity. For a description of the individual elements in Series search results, see Series Entity.

Name Class Description
Series series,wurl-series The response to the Series API request contains the representation of a video Series in the Wurl Index. In the Wurl Index, each Series contains a set of Episodes. The 'Series’ publisher determines the selection and order of the Episodes in a Series.

Links in the API Response

Name Description
self The canonical or preferred url to a resource.
next The url to the next set of items.
previous The url to the previous set of items.

Sample API Response

{
  "rel": [
    "properties:http://api.wurl.com/schemas/search_response.json"
  ],
  "class": [
    "search"
  ],
  "properties": {
    "searchTerms": "soccer ronaldo",
    "hits": 5,
    "start": 0
  },
  "entities": [
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 400303,
        "description": "YouTube-Football-Channel. Der größte YouTube Fussball-Kanal mit Tutorials, Freistößen, Übungen, Tests, Reviews & Battles.\nHier gibt es wöchentlich neue Videos rund ums Thema Fussball. \nAußerdem die \"TOP 5 Goals of the WEEK\" bei der DU als Zuschauer mitmachen kannst - schicke uns deine besten Tore an diese Email-Adresse: freekickerz.fans[at]googlemail.com\n\nFür geschäftliche Anfragen | Business Inquiries: business[at]teamfk.de\nFür Fananfragen | Fan-Mail: fans[at]teamfk.de",
        "channelsRank": 82.1571750375892,
        "pubDate": "2013-09-27T01:14:07Z",
        "title": "freekickerz",
        "thumbnails": {
          "default": {
            "url": "http://lh4.googleusercontent.com/-1DXRJdsENFI/AAAAAAAAAAI/AAAAAAAAAAA/bv7F7GFrr60/s88-c-k/photo.jpg"
          }
        },
        "totalEpisodes": 65,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCC9h3H-sGrvqd2otknZntsQ/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/400303/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400303
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400303
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/400303"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 395203,
        "description": "The official home of Nike Football on YouTube.",
        "channelsRank": 80.7478749999664,
        "pubDate": "2013-09-26T15:29:30Z",
        "title": "nikefootball",
        "thumbnails": {
          "default": {
            "url": "http://lh3.googleusercontent.com/-zFjX98Klq-4/AAAAAAAAAAI/AAAAAAAAAAA/EuN_geMN-c8/s88-c-k/photo.jpg"
          }
        },
        "totalEpisodes": 137,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCNhxq7He5p-_FdBh0OaxcQg/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/395203/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395203
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395203
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/395203"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 400305,
        "description": "Billy Wingrove & Jeremy Lynch are The F2. A brand new concept of Football Freestyle double act. They present to you entertainment at the highest standard. Please subscribe, sit back and enjoy...",
        "channelsRank": 79.3963086546922,
        "pubDate": "2013-09-27T07:32:40Z",
        "title": "F2Freestylers",
        "thumbnails": {
          "default": {
            "url": "http://i1.ytimg.com/i/Kvn9VBLAiLiYL4FFJHri6g/1.jpg?v=501aabfe"
          }
        },
        "totalEpisodes": 56,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCKvn9VBLAiLiYL4FFJHri6g/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/400305/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400305
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400305
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/400305"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 395206,
        "description": "The official home of Nike Soccer on YouTube.\n\nFor more, visit NIKESOCCER.com.",
        "channelsRank": 57.5147933855647,
        "pubDate": "2013-06-07T13:49:48Z",
        "title": "nikesoccer",
        "thumbnails": {
          "default": {
            "url": "http://i1.ytimg.com/i/45H39UhBIJNlHK1JTo7vMg/1.jpg?v=5238a9e6"
          }
        },
        "totalEpisodes": 64,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UC45H39UhBIJNlHK1JTo7vMg/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/395206/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395206
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 395206
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/395206"
        }
      ]
    },
    {
      "rel": [
        "urn:x-resource:schema:https://api.wurl.com/schemas/series.json"
      ],
      "class": [
        "series"
      ],
      "properties": {
        "id": 400304,
        "description": "SUBSCRIBE to No1 Football tutorial Channel on YouTube. Learn new techniques and skills. BEST WAY TO TALK TO ME",
        "channelsRank": 18.7295221802339,
        "pubDate": "2005-10-16T05:59:26Z",
        "title": "str",
        "thumbnails": {
          "default": {
            "url": "http://i1.ytimg.com/i/OdgoVab4B5L5s2GhQRSdqw/1.jpg?v=4fc532bd"
          }
        },
        "totalEpisodes": 1,
        "matchesApp": true,
        "link": "http://www.youtube.com/channel/UCOdgoVab4B5L5s2GhQRSdqw/videos"
      },
      "entities": [
        {
          "rel": [
            "urn:x-resource:name:episodes"
          ],
          "href": "https://api.wurl.com/api/series/400304/episodes",
          "class": [
            "link",
            "collection"
          ]
        }
      ],
      "actions": [
        {
          "name": "follow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Start following a series",
          "method": "POST",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400304
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        },
        {
          "name": "unfollow-series",
          "href": "https://api.wurl.com/api/follows",
          "title": "Stop following a series",
          "method": "DELETE",
          "fields": [
            {
              "name": "series_id",
              "type": "text",
              "value": 400304
            },
            {
              "name": "user_id",
              "type": "text"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "https://api.wurl.com/api/series/400304"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "https://api.wurl.com/api/search?q=soccer ronaldo"
    }
  ]
}