Vimeo

Get Vimeo embed

Get a Vimeo embed: iframe markup, size, thumbnail and the owner's account type; restricted when embedding is off.

GET/v1/vimeo/videos/{videoId}/embed
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
12
videoIdstringrequiredpath

Vimeo video id, e.g. `76979871`.

pattern: ^[1-9]\d{0,18}$

maxWidthintegeroptionalquery

Maximum width of the embed, in pixels.

≥ 1 · ≤ 4096

maxHeightintegeroptionalquery

Maximum height of the embed, in pixels.

≥ 1 · ≤ 4096

widthintegeroptionalquery

Fixed width of the embed, in pixels.

≥ 1 · ≤ 4096

hashstringoptionalquery

Unlisted-video hash, when the video was shared with one.

pattern: ^[A-Za-z0-9]{4,64}$

responsivebooleanoptionalquery

Ask for responsive iframe markup.

autoplaybooleanoptionalquery

Ask for autoplay.

dntbooleanoptionalquery

Do-not-track, as the embed parameter spells it.

bylinebooleanoptionalquery

Show the uploader byline in the player.

portraitbooleanoptionalquery

Show the uploader portrait in the player.

titlebooleanoptionalquery

Show the title in the player.

colorstringoptionalquery

Player colour as six hex digits, e.g. `00adef`.

pattern: ^[0-9a-fA-F]{6}$

Response fields
21

Endpoint-specific response payload.

datalookupStatus
string

`found` when an embed is available; `restricted` when the owner has embedding switched off; `not_found` when the video is gone.

one of: found, not_found, restricted

datavideoId
integer

Video id.

≥ 0

Embed data; null when the video is not found.

dataembedhtml
stringnullable

Ready-made iframe markup, when embedding is allowed.

dataembedwidth
integernullable

Iframe width.

≥ 0

dataembedheight
integernullable

Iframe height.

≥ 0

dataembedthumbnail
stringnullable

Embed thumbnail URL.

dataembedthumbnailWithPlayButton
stringnullable

Embed thumbnail with a play overlay.

dataembeddomainStatusCode
integernullable

Set to 403 when the video is restricted to other domains.

The author, as the embed record names them.

dataownername
stringnullable

Author name.

dataownerurl
stringnullable

Author profile URL.

dataowneraccountType
stringnullable

`free`, `plus`, `pro`, `business` or `enterprise`.

datatitle
stringnullable

Title the embed record carries.

datadescription
stringnullable

Description the embed record carries.

datauploadedAt
stringnullable

Upload time the embed record carries.

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/videos/76979871/embed" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Vimeo embed.