Vimeo

Get Vimeo On Demand title

Get a Vimeo On Demand title: description, genres, prices, film, trailer, owner and counts.

GET/v1/vimeo/ondemand/{slug}
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
1
slugstringrequiredpath

Vimeo On Demand slug or numeric id, e.g. `pariah`.

pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

Response fields
157

Endpoint-specific response payload.

datalookupStatus
string

Whether the entity was found. A removed, private, password-protected or never-existing item is `not_found`; Vimeo does not distinguish them.

one of: found, not_found

The On Demand title when found; otherwise null.

dataonDemandid
integernullable

On Demand page id.

≥ 0

dataonDemandname
stringnullable

Title.

dataonDemanddescription
stringnullable

Description.

dataonDemandtype
stringnullable

Title type, e.g. `film`.

dataonDemandurl
stringnullable

Title page URL.

dataonDemanddomainUrl
stringnullable

Custom-domain URL, when the seller has one.

Content-rating labels the title carries.

dataonDemandcontentRating[]
stringoptional
dataonDemandtheme
stringnullable

Player theme.

Title colours.

dataonDemandcolorsprimary
stringnullable

Primary colour.

dataonDemandcolorssecondary
stringnullable

Secondary colour.

Publication state.

dataonDemandpublishactive
booleannullable

Whether it is published.

dataonDemandpublishat
stringnullable

When it was published.

Preorder state.

dataonDemandpreorderactive
booleannullable

Whether preorder is open.

dataonDemandpreorderat
stringnullable

When preordering started.

dataonDemandpreordercancelAt
stringnullable

When preordering was cancelled.

dataonDemandpreorderpublishAt
stringnullable

When it is due to publish.

dataonDemandrating
stringnullable

Rating label.

An image Vimeo hosts.

dataonDemandposterurl
stringnullable

Image URL at its base size.

The same image at named sizes.

dataonDemandpostersizes[]width
integer

Width in pixels.

≥ 0

dataonDemandpostersizes[]height
integer

Height in pixels.

≥ 0

dataonDemandpostersizes[]url
string

Image URL at this size.

An image Vimeo hosts.

dataonDemandthumbnailurl
stringnullable

Image URL at its base size.

The same image at named sizes.

dataonDemandthumbnailsizes[]width
integer

Width in pixels.

≥ 0

dataonDemandthumbnailsizes[]height
integer

Height in pixels.

≥ 0

dataonDemandthumbnailsizes[]url
string

Image URL at this size.

An image Vimeo hosts.

dataonDemandbackgroundurl
stringnullable

Image URL at its base size.

The same image at named sizes.

dataonDemandbackgroundsizes[]width
integer

Width in pixels.

≥ 0

dataonDemandbackgroundsizes[]height
integer

Height in pixels.

≥ 0

dataonDemandbackgroundsizes[]url
string

Image URL at this size.

Genres.

dataonDemandgenres[]id
string

Genre slug.

dataonDemandgenres[]name
stringnullable

Genre name.

dataonDemandgenres[]canonical
stringnullable

Canonical slug.

dataonDemandgenres[]url
stringnullable

Browse URL.

A rent, buy or subscription option.

dataonDemandrentactive
booleannullable

Whether the option is offered.

Prices Vimeo lists, one entry per currency.

dataonDemandrentprices[]currency
string

Three-letter currency code.

dataonDemandrentprices[]amount
numbernullable

Price in that currency.

dataonDemandrenturl
stringnullable

Store or title URL.

dataonDemandrentperiod
stringnullable

Rental period, e.g. `24 hour`.

A rent, buy or subscription option.

dataonDemandbuyactive
booleannullable

Whether the option is offered.

Prices Vimeo lists, one entry per currency.

dataonDemandbuyprices[]currency
string

Three-letter currency code.

dataonDemandbuyprices[]amount
numbernullable

Price in that currency.

dataonDemandbuyurl
stringnullable

Store or title URL.

dataonDemandbuyperiod
stringnullable

Rental period, e.g. `24 hour`.

A rent, buy or subscription option.

dataonDemandsubscriptionactive
booleannullable

Whether the option is offered.

Prices Vimeo lists, one entry per currency.

dataonDemandsubscriptionprices[]currency
string

Three-letter currency code.

dataonDemandsubscriptionprices[]amount
numbernullable

Price in that currency.

dataonDemandsubscriptionurl
stringnullable

Store or title URL.

dataonDemandsubscriptionperiod
stringnullable

Rental period, e.g. `24 hour`.

Episode purchase options.

A rent, buy or subscription option.

dataonDemandepisodesrentactive
booleannullable

Whether the option is offered.

Prices Vimeo lists, one entry per currency.

dataonDemandepisodesrentprices[]currency
string

Three-letter currency code.

dataonDemandepisodesrentprices[]amount
numbernullable

Price in that currency.

dataonDemandepisodesrenturl
stringnullable

Store or title URL.

dataonDemandepisodesrentperiod
stringnullable

Rental period, e.g. `24 hour`.

A rent, buy or subscription option.

dataonDemandepisodesbuyactive
booleannullable

Whether the option is offered.

Prices Vimeo lists, one entry per currency.

dataonDemandepisodesbuyprices[]currency
string

Three-letter currency code.

dataonDemandepisodesbuyprices[]amount
numbernullable

Price in that currency.

dataonDemandepisodesbuyurl
stringnullable

Store or title URL.

dataonDemandepisodesbuyperiod
stringnullable

Rental period, e.g. `24 hour`.

