---
canonical_url: "https://docs.composio.dev/toolkits/twittershots"
markdown_url: "https://docs.composio.dev/toolkits/twittershots.md"
product: "platform"
version: null
last_updated: null
---

# TwitterShots

TwitterShots renders public X posts as screenshots and retrieves tweet content and API usage.

- **Category:** images & design
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `TWITTERSHOTS`
- **Version:** 00000000_00

## Tools

### Generate Temporary Screenshot URL

**Slug:** `TWITTERSHOTS_GENERATE_TEMPORARY_SCREENSHOT_URL`

Render a public tweet or post and return a provider-hosted temporary URL. Download the result promptly or use Generate Tweet Screenshot when it must be retained. A successful render consumes one API credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string ("x" | "bluebird" | "none") | No | Logo displayed on the rendered post. |
| `theme` | string ("light" | "dark") | No | Light or dark tweet color theme. |
| `width` | integer | No | Tweet content-area width in pixels (300-1000). |
| `format` | string ("svg" | "png" | "html") | No | Hosted render format. SVG is verified; PNG and HTML are documented but unverified. |
| `height` | string | No | Tweet content-area height in pixels, or 'auto' to fit the content. |
| `tweet_id` | string | Yes | Numeric tweet/status ID or full public tweet/post status URL. |
| `show_media` | boolean | No | Render attached images and videos. |
| `show_stats` | boolean | No | Show reply, repost, and like counts. |
| `show_views` | boolean | No | Show the view count. |
| `aspect_ratio` | string ("auto" | "1:1" | "4:5" | "5:4" | "16:9" | "9:16") | No | Output canvas aspect ratio. |
| `media_layout` | string ("grid" | "vertical") | No | Layout for attached media. |
| `border_radius` | number | No | Container border radius in pixels. |
| `show_full_text` | boolean | No | Show the full post instead of a collapsed 'Show more' state. |
| `show_timestamp` | boolean | No | Show the post timestamp. |
| `background_image` | string | No | Optional HTTPS URL of a background image. |
| `time_zone_offset` | string | No | Fixed UTC offset for the timestamp, such as UTC-5, UTC+8, or UTC+5:30. |
| `container_padding` | number | No | Container padding in pixels. |
| `container_background` | string | No | Optional container background as a hex color, rgba() color, or linear-gradient() value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Tweet Screenshot

**Slug:** `TWITTERSHOTS_GENERATE_TWEET_SCREENSHOT`

Render a public tweet or post as an SVG, PNG, or HTML file suitable for saving. A successful render consumes one API credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string ("x" | "bluebird" | "none") | No | Logo displayed on the rendered post. |
| `theme` | string ("light" | "dark") | No | Light or dark tweet color theme. |
| `width` | integer | No | Tweet content-area width in pixels (300-1000). |
| `format` | string ("svg" | "png" | "html") | No | File format for the rendered output. SVG is live-verified; PNG and HTML are documented. |
| `height` | string | No | Tweet content-area height in pixels, or 'auto' to fit the content. |
| `tweet_id` | string | Yes | Numeric tweet/status ID or full public tweet/post status URL. |
| `show_media` | boolean | No | Render attached images and videos. |
| `show_stats` | boolean | No | Show reply, repost, and like counts. |
| `show_views` | boolean | No | Show the view count. |
| `aspect_ratio` | string ("auto" | "1:1" | "4:5" | "5:4" | "16:9" | "9:16") | No | Output canvas aspect ratio. |
| `media_layout` | string ("grid" | "vertical") | No | Layout for attached media. |
| `border_radius` | number | No | Container border radius in pixels. |
| `show_full_text` | boolean | No | Show the full post instead of a collapsed 'Show more' state. |
| `show_timestamp` | boolean | No | Show the post timestamp. |
| `background_image` | string | No | Optional HTTPS URL of a background image. |
| `time_zone_offset` | string | No | Fixed UTC offset for the timestamp, such as UTC-5, UTC+8, or UTC+5:30. |
| `container_padding` | number | No | Container padding in pixels. |
| `container_background` | string | No | Optional container background as a hex color, rgba() color, or linear-gradient() value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Usage

**Slug:** `TWITTERSHOTS_GET_API_USAGE`

Return the remaining and total TwitterShots API credits for the connected API key. This read does not consume a credit.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Tweet Content

**Slug:** `TWITTERSHOTS_GET_BULK_TWEET_CONTENT`

Fetch up to 100 public tweets as one Markdown document. Inspect the returned Markdown for a 'Failed to fetch tweets' section because individual IDs can fail within an HTTP 200 response. A successful bulk request consumes one API credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tweet_ids` | array | Yes | Numeric IDs of 1-100 public tweets to fetch in one request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tweet Content

**Slug:** `TWITTERSHOTS_GET_TWEET_CONTENT`

Fetch one public tweet as structured Markdown, with optional statistics, media links, and quoted-tweet content. A successful call consumes one API credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tweet_id` | string | Yes | Numeric ID of the public tweet to fetch. |
| `include_media` | boolean | No | Include image and video URLs in the Markdown. |
| `include_stats` | boolean | No | Include reply, repost, like, and view counts in the Markdown. |
| `include_quoted` | boolean | No | Include quoted-tweet content when present. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |