Prospect demo — Supadata (unofficial)
GET/metadata

Get metadata for internet media

Retrieves unified metadata for media hosted on supported internet platforms. Provide url as a URI for media such as YouTube videos, TikTok videos, Instagram posts, Twitter/X posts, or Facebook videos. The response includes platform and media identifiers, with available details about the author, media, and engagement.

1 parameter
urlstringrequired
URL to supported internet media, including YouTube, TikTok, Instagram, Twitter/X, and Facebook media. Must be a URI.

6 status codes
200Returns metadata including the platform, media type, and unique media identifier. May also include the canonical URL, title, description, author, engagement statistics, media-specific data, tags, creation time, and platform-specific data.
platformstringrequired
Platform where the media is hosted
Allowed:youtubetiktokinstagramtwitterfacebook
typeobjectrequired
idstringrequired
Unique media identifier from the platform
urlstringoptional
Canonical URL to the media
titlestringoptional
Media title
descriptionstringoptional
Media description or caption
authorobjectoptional
Author/creator information
statsobjectoptional
Engagement statistics. null values indicate the metric is unavailable or not applicable for the platform.
mediaobjectoptional
Media-specific data, discriminated by type field (video, image, carousel, or post)
tagsarray<string>optional
Tags, hashtags, or keywords associated with the media
createdAtstringoptional
Creation/publish timestamp (ISO 8601 format)
additionalDataobjectoptional
Platform-specific additional data
400Returned when the request is invalid.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
401Returned when the request is unauthorized.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
404Returned when the requested media is not found.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
429Returned when the request limit is exceeded.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
500Returned when an internal error occurs.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation

Error handling

A 400 indicates an invalid request, a 401 an unauthorized request, a 404 a missing resource, a 429 that the request limit was exceeded, and a 500 an internal error. The url query parameter must be a URI for supported media.