FixTweet

https://docs.fxtwitter.com/en/latest/
Admin
FixTweet enhances Twitter embeds on platforms like Discord and Telegram by enabling proper display...
Tokens:4,110
Snippets:20
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Node.js Dependencies

Source: https://docs.fxtwitter.com/en/latest/deploy/index

Installs all necessary Node.js packages required for the FixTweet project. This command should be run in the root directory of the cloned repository.

```bash
npm install
```

--------------------------------

### Fetch User Data from FixTweet API

Source: https://docs.fxtwitter.com/en/latest/api/user

This snippet demonstrates how to fetch user data using the FixTweet API. It makes a GET request to a specified user endpoint and expects a JSON response.

```HTTP
GET https://api.fxtwitter.com/:screen_name

Response:
{
    "code": 200,
    "message": "OK",
    "user": {
        "url": "https://twitter.com/Twitter",
        "id": "783214",
        "followers": 65704781,
        "following": 0,
        "likes": 6130,
        "tweets": 15051,
        "name": "Twitter",
        "screen_name": "Twitter",
        "description": "What's happening?!",
        "location": "everywhere",
        "avatar_url": "https://pbs.twimg.com/profile_images/1488548719062654976/u6qfBBkF_normal.jpg",
        "joined": "Tue Feb 20 14:35:54 +0000 2007",
        "birthday": {
            "day": 21,
            "month": 3
        }
    }
}

Error Responses:
404 (message `NOT_FOUND`)
500 (message `API_FAIL`)
```

--------------------------------

### Fetch Tweet Status Data using FixTweet API

Source: https://docs.fxtwitter.com/en/latest/api/status

This example demonstrates how to fetch tweet status data using the FixTweet API. It shows a typical request URL structure and the expected JSON response for a successful query. The API returns detailed information about a tweet, its author, and media.

```json
{
    "code": 200,
    "message": "OK",
    "tweet": {
        "url": "https://twitter.com/Twitter/status/1580661436132757506",
        "id": "1580661436132757506",
        "text": "a hit Tweet",
        "author": {
            "id": "783214",
            "name": "Twitter",
            "screen_name": "Twitter",
            "avatar_url": "https://pbs.twimg.com/profile_images/1488548719062654976/u6qfBBkF_200x200.jpg",
            "avatar_color": "#10A3FF",
            "banner_url": "https://pbs.twimg.com/profile_banners/783214/1646075315"
        },
        "replies": 4675,
        "retweets": 2422,
        "likes": 43852,
        "color": "#717577",
        "twitter_card": "summary_large_image",
        "created_at": "Thu Oct 13 20:47:08 +0000 2022",
        "created_timestamp": 1665694028,
        "possibly_sensitive": false,
        "views": null,
        "lang": "en",
        "replying_to": null,
        "replying_to_status": null,
        "media": {
            "photos": [
                {
                    "type": "photo",
                    "url": "https://pbs.twimg.com/media/Fe-jMcGWQAAFWoG.jpg",
                    "width": 118,
                    "height": 122,
                    "altText": "a heart that represents the Twitter like button with ten likes"
                }
            ]
        },
        "source": "Twitter for iPhone"
    }
}
```

--------------------------------

### Publish Cloudflare Worker

Source: https://docs.fxtwitter.com/en/latest/deploy/index

Publishes your FixTweet worker to Cloudflare. This command deploys your application to the cloud.

```bash
npx wrangler publish
```

```bash
npm run publish
```

--------------------------------

### Cloudflare Worker Authentication

Source: https://docs.fxtwitter.com/en/latest/deploy/index

Logs you into your Cloudflare account to manage workers. This is a prerequisite for publishing your worker.

```bash
npx wrangler login
```

--------------------------------

### Debugging with Cloudflare Workers (wrangler tail)

Source: https://docs.fxtwitter.com/en/latest/user/why

This command is used for real-time terminal logging with Cloudflare Workers, essential for debugging and servicing by the developer. It is temporary and never saved or used for other purposes, ensuring privacy.

```bash
wrangler tail
```

--------------------------------

