Giter VIP home page Giter VIP logo

amazonmonitor's Introduction

TODO

Description

AmazonMonitor is a self-hosted Discord bot designed for notifying you, or other people, about price drops and restocks on Amazon. It supports setting price limits, watching items from other countries, watching entire search queries and categories, and more.

FAQ (please read this before creating an issue. Thanks!)

Jump to:

Requirements

Configuration

The project comes with an example configuration you can use as a base. To begin configuring the bot:

  1. Copy the config.example.json file.
  2. Rename it to config.json.
  3. Begin editing in your favorite text editor.

It may be hard to know exactly what each option does, and what you can set them to, so they are all outlined below.

prefix

This is the character, or characters, that you will begin every command with. Good examples are $ or !.

token

The token is the login information of the bot. If you don't know how to set up a bot user, refer to this guide.

minutes_per_check

The amount of minutes before each check cycle is run. A good number is around 2 or 3.

search_response_ms

Introduced in !65

Amount of time to pass before the response window expires when running the search command.

url_params

If you want to include a referral code or something, you can use this option to add as many as you want. You'll notice the curly braces; inside of those is where you add each parameter. An example would be something like this:

"url_params":{
  "ref":"my_ref_code",
  "tag":"my_tag"
  etc...
 }

which would produce a link that looks like this:

https://www.amazon.com/dp/B08L5R1CCC/?ref=my_ref_code&tag=my_tag

guild_item_limit

The guild item limit is used to control how many items the bot can keep track of at a time. It's hard to judge what a reasonable number is, so just keep it as low as you can.

cache_limit

A newer addition, the cache limit is the amount of items that will be watched in a category or search query.

required_perms

These are individual permissions, not roles, that a user must have in order to run any of the commands. You can find a reference here.

tld

A TLD, or Top-Level Domain, is the little .com or .ca of a URL. Each regional Amazon site is given a different TLD, so you can set this to your favorite country's TLD and it will grab Amazon results and data from that site. Some examples are:

  • ca - Canada
  • co.uk - UK
  • jp - Japan

* Just as a heads up, if you run the details or watch command on an item listed in a different country, it will not convert it to the correct country.

auto_cart_link

If you're the efficient type, setting this to true will make sure that the links in stock/price notifications will bring you to a page that will automatically add the item to your cart.

debug_enabled

If set to true, the console window will spit out all kinds of information related to what it's doing, in order to give you a better understanding of what's going on in case you're having trouble.

Proxies

To make use of your fancy-dancey proxylist, you simply need to create a file named proxylist.txt in the main bot folder. Each ip/url should be separated by a new line. Each one should be formatted like so: http://username:password@ip:port. An example of some are listed below in the same format yours should be listed:

http://myuser:[email protected]:12345
http://spikehd:[email protected]:8008
http://amazonuser:[email protected]:2318008
etc...

Starting

To start the bot, simply open a terminal and run these commands:

  • Set directory to bot directory:
    cd "C:/Path/To/Bot/Folder"
  • Install the dependancies (you only have to do this once):
    npm install
  • Run the main file:
    node index

To restart the bot after a config change:

  • Press Ctrl+C
  • Start it the same as before:
    node index

Commands

Like explained before, commands can only be run with users that have the permissions in the required_perms section of the config.

help

  • Format: help
  • Example: !help

This will give you some details on each command.

search

  • Format: search [query]
  • Example: !search nintendo+switch

Allows you to search for items matching a query, just like on the website. Additional actions are available once the list of items is returned, but you can refer to the information there.

details

  • Format: details [Amazon link]
  • Example: !details https://www.amazon.com/Beats-Studio3-Wireless-Headphones-Collection/dp/B07HYD4VCW/

Spits out details on an item from Amazon. Useful in conjunction with search.

watch

  • Format: watch -l [Amazon link] OR watch -c [Amazon category] OR watch -q [search query]. Include -p for a price limit, eg. watch -q toothbrush -p 100.
  • Examples:
    • !watch -l https://www.amazon.it/dp/B08C76W2WM/
    • !watch -c https://www.amazon.ca/b/?_encoding=UTF8&node=677244011
    • !watch -q iphone+12

Adds an item, category, or search query to the watchlist.

watchlist

  • Format: watchlist
  • Example: !watchlist

View your watchlist as a numbered list. Useful for unwatch.

unwatch

  • Format: unwatch [item position in watchlist]
  • Example: !unwatch 2

Remove an item from your watchlist.

Contributing

Wanna add stuff? Sweet! Issues, PRs, etc. are all welcome!

amazonmonitor's People

Contributors

spikehd avatar iagopm avatar dependabot[bot] avatar marvinyan avatar kai101 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.