API v3 has been deprecated. Please use API v4 instead

Search

The search endpoint allows users to run searches across all movies, series, artists, and newscasts media types and returns results in a list.

Making a Search Query

GET: /api/v3/search(.json|xml)?query=:QUERY{.codeblock}

Sample query:

GET /api/v3/search.json?access_token=ACCESS_TOKEN&query=bad{.codeblock}

Response

{
  count:4,
  pagination:{
    previous:"",
    next:""
  },
  response:[
    {
      type:"series",
      resource:{
        id:773,
        title:"Bad Boy",
        title_language:"en",
        description:"Bad Boy is a drama about a guy, who changes his destiny in pursuit of power.
Shim Gun Wook (Kim Nam Gil) plots revenge against the Haeshin Group, a large corporation to whom Hong Tae Sung (Kim Jae Wook) is the heir.",
        description_language:"en",
        uri:"http://www.viki.com/api/v3/series/773.json",
        web_uri:"http://www.viki.com/channels/773-bad-boy",
        created_at:"November 18, 2009 11:32",
        genres:[
          {
            id:9,
            name:"Drama"
          }
        ],
        origin_country:"Korea",
        image:"http://m2.viki.com/aHR0cDovL2MwLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNzczLzhiMzVhMzUwMjRlZjY3ZWM1ZTIwNGMzN2EyNWNkOTY5MmRlNGRkZmEuanBn",
        episodes:{
          count:17,
          uri:"http://www.viki.com/api/v3/series/773/episodes.json"
        },
        subtitles:{
          vi:100,
          th:100,
          pt:100,
          pl:100,
          en:100,
          el:100,
          fr:100,
          it:100,
          ar:99,
          tr:99,
          tl:99,
          zh:99,
          de:99,
          hu:99,
          sl:99,
          sh:99,
          ro:99,
          es:99,
          sv:98,
          et:98,
          id:97,
          fa:96,
          ja:96,
          ru:96,
          hr:95,
          ms:84,
          nl:30,
          lt:26,
          gl:25,
          he:15,
          cs:8,
          fi:8,
          ko:7,
          bg:7,
          da:3,
          hm:2,
          jv:1,
          hi:1
        }
      }
    },
    {
      type:"coming_soon",
      resource:{
        id:8090,
        title:"Bad Girls",
        title_language:"en",
        description:"Starring Ella Chen and Mike He",
        description_language:"en",
        web_uri:"http://www.viki.com/channels/8090-bad-girls",
        created_at:"May 07, 2012 06:31",
        genres:[
          {
            id:18,
            name:"Romance"
          }
        ],
        origin_country:"Taiwan",
        image:"http://m3.viki.com/aHR0cDovL2MxLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvODA5MC84YTkwZTQ3ZGQ5MTJjOTYwZTdjYjJkOTFlYTRhNzZmNzY1ZmI2YjE2LmpwZw==",
        type:"movie"
      }
    },
    {
      type:"movie",
      resource:{
        id:47089,
        channel_id:4981,
        title:"This Girl Is Bad-Ass",
        title_language:"en",
        description:"The Chocolate and Raging Phoenix star looks pretty capable at combining kicks with comedy in Jakkalan (จั๊กกะแหล๋น). Riding a trendy fixed-gear bicycle, she's aiming the business end of her high-top tennis shoes at a bunch of bad guys in the crime farce, which is directed by and also starring Jeeja's The Kick castmate Petthai "        Mum Jokmok" Wongkumlao.",
        description_language:"en",
        created_at:"July 18, 2011 15:11",
        uri:"http://www.viki.com/api/v3/movies/47089.json",
        web_uri:"http://www.viki.com/channels/4981-jak-ka-ran/videos/47089",
        genres:[

        ],
        origin_country:"Thailand",
        image:"http://m2.viki.com/aHR0cDovL2MyLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNDk4MS83NmU3NjcwMTlmNTBkNjcwYmExZDczOWIwNDhlOGQxNzRiY2Y2OWE3LmpwZw==",
        subtitles:{
          fr:6
        },
        formats:{
          flash_embed:"http://a3.vikiassets.com/1345959692/assets/vikiplayer-31764b68bf94cd3cbb8f49ac3ec20727.swf?video_id=134928&host=www.viki.com&auto_play=true&source=api_v3&language_codes=en&partner=13"
        }
      }
    },
    {
      type:"coming_soon",
      resource:{
        id:1528,
        title:"BAD GUY OST",
        title_language:"en",
        description:"",
        description_language:"",
        web_uri:"http://www.viki.com/channels/1528-bad-guy-ost",
        created_at:"July 01, 2010 06:49",
        genres:[

        ],
        origin_country:"Korea",
        image:"http://m0.viki.com/aHR0cDovL2MzLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvMTUyOC8xNTI4LjQ2NjM5M2VlNjEyN2JjZDdmY2NhYmFjODA5OGI4OTJmYmIwY2M2MTQuanBn",
        type:"other"
      }
    }
  ]
}

Parameter Filters

To further filter your search results, you are allowed to pass the following parameter filters to your query string:

  • platform{.params}
  • watchable_in{.params}

watchable_in{.params} 

Filters according to region licensing availability. Some content providers on Viki have licensed their shows only for specific regions. These shows are restricted at a video level, which means that they won’t be playable should a user choose to view the video link. To prevent your users from seeing a listing of videos they cannot watch, use this parameter to filter out according to country. 

GET /api/v3/search.json?access_token=ACCESS_TOKEN&query=QUERY&watchable_in=us{.codeblock}

will return all movies, series, newscasts and artists that match ‘QUERY’ and are watchable in the US. See here for a full list of usable country codes.

platform{.params} 

Filters search results according to licensed platform. This parameter is only available if watchable_in is also passed to the API endpoint. Some content providers on Viki have only licensed their shows for certain platforms. You may filter using the platform parameter to ensure that the search result listings you receive are playable on your particular app platform.

Possible platform options: mobile,  web,  tv