### APIVideo Schema

Source: https://docs.fxtwitter.com/en/latest/api/status

Defines the structure for a Tweet's video or GIF, including its URL, thumbnail, dimensions, and format.

```JSON
{
  "type": "video" | "gif",
  "url": "string",
  "thumbnail_url": "string",
  "width": "number",
  "height": "number",
  "format": "string"
}
```

--------------------------------

### APIMosaicPhoto Schema

Source: https://docs.fxtwitter.com/en/latest/api/status

Represents data for the mosaic service, which stitches photos together, providing dimensions and format URLs.

```JSON
{
  "type": "mosaic_photo",
  "width": "number",
  "height": "number",
  "formats": {
    "webp": "string",
    "jpeg": "string"
  }
}
```

--------------------------------

### User Fetch API

Source: https://docs.fxtwitter.com/en/latest/api/user

Fetches detailed information about a specific Twitter user based on their screen name.

```APIDOC
## GET /websites/fxtwitter_en/:screen_name

### Description
This endpoint retrieves detailed user information for a given Twitter screen name. It returns a JSON object containing various user attributes such as ID, name, follower count, tweet count, profile description, and more. The API can return success codes (200) or error codes (404, 500) with corresponding messages.

### Method
GET

### Endpoint
`https://api.fxtwitter.com/:screen_name`

### Parameters
#### Path Parameters
- **screen_name** (string) - Required - The screen name (@ handle) of the user whose data is to be fetched.

### Request Example
```json
{
  "example": "GET https://api.fxtwitter.com/Twitter"
}
```

### Response
#### Success Response (200)
- **code** (number) - The HTTP status code, 200 for success.
- **message** (string) - A message indicating the status, e.g., "OK".
- **user** (object) - An object containing user details. See `APIUser` for structure.

#### Response Example
```json
{
    "code": 200,
    "message": "OK",
    "user": {
        "url": "https://twitter.com/Twitter",
        "id": "783214",
        "followers": 65704781,
        "following": 0,
        "likes": 6130,
        "tweets": 15051,
        "name": "Twitter",
        "screen_name": "Twitter",
        "description": "What's happening?!",
        "location": "everywhere",
        "avatar_url": "https://pbs.twimg.com/profile_images/1488548719062654976/u6qfBBkF_normal.jpg",
        "joined": "Tue Feb 20 14:35:54 +0000 2007",
        "birthday": {
            "day": 21,
            "month": 3
        }
    }
}
```

#### Error Response (404)
- **code** (number) - The HTTP status code, 404 for not found.
- **message** (string) - A message indicating the error, e.g., "NOT_FOUND".

#### Error Response (500)
- **code** (number) - The HTTP status code, 500 for server error.
- **message** (string) - A message indicating the error, e.g., "API_FAIL".

### APIUser Object Structure
- **id** (string) - User ID.
- **name** (string) - Name of the user.
- **screen_name** (string) - Screen name or @ handle.
- **avatar_url?** (string) - URL for the user’s avatar.
- **banner_url?** (string) - URL for the user's banner.
- **description** (string) - User’s profile description.
- **location** (string) - User’s location.
- **url** (string) - URL provided in the user’s profile.
- **protected** (boolean) - Indicates if the user’s tweets are protected.
- **followers** (number) - Number of followers.
- **following** (number) - Number of users this user is following.
- **tweets** (number) - Number of tweets issued by the user.
- **likes** (number) - Number of tweets this user has liked.
- **joined** (string) - The date when the user joined Twitter.
- **birthday** (object) - User’s birthday. May include `day`, `month`, and `year` (optional).
```

--------------------------------

### Video Data Structure

Source: https://docs.fxtwitter.com/en/latest/api/status

Describes the data structure for a Tweet's video.

```APIDOC
## APIVideo

### Description
Data for a Tweet’s video

