Twitter¶

Configuration¶

TWITTER_API¶

Optional, defaults to web

API to use, web or syndication. Web API comes from web page, while Syndication API comes from https://publish.twitter.com.

Tweets marked as sensitive cannot be fetched through Syndication API, but can be fetched through Web API if TWITTER_AUTH_TOKEN is set.

When Web API is unavailable, you may switch to Syndication API.

Added in v2.4.0

TWITTER_AUTH_TOKEN¶

Optional, required to fetch tweets marked as sensitive

Authorization token for Web API.

To get one, follow these steps:

Open https://twitter.com/ in your browser
Open Developer Tools (F12)
Navigate to Application tab
Expand Cookies section in the sidebar and click https://twitter.com
Copy the value of auth_token cookie

Added in v2.4.0

Customizing Storage Path & File Name¶

For more information, refer to Customizing Storage Path & File Name.

TWITTER_FILE_PATH¶

Optional, defaults to Twitter

Storage path for downloaded images or videos.

TWITTER_FILE_NAME¶

Optional, defaults to {id_str}_{index} - {user[name]}({user[id_str]})

File name for downloaded images or videos.

Available Variables¶

Only common used ones are listed.

{
  "lang": "Tweet language, e.g. ja",
  "favorite_count": 4814,
  "possibly_sensitive": false,
  "created_at": "Creation date",
  "id_str": "Tweet ID",
  "user": {
    "id_str": "User ID",
    "name": "User name",
    "screen_name": "User handle"
  },
  "photos": [
    {
      "width": "Width",
      "height": "Height"
    }
  ],
  "filename": "Original filename in twimg.com URL, without extension",
  "index": "Photo or video index in a tweet"
}

Last update: August 7, 2023
Created: June 8, 2023