Video Search API - v7
The Video API lets partners send a search query to Bing and get back a list of relevant videos. Note you should call the Video API if you need video content only. If you need other content such as news and webpages in addition to videos, you must call the Search API which includes videos in the response. You must display the videos in the order provided in the response.
Request URL
Request parameters
string
The user's search query string
(optional)
number
The number of video results to return in the response. The actual number delivered may be less than requested.
(optional)
number
The zero-based offset that indicates the number of video results to skip before returning results.
(optional)
string
The market where the results come from. Typically, this is the country where the user is making the request from; however, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US.
Full list of supported markets:
es-AR,en-AU,de-AT,nl-BE,fr-BE,pt-BR,en-CA,fr-CA,es-CL,da-DK,fi-FI,fr-FR,de-DE,zh-HK,en-IN,en-ID,en-IE,it-IT,ja-JP,ko-KR,en-MY,es-MX,nl-NL,en-NZ,no-NO,zh-CN,pl-PL,pt-PT,en-PH,ru-RU,ar-SA,en-ZA,es-ES,sv-SE,fr-CH,de-CH,zh-TW,tr-TR,en-GB,en-US,es-US
(optional)
string
A filter used to filter results for adult content.
Request headers
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
Response 200
{
"_type": "Videos",
"instrumentation": {
"pingUrlBase": "https://www.bingapis.com/api/ping?IG=D0BBFF4C521545FA8B777E0A292DF1E4&CID=070910FF0C0362112C11188E0DD06323&ID=",
"pageLoadPingUrl": "https://www.bingapis.com/api/ping/pageload"
},
"readLink": "https://www.bing.com/api/V7/videos/search?q=cats",
"webSearchUrl": "https://www.bing.com/videos/search?q=cats",
"webSearchUrlPingSuffix": "DevEx,5039.1",
"totalEstimatedMatches": 1000,
"value": [
{
"name": "Cats Compilation",
"description": "Do yourself a favor and just watch it, okay? You won't be disappointed. Like Us on FACEBOOK http://www.facebook.com/Compilariz Follow Us on TWITTER https://twitter ...",
"webSearchUrl": "https://www.bing.com/videos/search?q=cats#view=detail&mid=1D6A38FAD52B765552FD1D6A38FAD52B765552FD",
"webSearchUrlPingSuffix": "DevEx,5040.1",
"thumbnailUrl": "https://tse2.mm.bing.net/th?id=OVP.V769031160af314bf5ed81fd391a35948&pid=Api",
"datePublished": "2013-03-05T21:07:17",
"publisher": [
{
"name": "YouTube"
}
],
"creator": {
"name": "CompilarizTVi"
},
"contentUrl": "https://www.youtube.com/watch?v=xEhaVhta7sI",
"hostPageUrl": "https://www.youtube.com/watch?v=xEhaVhta7sI",
"hostPageUrlPingSuffix": "DevEx,5010.1",
"encodingFormat": "h264",
"hostPageDisplayUrl": "https://www.youtube.com/watch?v=xEhaVhta7sI",
"width": 480,
"height": 360,
"duration": "PT5M5S",
"motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.%2fVJVdivV%2bjhqHQ&pid=Api",
"embedHtml": "<iframe width=\"1280\" height=\"720\" src=\"https://www.youtube.com/embed/xEhaVhta7sI?autoplay=1\" frameborder=\"0\" allowfullscreen></iframe>",
"allowHttpsEmbed": true,
"viewCount": 17012237,
"thumbnail": {
"width": 300,
"height": 168
},
"videoId": "1D6A38FAD52B765552FD1D6A38FAD52B765552FD"
},
{
"name": "Just A Bunch Of Scaredy Cats!",
"description": "Curiosity definitely scares the cat! Check out these hilarious cats getting startled by all sorts of things including fake spiders, kitchen timers, and even their own ...",
"webSearchUrl": "https://www.bing.com/videos/search?q=cats#view=detail&mid=CA132277F780C44289CCCA132277F780C44289CC",
"webSearchUrlPingSuffix": "DevEx,5041.1",
"thumbnailUrl": "https://tse3.mm.bing.net/th?id=WN.MBwiImkclX59vDoQCaRo4w&pid=Api",
"datePublished": "2015-06-24T00:08:05",
"publisher": [
{
"name": "YouTube"
}
],
"creator": {
"name": "America's Funniest Home Videos"
},
"contentUrl": "https://www.youtube.com/watch?v=Xgm-iOW-uBY",
"hostPageUrl": "https://www.youtube.com/watch?v=Xgm-iOW-uBY",
"hostPageUrlPingSuffix": "DevEx,5019.1",
"encodingFormat": "h264",
"hostPageDisplayUrl": "https://www.youtube.com/watch?v=Xgm-iOW-uBY",
"width": 1280,
"height": 720,
"duration": "PT1M32S",
"motionThumbnailUrl": "https://tse1.mm.bing.net/th?id=OM.zIlCxID3dyITyg&pid=Api",
"embedHtml": "<iframe width=\"1280\" height=\"720\" src=\"https://www.youtube.com/embed/Xgm-iOW-uBY?autoplay=1\" frameborder=\"0\" allowfullscreen></iframe>",
"allowHttpsEmbed": true,
"viewCount": 1513335,
"thumbnail": {
"width": 300,
"height": 168
},
"videoId": "CA132277F780C44289CCCA132277F780C44289CC"
},
{
"name": "Funny cats annoying owners - Cute cat compilation",
"description": "Cats are funny and cute but sometimes they can be a real pain in the neck :P Soo annoying and destructive! They break lamps, glasses, scratch furniture, they...",
"webSearchUrl": "https://www.bing.com/videos/search?q=cats#view=detail&mid=2CEF7088658217B1B6702CEF7088658217B1B670",
"webSearchUrlPingSuffix": "DevEx,5042.1",
"thumbnailUrl": "https://tse4.mm.bing.net/th?id=WN.mp8NdJSJymZtnLHuOSEiDQ&pid=Api",
"datePublished": "2014-11-07T21:55:27",
"publisher": [
{
"name": "YouTube"
}
],
"creator": {
"name": "Tiger Productions"
},
"contentUrl": "https://www.youtube.com/watch?v=OnqnCoPLdyw",
"hostPageUrl": "https://www.youtube.com/watch?v=OnqnCoPLdyw",
"hostPageUrlPingSuffix": "DevEx,5028.1",
"encodingFormat": "h264",
"hostPageDisplayUrl": "https://www.youtube.com/watch?v=OnqnCoPLdyw",
"width": 480,
"height": 360,
"duration": "PT5M58S",
"motionThumbnailUrl": "https://tse3.mm.bing.net/th?id=OM.cLaxF4JliHDvLA&pid=Api",
"embedHtml": "<iframe width=\"1280\" height=\"720\" src=\"https://www.youtube.com/embed/OnqnCoPLdyw?autoplay=1\" frameborder=\"0\" allowfullscreen></iframe>",
"allowHttpsEmbed": true,
"viewCount": 6475557,
"thumbnail": {
"width": 300,
"height": 168
},
"videoId": "2CEF7088658217B1B6702CEF7088658217B1B670"
}
],
"nextOffsetAddCount": 0,
"queryExpansions": [
{
"text": "Cats Meowing",
"displayText": "Meowing",
"webSearchUrl": "https://www.bing.com/videos/search?q=Cats+Meowing&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Meowing%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=VRPATC",
"webSearchUrlPingSuffix": "DevEx,5055.1",
"searchLink": "https://www.bing.com/api/V7/videos/search?q=Cats+Meowing&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Meowing%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d",
"thumbnail": {
"thumbnailUrl": "https://tse2.mm.bing.net/th?q=Cats+Meowing&pid=Api&mkt=en-US&adlt=moderate&t=1"
}
},
{
"text": "Cat vs Dog",
"displayText": "Vs Dog",
"webSearchUrl": "https://www.bing.com/videos/search?q=Cat+vs+Dog&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Vs+Dog%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=VRPATC",
"webSearchUrlPingSuffix": "DevEx,5057.1",
"searchLink": "https://www.bing.com/api/V7/videos/search?q=Cat+vs+Dog&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Vs+Dog%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d",
"thumbnail": {
"thumbnailUrl": "https://tse4.mm.bing.net/th?q=Cat+vs+Dog&pid=Api&mkt=en-US&adlt=moderate&t=1"
}
},
{
"text": "Funny Cat",
"displayText": "Funny",
"webSearchUrl": "https://www.bing.com/videos/search?q=Funny+Cat&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Funny%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=VRPATC",
"webSearchUrlPingSuffix": "DevEx,5059.1",
"searchLink": "https://www.bing.com/api/V7/videos/search?q=Funny+Cat&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Funny%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d",
"thumbnail": {
"thumbnailUrl": "https://tse3.mm.bing.net/th?q=Funny+Cat&pid=Api&mkt=en-US&adlt=moderate&t=1"
}
}
],
"pivotSuggestions": [
{
"pivot": "cats",
"suggestions": [
{
"text": "Felidae",
"displayText": "Felidae",
"webSearchUrl": "https://www.bing.com/videos/search?q=Felidae&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Felidae%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=VRQBPS",
"webSearchUrlPingSuffix": "DevEx,5140.1",
"searchLink": "https://www.bing.com/api/V7/videos/search?q=Felidae&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Felidae%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d",
"thumbnail": {
"thumbnailUrl": "https://tse3.mm.bing.net/th?q=Felidae&pid=Api&mkt=en-US&adlt=moderate&t=1"
}
},
{
"text": "African Wildcat",
"displayText": "African Wildcat",
"webSearchUrl": "https://www.bing.com/videos/search?q=African+Wildcat&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22African+Wildcat%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=VRQBPS",
"webSearchUrlPingSuffix": "DevEx,5142.1",
"searchLink": "https://www.bing.com/api/V7/videos/search?q=African+Wildcat&tq=%7b%22pq%22%3a%22cats%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22cats%22%2c%22pv%22%3a%22cats%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22African+Wildcat%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d",
"thumbnail": {
"thumbnailUrl": "https://tse3.mm.bing.net/th?q=African+Wildcat&pid=Api&mkt=en-US&adlt=moderate&t=1"
}
}
]
}
]
}
Response 401
{
"error":{
"statusCode": 401,
"message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key."
}
}
Response 403
{
"error":{
"statusCode": 403,
"message": "Out of call volume quota. Quota will be replenished in 2.12 days."
}
}
Response 429
{
"error":{
"statusCode": 429,
"message": "Rate limit is exceeded. Try again in 26 seconds."
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.cognitive.microsoft.com/bing/v7.0/videos/search?q=cats&count=10&offset=0&mkt=en-us&safeSearch=Moderate"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["q"] = "cats";
queryString["count"] = "10";
queryString["offset"] = "0";
queryString["mkt"] = "en-us";
queryString["safeSearch"] = "Moderate";
var uri = "https://api.cognitive.microsoft.com/bing/v7.0/videos/search?" + queryString;
var response = await client.GetAsync(uri);
if (response?.Content != null)
{
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.apache.http.entity.StringEntity;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.cognitive.microsoft.com/bing/v7.0/videos/search");
builder.setParameter("q", "cats");
builder.setParameter("count", "10");
builder.setParameter("offset", "0");
builder.setParameter("mkt", "en-us");
builder.setParameter("safeSearch", "Moderate");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"q": "cats",
"count": "10",
"offset": "0",
"mkt": "en-us",
"safeSearch": "Moderate",
};
$.ajax({
url: "https://api.cognitive.microsoft.com/bing/v7.0/videos/search?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert(JSON.stringify(data));
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.cognitive.microsoft.com/bing/v7.0/videos/search";
NSArray* array = @[
// Request parameters
@"entities=true",
@"q=cats",
@"count=10",
@"offset=0",
@"mkt=en-us",
@"safeSearch=Moderate",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.cognitive.microsoft.com/bing/v7.0/videos/search');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'q' => 'cats',
'count' => '10',
'offset' => '0',
'mkt' => 'en-us',
'safeSearch' => 'Moderate',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'q': 'cats',
'count': '10',
'offset': '0',
'mkt': 'en-us',
'safeSearch': 'Moderate',
})
try:
conn = http.client.HTTPSConnection('api.cognitive.microsoft.com')
conn.request("GET", "/bing/v7.0/videos/search?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.cognitive.microsoft.com/bing/v7.0/videos/search')
uri.query = URI.encode_www_form({
# Request parameters
'q' => 'cats',
'count' => '10',
'offset' => '0',
'mkt' => 'en-us',
'safeSearch' => 'Moderate'
})
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body