### Fields
- **type** (string) - Returns video if video, or gif if gif. Note that on Twitter, all GIFs are MP4s. Possible values: 'video' | 'gif'.
- **url** (string) - URL corresponding to the video file
- **thumbnail_url** (string) - URL corresponding to the thumbnail for the video
- **width** (number) - Width of the video, in pixels
- **height** (number) - Height of the video, in pixels
- **format** (string) - Video format, usually `video/mp4`
```

--------------------------------

### Mosaic Photo Data Structure

Source: https://docs.fxtwitter.com/en/latest/api/status

Details the data structure for the mosaic service, which stitches photos together.

```APIDOC
## APIMosaicPhoto

### Description
Data for the mosaic service, which stitches photos together

### Fields
- **type** (string) - This can help compare items in a pool of media. Currently 'mosaic_photo'.
- **width** (number) - Width of the photo, in pixels
- **height** (number) - Height of the photo, in pixels
- **formats** (object) - Pool of formats, only jpeg and webp are returned currently
  - **webp** (string) - URL for webp resource
  - **jpeg** (string) - URL for jpeg resource
```

--------------------------------

### APIExternalMedia Schema

Source: https://docs.fxtwitter.com/en/latest/api/status

Defines the structure for external media, specifically video, including its type, URL, and dimensions.

```JSON
{
  "type": "video",
  "url": "string",
  "height": "number",
  "width": "number",
  "duration": "number"
}
```

--------------------------------

### Tweet (Status) Fetch API

Source: https://docs.fxtwitter.com/en/latest/api/status

Fetches detailed information about a specific tweet, including author details, interaction counts, media, and translation options.

```APIDOC
## GET /:screen_name?/status/:id/:translate_to?

### Description
Fetches detailed information about a specific tweet.

### Method
GET

### Endpoint
`https://api.fxtwitter.com/:screen_name?/status/:id/:translate_to?`

### Parameters
#### Path Parameters
- **screen_name** (string) - Optional - The screen name (@ handle) of the tweet's author.
- **id** (string) - Required - The ID of the status (tweet).
- **translate_to** (string) - Optional - A 2-letter ISO language code for translating the tweet's text.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **code** (number) - HTTP status code.
- **message** (string) - Status message.
- **tweet** (object) - Contains detailed tweet information.
  - **url** (string) - Link to the original tweet.
  - **id** (string) - Tweet ID.
  - **text** (string) - The content of the tweet.
  - **author** (object) - Information about the tweet's author.
    - **id** (string) - Author's user ID.
    - **name** (string) - Author's display name.
    - **screen_name** (string) - Author's screen name (@ handle).
    - **avatar_url** (string) - URL of the author's avatar.
    - **avatar_color** (string) - Dominant color of the author's avatar.
    - **banner_url** (string) - URL of the author's profile banner.
  - **replies** (number) - Number of replies to the tweet.
  - **retweets** (number) - Number of retweets.
  - **likes** (number) - Number of likes.
  - **color** (string) - Dominant color from tweet media or author avatar.
  - **twitter_card** (string) - Type of Twitter card.
  - **created_at** (string) - Timestamp of tweet creation (UTC).
  - **created_timestamp** (number) - UNIX timestamp of tweet creation.
  - **possibly_sensitive** (boolean) - Indicates if the tweet is possibly sensitive.
  - **views** (number | null) - View count, null if unavailable.
  - **lang** (string | null) - Detected language of the tweet.
  - **replying_to** (string | null) - Screen name of the user being replied to.
  - **replying_to_status** (string | null) - ID of the tweet being replied to.
  - **media** (object | null) - Media attached to the tweet.
    - **photos** (array) - Array of photo objects.
      - **type** (string) - Type of media.
      - **url** (string) - URL of the photo.
      - **width** (number) - Width of the photo.
      - **height** (number) - Height of the photo.
      - **altText** (string) - Alt text for the photo.
  - **source** (string) - The client used to post the tweet.

#### Error Responses
- **401** (message: `PRIVATE_TWEET`) - The requested tweet is private.
- **404** (message: `NOT_FOUND`) - The requested tweet was not found.
- **500** (message: `API_FAIL`) - An internal API error occurred.

