API v3 has been deprecated. Please use API v4 instead

Coming Soon

The coming soon media API endpoint exposes coming soon content from the Viki platform.

List Coming Soon Content

Get a list of coming soon resources on Viki.

GET: /api/v3/coming_soon(.json|.xml){.codeblock}

Response

Here’s a sample response, with only one featured resource in the listing for brevity’s sake.

{
  count:8,
  pagination:{
    previous:"",
    next:""
  },
  response:[
    {
      id:9328,
      title:"Wan Chai Baby",
      title_language:"en",
      description:"Tess, a young Filipina, comes to Hong Kong to find employment as a domestic worker so that she can support her family back home. What she finds instead is a lot of abuse and disappointments and no money to send to her family. Lured by the easy money of working as a masseuse in the Wan Chai district, Tess faces the impossible choice of sacrificing herself to save her family.",
      description_language:"en",
      web_uri:"http://www.viki.com/channels/9328-wan-chai-baby",
      created_at:"July 20, 2012 03:06",
      genres:[
        {
          id:9,
          name:"Drama"
        }
      ],
      origin_country:"Hong Kong",
      image:"http://m1.viki.com/aHR0cDovL2MyLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvOTMyOC80YWFkNTQ4MjJjMzQwZGE5ZDg5NDAyM2Y0ZDc0YWExMjJkMjMxMjBjLmpwZw==",
      type:"movie"
    },
    {
      id:7777,
      title:"Hi5teria",
      title_language:"id",
      description:"Sebuah film omnibus bertema thriller dengan 5 cerita menyeramkan yang berbeda dari 5 sutradara muda berbakat. Siapkan nyali kalian untuk menyaksikan film yang akan membuat anda berpikir dan ketakutan ini.",
      description_language:"id",
      web_uri:"http://www.viki.com/channels/7777",
      created_at:"April 05, 2012 07:00",
      genres:[
        {
          id:12,
          name:"Horror & Supernatural"
        }
      ],
      origin_country:"Indonesia",
      image:"http://m2.viki.com/aHR0cDovL2MzLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNzc3Ny82ZmNiMzE5MzllZGJkN2RmZTc2MmExODgyYzVmOWU3OWRmYzc3MTU0LmpwZw==",
      type:"movie"
    },
    {
      id:5866,
      title:"Akuemon",
      title_language:"en",
      description:"A fortuneteller tells Hidari Taisho that he must hunt down 1000 foxes in order to conquer the country. So Akuemon, who is disliked by everybody, is hired to do the foxhunting. In response, the foxes send a female fox to Akuemon's house disguised as his wife. A story unfolds between Akuemon, who has never loved anyone, and the female fox, who slowly discovers true love in him even while tormented by sorrow over her comrades' death. ",
      description_language:"en",
      web_uri:"http://www.viki.com/channels/5866-akuemon",
      created_at:"September 29, 2011 10:33",
      genres:[
        {
          id:2,
          name:"Anime"
        }
      ],
      origin_country:"Japan",
      image:"http://m2.viki.com/aHR0cDovL2MwLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNTg2Ni9hZWY3N2ZhOGM3MjNmNDQ0YTdkNDg4Y2U3NjcwZWJkMjlmZDBkM2RiLmpwZw==",
      type:"series"
    },
    {
      id:5865,
      title:"Adachi-Ga Hara",
      title_language:"en",
      description:"This is a story of an astronaut who is sent to a penal colony planet, and there meets an old woman who shows him the truth of life and love. Originally a short Manga in "      The Lion Books,
      " it was made into an animated series. The chief character, Jess, fights to bring down the dictator of the federation of the Earth and other planets, but is arrested by the federal authorities and sent to a penal colony planet. The story focuses on him, using Japanese Noh drama "      Kurozuka" as a motif.",
      description_language:"en",
      web_uri:"http://www.viki.com/channels/5865-adachi-ga-hara",
      created_at:"September 29, 2011 10:33",
      genres:[
        {
          id:2,
          name:"Anime"
        }
      ],
      origin_country:"Japan",
      image:"http://m1.viki.com/aHR0cDovL2MwLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNTg2NS82OWI3ZmY0ODM4ZmI1NjY4OGJhNzE1Njc2YzVlYmI3NDA5MWFkNjFjLmpwZw==",
      type:"series"
    },
    {
      id:5863,
      title:"Lunn Flies Into The Wind",
      title_language:"en",
      description:"This is the third episode in the Lion Books Series, in which a boy named Akira Toyota falls in love with a girl on a poster he names Lunn and starts to look for her. This story depicts the heartache of adolescent first-love in a low-key manner.",
      description_language:"en",
      web_uri:"http://www.viki.com/channels/5863-lunn-flies-into-the-wind",
      created_at:"September 29, 2011 10:32",
      genres:[
        {
          id:2,
          name:"Anime"
        }
      ],
      origin_country:"Japan",
      image:"http://m1.viki.com/aHR0cDovL2MyLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNTg2My8yOTZjNDlmYTMxNGJjMzcwMTk1ZjViMjA2ZjZjYTA2MjQ2NWFhZGUzLmpwZw==",
      type:"series"
    },
    {
      id:5862,
      title:"Rain Boy",
      title_language:"en",
      description:"This is the second story of "      The Lion Books" series. A boy meets a lonely little umbrella ghost wearing Geta. He promises the ghost that he will give it a pair of rain boots in exchange for three wishes. The boy,
      however,
      grows up completely forgetting the promise. One day,
      when he happens to remember the ghost,
      he rushes back to that bridge in his hometown,
      to the Rain Boy...This is a moving,
      sweet hometown fantasy about a gentle ghost and a forgotten promise.",
      description_language:"en",
      web_uri:"http://www.viki.com/channels/5862-rain-boy",
      created_at:"September 29, 2011 10:32",
      genres:[
        {
          id:2,
          name:"Anime"
        }
      ],
      origin_country:"Japan",
      image:"http://m3.viki.com/aHR0cDovL2MzLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNTg2Mi82MjY0ODU0MWM0NGUwYjBhNWRiYjc2YTE2M2VlYzQ4ZTE0MjNhNDIzLmpwZw==",
      type:"series"
    },
    {
      id:5861,
      title:"The Green Cat",
      title_language:"en",
      description:"Ban Shunsaku co-manages a shop with friend Yushi.  Yushi is killed by a gang, and Ban Shunsaku adopts his bereaved son, Sango.  Ban, who is going back to Japan, witnesses a flying saucer. Then a green cat appears before Sango.  They disappear from the ship bound for Japan.  The cat takes possession of young men, depriving them of their sense of self-reliance in exchange for fulfilling their desires.  Sango, becomes influential in the underworld.
 ",
      description_language:"en",
      web_uri:"http://www.viki.com/channels/5861-the-green-cat",
      created_at:"September 29, 2011 10:31",
      genres:[
        {
          id:2,
          name:"Anime"
        }
      ],
      origin_country:"Japan",
      image:"http://m2.viki.com/aHR0cDovL2MxLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNTg2MS9mZDc0N2Y1Y2ExOTNlZDgwOGUxYmE1ZGViZWQzMjY4MGU1MWM5MWM4LmpwZw==",
      type:"series"
    },
    {
      id:5530,
      title:"Roar Season 1",
      title_language:"en",
      description:"A one-hour action-adventure drama
series which captures all the passion,
magic and courage of a mythical land
set in Europe 400 A.D.",
      description_language:"en",
      web_uri:"http://www.viki.com/channels/5530-roar-1",
      created_at:"August 31, 2011 03:02",
      genres:[
        {
          id:9,
          name:"Drama"
        }
      ],
      origin_country:"United States",
      image:"http://m3.viki.com/aHR0cDovL2MxLnZpa2lhc3NldHMuY29tL3VwbG9hZHMvY2hhbm5lbC90aHVtYm5haWwvNTUzMC8xZDllMjVmNDY4ODA4NWNiOGZiNmUwN2VlYWI4NDUxNjUwN2E2MzI1LmpwZw==",
      type:"series"
    }
  ]
}