A Vimeo user. List rows carry only the fields that list provides; the rest are null.

dataonDemandownerid
integer

Vimeo user id.

≥ 0

dataonDemandownername
stringnullable

Display name.

dataonDemandownerhandle
stringnullable

Vanity handle, or the `user<id>` form.

dataonDemandownerurl
stringnullable

Profile page URL.

dataonDemandownerbio
stringnullable

Biography; null when the list row does not include it.

dataonDemandownershortBio
stringnullable

Short biography; null when the list row does not include it.

dataonDemandownerlocation
stringnullable

Location the user set; null when the list row does not include it.

dataonDemandownerwebsite
stringnullable

Website the user lists; null when the list row does not include it.

Links the user lists, when available.

dataonDemandownerlinks[]name
stringnullable

Link label.

dataonDemandownerlinks[]url
string

Link URL.

dataonDemandownerlinks[]type
stringnullable

Link type, as Vimeo labels it.

dataonDemandownerverified
booleannullable

Whether the user is verified; null when the list row does not include it.

dataonDemandownerhasPublicVideos
booleannullable

Whether the profile says the user has public videos; null on list rows that do not include it.

dataonDemandownercreatedAt
stringnullable

When the account was created, in UTC.

Account flags.

dataonDemandowneraccountplus
booleannullable

Whether the account is Plus; null on list rows that do not include account flags.

dataonDemandowneraccountpro
booleannullable

Whether the account is Pro; null on list rows that do not include account flags.

dataonDemandowneraccounttype
stringnullable

Membership type, when known.

Counts for the user.

dataonDemandownercountsvideos
integernullable

Videos uploaded.

≥ 0

dataonDemandownercountsvideosOnProfile
integernullable

Videos the profile lists; it can differ from `videos`, and is null on list rows that do not include it.

≥ 0

dataonDemandownercountsappearances
integernullable

Videos the user appears in.

≥ 0

dataonDemandownercountslikes
integernullable

Videos the user liked.

≥ 0

dataonDemandownercountscontacts
integernullable

Contacts; null on list rows that do not include them.

≥ 0

dataonDemandownercountsshowcases
integernullable

Showcases (albums).

≥ 0

dataonDemandownercountschannels
integernullable

Channels.

≥ 0

dataonDemandownercountsgroups
integernullable

Groups.

≥ 0

dataonDemandownercountsfollowers
integernullable

Followers.

≥ 0

dataonDemandownercountsfollowing
integernullable

Accounts the user follows.

≥ 0

dataonDemandownercountsportfolios
integernullable

Portfolios.

≥ 0

Profile pictures in the sizes Vimeo offers.

dataonDemandowneravatarsmall
stringnullable

Square avatar, 30 pixels.

dataonDemandowneravatarmedium
stringnullable

Square avatar, 75 pixels.

dataonDemandowneravatarlarge
stringnullable

Square avatar, 100 pixels.

dataonDemandowneravatarhuge
stringnullable

Square avatar, 300 pixels.

dataonDemandowneravatarbase
stringnullable

The avatar without a size suffix.

dataonDemandowneravatarportrait360
stringnullable

Profile-page portrait, 360 pixels.

Optional public profile fields. `available` is null when they are not included and false when they are unavailable. List rows that do not carry profile data leave these fields null.

dataonDemandownerprofileavailable
booleannullable

Whether the optional profile fields were available; null when they are not included, as on list rows.

dataonDemandownerprofileisPrivate
booleannullable

Whether the user hides their profile.

dataonDemandownerprofileupdatedAt
stringnullable

When the profile was last changed.

Public links the profile lists.

dataonDemandownerprofilesocialLinks[]
stringoptional
dataonDemandownerprofileportraitLarge
stringnullable

Profile-page portrait, 360 pixels.

The film or trailer behind an On Demand title.

dataonDemandfilmid
integernullable

Video id.

≥ 0

dataonDemandfilmname
stringnullable

Title.

dataonDemandfilmdescription
stringnullable

Description.

dataonDemandfilmurl
stringnullable

Public video URL.

dataonDemandfilmdurationSeconds
integernullable

Length in seconds.

≥ 0

dataonDemandfilmwidth
integernullable

Width in pixels.

≥ 0

dataonDemandfilmheight
integernullable

Height in pixels.

≥ 0

dataonDemandfilmlanguage
stringnullable

Language code.

The film or trailer behind an On Demand title.

dataonDemandtrailerid
integernullable

Video id.

≥ 0

dataonDemandtrailername
stringnullable

Title.

dataonDemandtrailerdescription
stringnullable

Description.

dataonDemandtrailerurl
stringnullable

Public video URL.

dataonDemandtrailerdurationSeconds
integernullable

Length in seconds.

≥ 0

dataonDemandtrailerwidth
integernullable

Width in pixels.

≥ 0

dataonDemandtrailerheight
integernullable

Height in pixels.

≥ 0

dataonDemandtrailerlanguage
stringnullable

Language code.

Counts shown on the title page.

dataonDemandcountsvideos
integernullable

Videos on the title page.

≥ 0

dataonDemandcountsgenres
integernullable

Genres.

≥ 0

dataonDemandcountslikes
integernullable

Likes.

≥ 0

dataonDemandcountscomments
integernullable

Comments.

≥ 0

dataonDemandcountsseasons
integernullable

Seasons.

≥ 0

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/vimeo/ondemand/pariah" \
  -H "x-api-key: YOUR_API_KEY"

Responses

A Vimeo On Demand title.