#### Response Example
```json
{
    "code": 200,
    "message": "OK",
    "tweet": {
        "url": "https://twitter.com/Twitter/status/1580661436132757506",
        "id": "1580661436132757506",
        "text": "a hit Tweet",
        "author": {
            "id": "783214",
            "name": "Twitter",
            "screen_name": "Twitter",
            "avatar_url": "https://pbs.twimg.com/profile_images/1488548719062654976/u6qfBBkF_200x200.jpg",
            "avatar_color": "#10A3FF",
            "banner_url": "https://pbs.twimg.com/profile_banners/783214/1646075315"
        },
        "replies": 4675,
        "retweets": 2422,
        "likes": 43852,
        "color": "#717577",
        "twitter_card": "summary_large_image",
        "created_at": "Thu Oct 13 20:47:08 +0000 2022",
        "created_timestamp": 1665694028,
        "possibly_sensitive": false,
        "views": null,
        "lang": "en",
        "replying_to": null,
        "replying_to_status": null,
        "media": {
            "photos": [
                {
                    "type": "photo",
                    "url": "https://pbs.twimg.com/media/Fe-jMcGWQAAFWoG.jpg",
                    "width": 118,
                    "height": 122,
                    "altText": "a heart that represents the Twitter like button with ten likes"
                }
            ]
        },
        "source": "Twitter for iPhone"
    }
}
```
```

--------------------------------

### External Media Data Structure

Source: https://docs.fxtwitter.com/en/latest/api/status

Describes the structure of data for external media, currently focusing on video.

```APIDOC
## APIExternalMedia

### Description
Data for external media, currently only video.

### Fields
- **type** (string) - Embed type, currently always `video`
- **url** (string) - Video URL
- **height** (number) - Video height in pixels
- **width** (number) - Video width in pixels
- **duration** (number) - Video duration in seconds
```

--------------------------------

### APIPhoto Schema

Source: https://docs.fxtwitter.com/en/latest/api/status

Defines the structure for a single photo within a Tweet, including its URL, dimensions, and type.

```JSON
{
  "type": "photo",
  "url": "string",
  "width": "number",
  "height": "number"
}
```

--------------------------------

### Photo Data Structure

Source: https://docs.fxtwitter.com/en/latest/api/status

Describes the data structure for a single photo within a Tweet.

```APIDOC
## APIPhoto

### Description
Data for a single photo in a Tweet

### Fields
- **type** (string) - This can help compare items in a pool of media. Currently 'photo'.
- **url** (string) - URL of the photo
- **width** (number) - Width of the photo, in pixels
- **height** (number) - Height of the photo, in pixels
```

--------------------------------

### Poll Data Structure

Source: https://docs.fxtwitter.com/en/latest/api/status

Details the data structure for a poll on a given Tweet.

```APIDOC
## APIPoll

### Description
Data for a poll on a given Tweet

### Fields
- **choices** (APIPollChoice[]) - Array of the poll choices
- **total_votes** (number) - Total votes in poll
- **ends_at** (string) - Date of which the poll ends
- **time_left_en** (string) - Time remaining counter in English (e.g. **9 hours left**)
```

--------------------------------

### APIPollChoice Schema

Source: https://docs.fxtwitter.com/en/latest/api/status

Details a single choice within a poll, including its label, vote count, and percentage.

```JSON
{
  "label": "string",
  "count": "number",
  "percentage": "number"
}
```

--------------------------------

### APIPoll Schema

Source: https://docs.fxtwitter.com/en/latest/api/status

Represents a poll on a Tweet, detailing its choices, total votes, and end time.

```JSON
{
  "choices": "APIPollChoice"[],
  "total_votes": "number",
  "ends_at": "string",
  "time_left_en": "string"
}
```

--------------------------------

### Poll Choice Data Structure

Source: https://docs.fxtwitter.com/en/latest/api/status

Defines the data structure for a single choice within a poll.

```APIDOC
## APIPollChoice

### Description
Data for a single choice in a poll

### Fields
- **label** (string) - What this choice in the poll is called
- **count** (number) - How many people voted in this poll
- **percentage** (number) - Percentage of total people who voted for this option (0 - 100, rounded to nearest tenth)
```
Tokens:
Raw