InsightSocial API
Vimeo

Vimeo Video Embed API reference

Your first 10 calls are free, no card needed. Pricing and FAQ

Get a free API key
Example request
curl "https://api.insightsocial.app/v1/vimeo/video/embed?video_id=<video_id>" \
  -H "x-api-key: $INSIGHTSOCIAL_API_KEY"
GET
/v1/vimeo/video/embed

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

Beta. The source's own structure under our naming rules (snake_case keys, string ids, ISO times where the source gives a timestamp), not one of the schema-2 entities. Fields may change. See Beta endpoints.

20 credits per call.

x-api-key<token>

Your key from the dashboard. It starts with isk_.

In: header

Query Parameters

video_id*string

Vimeo video id, e.g. 76979871.

max_width?integer

Maximum width of the embed, in pixels.

Range1 <= value <= 4096
max_height?integer

Maximum height of the embed, in pixels.

Range1 <= value <= 4096
width?integer

Fixed width of the embed, in pixels.

Range1 <= value <= 4096
hash?string

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

responsive?boolean

Ask for responsive iframe markup.

autoplay?boolean

Ask for autoplay.

dnt?boolean

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

byline?boolean

Show the uploader byline in the player.

portrait?boolean

Show the uploader portrait in the player.

title?boolean

Show the title in the player.

color?string

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

dry_run?"1"

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.insightsocial.app/v1/vimeo/video/embed?video_id=string"
{  "success": true,  "platform": "string",  "endpoint": "string",  "schema_version": "2",  "pagination": {    "next_cursor": "string",    "has_more": true,    "page_size": 0,    "stopped_at": "since"  },  "unavailable": [    "string"  ],  "credits_used": 0,  "credits_remaining": 0,  "request_id": "string",  "cached": true,  "idempotent_replay": true,  "charge_reason": "string",  "free_call": true,  "data": {    "property1": null,    "property2": null  }}