2024.12.5
Home ▸ Integrations ▸

Reddit

The Reddit sensor integrates data from Reddit to monitor your favorite subreddits.

Setup

To set up this sensor, you will need to generate a client_id and client_secret for the user account you will use to connect. Follow the first steps in this Wiki page.

Important

This integration does not support Reddit’s two-factor authentication. If you use two-factor authentication for your Reddit account, create a separate Reddit account without two-factor authentication for use with Home Assistant.

Configuration

To enable this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
sensor:
  - platform: reddit
    username: !secret reddit_username
    password: !secret reddit_password
    client_id: !secret reddit_client_id
    client_secret: !secret reddit_client_secret
    subreddits:
      - news
      - worldnews

Configuration Variables

Looking for your configuration file?
username string Required

Your Reddit account username.

password string Required

Your Reddit account password.

client_id string Required

Your Reddit account client ID.

client_secret string Required

Your Reddit account client secret

subreddits list Required

List of subreddits you want to get data on.

sort_by string (Optional, default: hot)

Sort reddit posts by new, top, controversial and hot.

Related topics