Videvo API Documentation
- How to call the video library
- Accepted Parameters
- key
- query
- lang
- id
- clips_show
- category
- asset_type
- safesearch
- order
- randomize
- page
- per_page
- licence
- resolution
- duration
- Example code
- total_rows
- total_pages
- results
- total_rows
- _type
- _id
- _source
- details_page
- title
- author
- thumbnail
- large_preview
- Small_preview_mp4 / small_preview_webm
- date_published
- duration
- description
- keywords
- license
- codec
- frame
- resolution
- aspect_ratio
- rating
- is_editorial
- is_sensitive
- is_premium
- JavaScript Example of API call with several parameters
Our API allows you to dynamically display our stock assets on your site. Build it from scratch following the instructions below.
The documentation provides information about each API parameter that you can use to display stock video footage on your site. You will also find an explanation for each response key and an example of an API call with several parameters in Javascript.
How to call the video library
GET base URL
Accepted Parameters
key (required)
str
Your unique API key (provided by the Videvo team to you)
query
str
The query you want to send to our library. If left blank, all videos available will be called. Example: “drone+video”
lang
str
The language in which queries will be accepted. Default is “en”
Values accepted: “en”, “es”, “de”
id
str
Used to retrieve one individual clip and all it’s available metadata by using its ID. Not useful for “gallery” mode.
clips_show
str
Filter results of the Videvo library by Free or Premium. Default: “all”
Values accepted: “free”, “premium”.
category
str
Surface library results by their assigned category or tag (i.e. “Business”, “Nature”).
Please refer to the Videvo.net library for all Values accepted.
asset_type
str
Filter results by “Footage” or “Motion Graphics”. Default: “all”
Values accepted: “video”, “motion graphics”
safesearch
bool
A filter to accept or block results tagged as “Adult Content”. “true” hides adult content, “false” allows it. Default is “true”.
Values accepted: “true”, “false”
order
str
The order in which displayed results are to be sorted. Default: “popular”.
Values accepted: “popular”, “latest”, “random”.
randomize
str
A parameter that allows to shuffle the results and display them in a randomized fashion. “true” turns the randomization on, “false” turns it off. Default: “false”.
Values accepted: “true”, “false”
page
int
Query results appear with pagination. This parameter allows to chose the page number of which results will be displayed. Default: “1” (Page 1).
per_page
int
Select the number of clip results to be displayed per gallery page. Default is “20”.
Values accepted: 3 – 2
licence
string
Filter results of the Videvo library by their assigned licence type. Default: “all”
Values accepted: “all”, “royalty_free”, “videvo_attribution_license”, “CC_by_3.0”.
resolution
string
Filter results of the Videvo library by their resolution. Default: “all” (all resolutions).
Values accepted: 4k (4K clips), standard_definition (720p), high_definition (1080p).
duration
string
Filter results of the Videvo library by their duration. It is expressed as a range with “min_duration” and/or “max_duration” parameters below
Format accepted: TBD 00:00:00
mpin_duration [
_duration [<=]).Values accepted: “true”, “false”
Example code
Retrieving free videos about “fire trucks”. The search term query needs to be URL encoded. “{{ KEY }}” has to be replaced with your API key.
https://www.videvo.net/api/videos/?key={{ KEY }}&query=fire+trucks&clips_show=free
Response for this request:
{
"results": [
{
"_type": "video",
"_id": "783004",
"_source": {
"id": 783004,
"details_page": "https%3A%2F%2Fwww.videvo.net%2Fvideo%2F783004%2F",
"title": "Close Up Shot Rain Drops Falling On Leaves",
"author": "Videvo",
"thumbnail": "https:\/\/cdn.videvo.net\/videvo_files\/video\/free\/2021-04\/thumbnails\/210329_06B_Bali_1080p_013_small.jpg",
"large_preview": "https:\/\/cdn.videvo.net\/videvo_files\/video\/free\/2021-04\/large_watermarked\/210329_06B_Bali_1080p_013_preview.mp4",
"small_preview_mp4": "https:\/\/cdn.videvo.net\/videvo_files\/video\/free\/2021-04\/small_watermarked\/210329_06B_Bali_1080p_013_preview.mp4",
"small_preview_webm": "https:\/\/cdn.videvo.net\/videvo_files\/video\/free\/2021-04\/small_watermarked\/210329_06B_Bali_1080p_013_preview.webm",
"date_published": "2021-04-28",
"duration": "00:30",
"description": "A close-up shot of rain falling on leaves in Bali ",
"keywords": "south east asia indonesia bali island tropical forest plant foliage leaf leaves tree bush nature rain storm weather Close Up Shot Rain Drops Falling On Leaves",
"license": "Videvo Attribution License",
"codec": "mp4",
"frame": "1920x1080",
"resolution": "1080p",
"aspect_ratio": "16:9",
"rating": 4,
"is_editorial": 0,
"is_sensitive": true,
"is_premium": 0
}
},
...
],
"total_rows": 17129,
"total_pages": 857
}
Response key
Description
total_rows
The total number of hits
total_pages
The total number of accessible pages
results
An array containing clips info
total_rows
Clip type (video / audio)
_type
The total number of hits
_id
A unique identifier for current video clip
_source
An object containing more info about the clip
details_page
Source page on Videvo
title
Clip title
The creator of the clip
thumbnail
Clip thumbnail / image preview
large_preview
A watermarked preview for the clip, scaled at 1280×720, in mp4 format. (It may not exists)
Small_preview_mp4 / small_preview_webm
A watermarked preview for the clip, scaled at 428×240, in mp4 or webm format
date_published
The date when the clip was published to Videvo
duration
Clip length, formatted as mm:ss
description
Clip description
keywords
Keywords associated to that clip
license
For more info, check Licensing page
codec
Codec used to encode the stream
frame
Clip resolution, formatted as width x height.
resolution
Clip resolution
aspect_ratio
Aspect ratio of the clip
rating
is_editorial
Editorial Use Only flag. If the video clip can only be used for editorial purposes. Using that video clip for commercial or promotional projects is strictly prohibited.
is_sensitive
Flag to mark sensitive content. (Currently inverted : 1 means that the clip is not sensitive, 0 that it is)
Premium / free flag
JavaScript Example of API call with several parameters
var API_KEY = 'YOUR_API_KEY';
var URL = "https://www.videvo.net/api/videos/";
var parameters = {
"clips_show": "free",
"order": "popular",
"page": 0,
"per_page": 20,
"safesearch": 1,
"editorial": 1,
"key": API_KEY,
"query": "cute puppies"
}
$.get({
url: URL,
data: parameters,
success: function(result) {
// success callback
},
error: function (response) {
// error callback
}
});