Metadata

​

Quick Start

​

Request

import { Supadata } from '@supadata/js';

const supadata = new Supadata({
  apiKey: 'YOUR_API_KEY',
});

const metadata = await supadata.metadata({
  url: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
});

console.log(metadata)

from supadata import Supadata

supadata = Supadata(api_key="YOUR_API_KEY")

metadata = supadata.metadata(
    url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"
)

print(metadata)

curl -X GET "https://api.supadata.ai/v1/metadata?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​

Response

{
  "platform": "youtube",
  "type": "video",
  "id": "dQw4w9WgXcQ",
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  "title": "Rick Astley - Never Gonna Give You Up",
  "description": "The official video for \"Never Gonna Give You Up\"...",
  "author": {
    "displayName": "Rick Astley",
    "avatarUrl": "https://yt3.ggpht.com/..."
  },
  "stats": {
    "views": 1234567890,
    "likes": 12345678,
    "comments": 200000,
    "shares": null
  },
  "media": {
    "type": "video",
    "duration": 213,
    "thumbnailUrl": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg"
  },
  "tags": ["Rick Astley", "Never Gonna Give You Up", "Official Video"],
  "createdAt": "2009-10-25T00:00:00Z",
  "additionalData": {
    "channelId": "UCuAXFkgsw1L7xaCfnd5JJOw"
  }
}

​

Specification

​

Endpoint

​

Query Parameters

​

Response Format

{
  "platform": "youtube" | "tiktok" | "instagram" | "twitter" | "facebook",
  "type": "video" | "image" | "carousel" | "post",
  "id": string,
  "url": string,
  "title": string | null,
  "description": string | null,
  "author": {
    "username": string,
    "displayName": string,
    "avatarUrl": string,
    "verified": boolean
  },
  "stats": {
    "views": number | null,
    "likes": number | null,
    "comments": number | null,
    "shares": number | null
  },
  "media": VideoMedia | ImageMedia | CarouselMedia | PostMedia,
  "tags": string[],
  "createdAt": string,
  "additionalData": object  // Platform-specific fields
}

​

Error Codes

​

Supported URL Formats

• https://www.youtube.com/watch?v=dQw4w9WgXcQ
• https://youtu.be/dQw4w9WgXcQ
• https://www.youtube.com/embed/dQw4w9WgXcQ
• https://www.youtube.com/shorts/dQw4w9WgXcQ
• https://www.youtube.com/live/dQw4w9WgXcQ

• https://www.tiktok.com/@username/video/7234567890123456789
• https://vm.tiktok.com/AAAAZZZZZ
• https://m.tiktok.com/v/7234567890123456789

• https://www.instagram.com/reel/C1234567890
• https://www.instagram.com/p/C1234567890
• https://www.instagram.com/tv/C1234567890

• https://twitter.com/username/status/1234567890123456789
• https://x.com/username/status/1234567890123456789

• https://www.facebook.com/reel/682865820350105/
• https://www.facebook.com/groups/123456789012345/permalink/987654321098765/
• https://m.facebook.com/examplepage/posts/123123123123123/
• https://www.facebook.com/share/p/123123123123123/
• Marketplace & Event URLs are not supported yet.

​

Base Schema

• type: Acts as a discriminator that determines the structure of the media field (see Media Types below)
• title and description: May be null for some platforms or content types
• stats: null values indicate the metric is unavailable or not applicable for the platform.
• createdAt: ISO 8601 formatted timestamp
• additionalData: Contains platform-specific fields not included in the base schema

​

Media Types

• Video: duration, thumbnailUrl
• Image: url
• Carousel: items (array of video/image objects)
• Post: no additional fields

​

Platform-Specific Fields

• Channel information for YouTube
• Music/sound information for TikTok
• Retweet/quote information for X (Twitter)

​

Pricing