GET statuses/oembed¶
Returns a single Tweet, specified by either a Tweet web URL or the Tweet ID, in an oEmbed-compatible format. The returned HTML snippet will be automatically recognized as an Embedded Tweet when Twitter’s widget JavaScript is included on the page.
The oEmbed endpoint allows customization of the final appearance of an Embedded Tweet by setting the corresponding properties in HTML markup to be interpreted by Twitter’s JavaScript bundled with the HTML response by default. The format of the returned markup may change over time as Twitter adds new features or adjusts its Tweet representation.
The Tweet fallback markup is meant to be cached on your servers for up to the suggested cache lifetime specified in the cache_age
.
Resource URL¶
https://publish.twitter.com/oembed
Resource Information¶
Response formats | JSON |
Requires authentication? | No |
Rate limited? | No |
Parameters¶
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
url | required | The URL of the Tweet to be embedded | https%3A%2F%2Ftwitter.com%Interior%2Fstatus%2F507185938620219395 |
|
maxwidth | optional | The maximum width of a rendered Tweet in whole pixels. This value must be
between 220 and 550 inclusive. A supplied value under or over the allowed
range will be returned as the minimum or maximum supported width respectively;
the reset width value will be reflected in the returned width property. Note
that Twitter does not support the oEmbed maxheight parameter. Tweets are
fundamentally text, and are therefore of unpredictable height that cannot be
scaled like an image or video. Relatedly, the oEmbed response will not provide a
value for height . Implementations that need consistent heights for Tweets
should refer to the hide_thread and hide_media parameters below |
325 |
|
hide_media | optional | When set to true , t , or 1 links in a Tweet are not expanded to
photo, video, or link previews |
false |
true |
hide_thread | optional | When set to true , t , or 1 a collapsed version of the previous Tweet
in a conversation thread will not be displayed when the requested Tweet is
in reply to another Tweet |
false |
true |
omit_script | optional | When set to true , t , or 1 the <script> responsible for loading
widgets.js will not be returned. Your webpages should include their own
reference to widgets.js for use across all Twitter widgets including
Embedded Tweets |
false |
true |
align | optional | Specifies whether the embedded Tweet should be floated left, right, or center in
the page relative to the parent element. Valid values are left , right ,
center , and none |
none |
right |
related | optional | A comma-separated list of Twitter usernames related to your content. This value will be forwarded to Tweet action intents if a viewer chooses to reply, like, or retweet the embedded Tweet | twitterapi,twitter |
|
lang | optional | Request returned HTML and a rendered Tweet in the specified Twitter language supported by embedded Tweets | en |
fr |
theme | optional | When set to dark , the Tweet is displayed with light text over
a dark background |
light |
dark |
link_color | optional | Adjust the color of Tweet text links with a hexadecimal color value | %2355acee |
|
widget_type | optional | Set to video to return a Twitter Video embed for the given Tweet |
video |
Example Request¶
GET https://publish.twitter.com/oembed?url=https%3A%2F%2Ftwitter.com%2FInterior%2Fstatus%2F507185938620219395
Example Response¶
{
"url": "https://twitter.com/Interior/status/507185938620219395",
"author_name": "US Dept of Interior",
"author_url": "https://twitter.com/Interior",
"html": "<blockquote class=\"twitter-tweet\"><p lang=\"en\" dir=\"ltr\">Happy 50th anniversary to the Wilderness Act! Here's a great wilderness photo from <a href=\"https://twitter.com/YosemiteNPS\">@YosemiteNPS</a>. <a href=\"https://twitter.com/hashtag/Wilderness50?src=hash\">#Wilderness50</a> <a href=\"http://t.co/HMhbyTg18X\">pic.twitter.com/HMhbyTg18X</a></p>— US Dept of Interior (@Interior) <a href=\"https://twitter.com/Interior/status/507185938620219395\">September 3, 2014</a></blockquote>\n<script async src=\"//platform.twitter.com/widgets.js\" charset=\"utf-8\"></script>",
"width": 550,
"height": null,
"type": "rich",
"cache_age": "3153600000",
"provider_name": "Twitter",
"provider_url": "https://twitter.com",
"version": "1.0"
}