https://github.com/eigenein/mrktpltsbot

Self-hosted Marktplaats notifications for Telegram
https://github.com/eigenein/mrktpltsbot

crates marktplaats search-bot search-notifications telegram telegram-bot telegram-bots unofficial

Last synced: 26 days ago
JSON representation

Self-hosted Marktplaats notifications for Telegram

• Host: GitHub
• URL: https://github.com/eigenein/mrktpltsbot
• Owner: eigenein
• License: mit
• Created: 2020-08-25T19:53:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-21T00:02:06.000Z (about 2 months ago)
• Last Synced: 2024-12-01T21:11:54.538Z (about 1 month ago)
• Topics: crates, marktplaats, search-bot, search-notifications, telegram, telegram-bot, telegram-bots, unofficial
• Language: Rust
• Homepage:
• Size: 478 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# `mrktpltsbot`

Self-hosted Marktplaats notifications for Telegram

[![Crates.io](https://img.shields.io/crates/v/mrktpltsbot?logo=rust&style=for-the-badge)](https://crates.io/crates/mrktpltsbot)

[![License](https://img.shields.io/crates/l/mrktpltsbot?style=for-the-badge)](LICENSE)

[![Build status](https://img.shields.io/github/actions/workflow/status/eigenein/mrktpltsbot/check.yaml?style=for-the-badge)](https://github.com/eigenein/mrktpltsbot/actions/workflows/check.yaml)

[![Code coverage](https://img.shields.io/codecov/c/github/eigenein/mrktpltsbot?style=for-the-badge)

](https://app.codecov.io/gh/eigenein/mrktpltsbot)

> [!CAUTION]

> This is an **unofficial bot** that **uses unofficial APIs**,

> so you take all the responsibility for any consequences of running the bot,

> for example, account or IP bans.

> [!WARNING]

> The version `2.x` is not well-tested yet.

> [!NOTE]

> I realize the documentation is not complete – this is not a deliberate choice,

> but rather the best I could do given the limited resources.

> I strive to maintain and improve it over time.

## Installation

`mrktpltsbot` is a single binary which can be installed from [crates.io](https://crates.io/crates/mrktpltsbot):

```shell

cargo install mrktpltsbot

```

## Usage

```text

Usage: mrktpltsbot [OPTIONS] --telegram-bot-token 

Options:

      --sentry-dsn   Sentry DSN:  [env: SENTRY_DSN]

      --db                   SQLite database path [env: DB] [default: mrktpltsbot.sqlite3]

  -h, --help                     Print help

  -V, --version                  Print version

Telegram:

      --telegram-bot-token 

          Telegram bot token:  [env: TELEGRAM_BOT_TOKEN]

      --telegram-poll-timeout-secs 

          Timeout for Telegram long polling, in seconds [env: TELEGRAM_POLL_TIMEOUT_SECS] [default: 60]

      --telegram-authorize-chat-id 

          Authorize chat ID to use the bot [env: TELEGRAM_AUTHORIZED_CHAT_IDS]

      --telegram-heartbeat-url 

          Heartbeat URL for the Telegram bot [env: TELEGRAM_HEARTBEAT_URL]

Marktplaats:

      --marktplaats-crawl-interval-secs 

          Crawling interval, in seconds [env: MARKTPLAATS_CRAWL_INTERVAL_SECS] [default: 60]

      --marktplaats-search-limit 

          Limit of Marktplaats search results per query [env: MARKTPLAATS_SEARCH_LIMIT] [default: 30]

      --marktplaats-heartbeat-url 

          Heartbeat URL for the Marktplaats crawler [env: MARKTPLAATS_HEARTBEAT_URL]

```