Scopes

To get only the upcoming movies you can add /movies to the path of the endpoint:

GET: /api/v3/coming_soon/movies(.json|.xml){.codeblock}

On the other hand, if you only want to get upcoming series you can add /series to the path:

GET: /api/v3/coming_soon/series(.json|.xml){.codeblock}

Parameter Filters

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

platform{.params}

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

Possible platform options: mobile, web, tv

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/coming_soon/movies.json?access_token=ACCESS_TOKEN&watchable_in=us{.codeblock}

will return all series that are watchable in the US. See here for a full list of usable country codes.

Parameter Options

  • language{.params}
  • page{.params}
  • per_page{.params}

language{.params}

the language parameter may be passed to display titles and descriptions in your language of choice. For example,

GET /api/v3/coming_soon.json?access_token=ACCESS_TOKEN&language=ko{.codeblock}

will return a list of coming soon content with titles and descriptions in Korean. For items with no Korean translations available, titles and descriptions will default to English. See here for a full list of usable language codes.

page{.params}

the page option is used to get a specific page of results. By default API responses are paginated, with 25 items per page. So:

GET /api/v3/coming_soon.json?access_token=ACCESS_TOKEN&page=2{.codeblock}

will return the second page of the coming_soon results.

per_page{.params}

the per_page option is used to specify the number of items per page.