Documentation

Bing Videos API

Find videos matching a query.

Request

POST https://api.serqo.io/v1/search
FieldValue
enginebing
typevideos

Request headers

Create an API key and store it on your server. Use either authentication header below.

HeaderValueDescription
Content-Typeapplication/jsonJSON request body.
AuthorizationBearer YOUR_API_KEYRecommended authentication header.
x-api-keyYOUR_API_KEYAlternative to Authorization; use one authentication header.
bash
export SERP_API_KEY='YOUR_API_KEY'

curl https://api.serqo.io/v1/search \
  -H "Authorization: Bearer $SERP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "q": "how to make espresso",
  "engine": "bing",
  "type": "videos",
  "gl": "us",
  "hl": "en"
}'

GET request

The same endpoint also accepts URL query parameters. Keep the API key in the header.

bash
curl --get https://api.serqo.io/v1/search \
  -H "Authorization: Bearer $SERP_API_KEY" \
  --data-urlencode 'q=how to make espresso' \
  --data-urlencode 'engine=bing' \
  --data-urlencode 'type=videos' \
  --data-urlencode 'gl=us' \
  --data-urlencode 'hl=en'

Parameters

The number of results returned per request depends on the search engine and may vary.

FieldTypeRequiredDefaultDescription
qstringYes—Non-empty search query.
enginestringNogoogleUse bing for this API.
typestringNowebUse videos for this API.
glstringNo—Two-letter lowercase country code, for example us.
hlstringNo—Interface language code, for example en.
startintegerNo—Offset from 0 to 1000000. Use nextStart from the response.
safeoff | activeNo—Explicit-content filter: off disables it, active enables it.
tbsstringNo—Not supported by Bing; omit it to avoid INVALID_PARAM.

Only q is required by the API, but keep engine and type as shown for this search. A dash means the API does not assign a default. Unknown parameters return 422 INVALID_PARAM.

Response

HTTP 200. This is an abbreviated example using the unified response structure, not a live search. Field availability and result groups vary by the returned page; values can be null.

JSON
{
  "success": true,
  "requestId": "req_example",
  "data": {
    "engine": "bing",
    "results": [
      {
        "position": 1,
        "type": "organic",
        "title": "Example videos result",
        "url": "https://example.com/videos",
        "displayedUrl": "example.com",
        "source": "example.com",
        "date": null,
        "snippet": "An illustrative result for how to make espresso.",
        "thumbnail": null,
        "duration": null,
        "price": null,
        "rating": null
      }
    ],
    "features": {},
    "pagination": {
      "page": 1,
      "start": 0,
      "hasNext": false,
      "nextStart": null
    },
    "meta": {
      "elapsedMs": 250
    },
    "type": "videos",
    "query": {
      "q": "espresso machine",
      "gl": "us",
      "hl": "en",
      "device": "desktop",
      "start": 0
    },
    "searchInformation": {
      "totalResults": null,
      "timeTakenMs": null,
      "displayed": null
    }
  },
  "meta": {
    "cache": "miss"
  }
}

Response fields

FieldTypeDescription
data.queryobjectSearch query passed to the engine.
data.searchInformationobjectReported result count and search timing, when provided.
successbooleanWhether the request succeeded. True in this example.
requestIdstringRequest identifier to include when troubleshooting.
data.typestringSearch type used for this response.
data.enginestringEngine that returned the results.
data.resultsarrayMain result list. Check feature groups as well when present.
data.featuresobjectAdditional result groups; groups not returned by the engine may be absent.
data.paginationobjectCurrent offset and next-page availability.
data.meta.elapsedMsnumberSearch duration in milliseconds, not a performance guarantee.
meta.cachestring | nullhit, miss, or null if cache status is unknown.

Result fields

Read entries from data.results. Additional groups, when present, are in data.features.

FieldTypeDescription
data.results[].domainstring | nullDestination domain, when available.
data.results[].faviconstring | nullSite icon when provided.
data.results[].sitelinksarrayAdditional links nested under the result.
data.results[].sitelinks[].titlestringSitelink label.
data.results[].sitelinks[].urlstring | nullSitelink destination.
data.results[].extensionsobjectOther result-specific properties.
data.results[].snippetHighlightedWordsstring[], optionalHighlighted terms in the snippet, when provided.
data.results[].positionintegerRank on this results page, starting at 1.
data.results[].typestringResult category: organic, news, image, video, shopping, local, forum, book, patent or ad. This can differ from the request type.
data.results[].titlestring | nullTitle shown in the result.
data.results[].urlstring | nullDestination URL when resolved; it may be null.
data.results[].displayedUrlstring | nullURL or domain displayed by the engine; not always a clickable link.
data.results[].sourcestring | nullSource name or displayed domain.
data.results[].datestring | nullDate text when extracted; not necessarily an ISO timestamp.
data.results[].snippetstring | nullResult summary.
data.results[].thumbnailstring | nullThumbnail URL or inline data URL, when provided.
data.results[].durationstring | nullVideo duration text when provided.
data.results[].pricestring | nullPrice text when provided.
data.results[].ratingnumber | nullRating when provided.

Video duration, thumbnails and playable streams are not guaranteed. A result link points to a page, not a downloadable video file.

Pagination

  1. Check data.pagination.hasNext; stop when it is false.
  2. Use data.pagination.nextStart as start. Keep the other search parameters unchanged.
  3. Send the next request. Each page is a separate search request.
FieldTypeDescription
data.pagination.nextUrlstring | nullSearch-engine URL for the next page, when available; use nextStart with this API.
data.pagination.requestedPageintegerPage requested; may differ from the returned page if the engine does not provide it.
data.pagination.pageintegerCurrent page number.
data.pagination.startintegerCurrent result offset.
data.pagination.hasNextbooleanWhether another page is available.
data.pagination.nextStartinteger | nullOffset for the next request, or null when unavailable.

Errors

JSON
{
  "success": false,
  "requestId": "req_example",
  "error": {
    "code": "INVALID_PARAM",
    "message": "Unknown parameter \"page\"",
    "retryable": false
  }
}
FieldTypeDescription
error.codestringMachine-readable error code.
error.messagestringReason the request failed.
error.retryablebooleanWhether retrying is recommended.
error.retryAfterMsnumber, optionalMinimum wait before retrying, in milliseconds.
HTTP statusMeaningWhat to do
400Invalid request or unsupported search type.Check the query and engine/type combination.
401Missing, invalid or revoked API key.Check the authentication header and API key.
402Insufficient credits.Check your credit balance.
403Permission or plan restriction.Check account access and plan limits.
422Invalid parameter.Correct the parameter identified by error.message.
429Request rate or queue limit.Follow the retry rules below.
5xxServer or search service failure.Keep the requestId; retry only if allowed.

Retry rules

  • Retry only when error.retryable is true.
  • If error.retryAfterMs is present, wait at least that many milliseconds.

Credits

  • Successful searches use credits at the applicable rate.
  • Failed searches and timeouts are not charged.
  • Cache hits are free at the default rate. Before searching, your available balance must cover the full request cost.

See credit rules.