Skip to main content
POST
/
api
/
vimeo
/
videos
/
search
/vimeo/videos/search
curl --request POST \
  --url https://api.anysite.io/api/vimeo/videos/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300,
  "sort": "relevance",
  "resolution": "4k",
  "live_event": "now",
  "staff_picks": false
}
'
[
  {
    "id": "<string>",
    "@type": "VimeoVideo",
    "video_title": "<string>",
    "description": "<string>",
    "url": "<string>",
    "image": "<string>",
    "duration": 123,
    "width": 123,
    "height": 123,
    "fps": 123,
    "user": {
      "id": "<string>",
      "@type": "VimeoUser",
      "name": "<string>",
      "alias": "<string>",
      "url": "<string>",
      "bio": "<string>",
      "image": "<string>",
      "location": "<string>",
      "is_verified": false,
      "membership_type": "<string>",
      "video_count": 123,
      "follower_count": 123,
      "following_count": 123,
      "showcase_count": 123,
      "like_count": 123,
      "social_links": [],
      "created_at": 123
    },
    "view_count": 123,
    "like_count": 123,
    "comment_count": 123,
    "tags": [],
    "categories": [],
    "license": "<string>",
    "privacy": "<string>",
    "content_rating": [],
    "language": "<string>",
    "is_spatial": false,
    "is_live": false,
    "is_hdr": false,
    "unlisted_hash": "<string>",
    "files": [],
    "subtitles": [],
    "created_at": 123
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
query
string
required

Search query

Minimum string length: 1
Example:

"nature"

count
integer
required

Max number of results

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
sort
enum<string>
default:relevance

Result ordering

Available options:
relevance,
newest,
popular,
title_asc,
title_desc,
longest,
shortest
category
enum<string> | null

Filter by category

Available options:
travel,
documentary,
experimental,
animation,
narrative,
music,
educational,
sports,
industry,
art,
brandedcontent,
instructionals,
adsandcommercials,
cameratechniques,
events,
product,
trailers,
comedy,
personal,
journalism,
fashion,
wedding,
talks,
food,
identsandanimatedlogos,
titlesandcredits
duration
enum<string> | null

Filter by video length

Available options:
short,
medium,
long
license
enum<string> | null

Filter by Creative Commons license

Available options:
by-nc-nd,
by,
by-nc,
by-nc-sa,
by-nd,
by-sa,
cc0
resolution
enum<string> | null

Filter by resolution

Available options:
4k
hdr
enum<string> | null

Filter by HDR format

Available options:
hdr,
dolby_vision,
hdr10,
hdr10+
spatial
enum<string> | null

Filter by spatial / 360 format

Available options:
spatial,
360
price
enum<string> | null

Filter by price

Available options:
free,
paid
live_event
enum<string> | null

Filter by live status

Available options:
now
uploaded
enum<string> | null

Filter by upload recency

Available options:
this-year,
this-month,
this-week,
today
staff_picks
boolean
default:false

Only Vimeo Staff Picks

Response

Successful Response

id
string
required
@type
string
default:VimeoVideo
video_title
string | null
description
string | null
url
string | null
image
string | null
duration
integer | null
width
integer | null
height
integer | null
fps
number | null
user
object | null
view_count
integer | null
like_count
integer | null
comment_count
integer | null
tags
string[]
categories
string[]
license
string | null
privacy
string | null
content_rating
string[]
language
string | null
is_spatial
boolean
default:false
is_live
boolean
default:false
is_hdr
boolean
default:false
unlisted_hash
string | null
files
object[]
subtitles
object[]
created_at
integer | null