Skip to content

Latest commit

 

History

History
316 lines (256 loc) · 16.1 KB

README.md

File metadata and controls

316 lines (256 loc) · 16.1 KB
Raw

nvidia-snatcher ci discord

FAQ | Issues | Wiki

nvidia-snatcher

The purpose of this bot is to get an Nvidia card. It tries multiple things to do that.

  • Currently, nvidia-snatcher is not capable of purchasing a card for you
  • Scrapes multiple websites for patterns of being stocked
    • API requests are a work in progress (very soon)
  • Opens browser when stock is available
  • Sends an email to you when stock is avaiable (must have Gmail)
What you may see if you're lucky 
2020-09-18T07:06:28.535Z info :: ✖ [nvidia] nvidia founders edition is still out of stock
2020-09-18T07:06:31.241Z info :: ✖ [nvidia] nvidia founders edition is still out of stock
2020-09-18T07:06:34.212Z info :: ✖ [bestbuy] nvidia founder edition is still out of stock
2020-09-18T07:06:39.878Z info :: ✖ [bandh] gigabyte black is still out of stock
2020-09-18T07:06:43.236Z info :: ✖ [bestbuy] gigabyte black is still out of stock
2020-09-18T07:06:43.318Z info :: ↗ trying stores again
2020-09-18T07:06:43.318Z info :: 🚀🚀🚀 [nvidia] nvidia founders edition IN STOCK 🚀🚀🚀
2020-09-18T07:06:43.318Z info :: https://store.nvidia.com/store/nvidia/en_US/buy/productID.5438481700/clearCart.yes/nextPage.QuickBuyCartPage
Adorama Amazon Amazon (CA) ASUS B&H Best Buy Best Buy (CA) EVGA Micro Center Newegg Newegg (CA) Nvidia Office Depot PNY Zotac
3070 ✔
3080 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
3090 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔

Installation and prerequisites

Linux, macOS, and Windows are all capable operating systems.

You do not need any computer skills, smarts, or anything of that nature. You are very capable as you have made it this far. Some basic understanding how a terminal, git, and or Node.js is a bonus, but that does not limit you to getting nvidia-snatcher running!

Quick overview

Native installation

  • Node.js 14
  • git
  • Clone this project git clone https://github.com/jef/nvidia-snatcher.git
  • Run npm install
  • Copy .env.example to a new file .env and edit the .env file to your liking using your favorite text editor
  • Run npm run start to start

At any point you want the program to stop, use Ctrl + C.

👉 Please visit the wiki if you need more help with installation.

Docker image (To run inside containers)

Available via GitHub Container Registry.

Tag Note
latest Latest stable build
nightly Latest HEAD build, could be unstable

Use docker run --cap-add=SYS_ADMIN -it --rm --env-file ./.env ghcr.io/jef/nvidia-snatcher:nightly to run.

Developer notes

The command npm run start:dev can be used instead of npm run start to automatically restart the project when filesystem changes are detected in the src/ folder or .env file.

Customization

To customize nvidia-snatcher, make a copy of .env-example as .env and make any changes to your liking. All environment variables are optional.

Here is a list of variables that you can use to customize your newly copied .env file:

Environment variable Description Notes
BROWSER_TRUSTED Skip Chromium Sandbox Useful for containerized environments, default: false
COUNTRY Supported country you want to be scraped Currently only used by Nvidia, default: usa
DESKTOP_NOTIFICATIONS Display desktop notifications using node-notifier Default: false
DISCORD_NOTIFY_GROUP Discord group you would like to notify Can be comma separated, use role ID, E.g.: <@2834729847239842>
DISCORD_WEB_HOOK Discord Web Hook URL Can be comma separated, use whole webhook URL
EMAIL_PASSWORD Gmail password See below if you have MFA
EMAIL_TO Destination Email Defaults to username if not set. Can be comma separated
EMAIL_USERNAME Gmail address E.g.: jensen.robbed.us@gmail.com
HEADLESS Puppeteer to run headless or not Debugging related, default: true
IN_STOCK_WAIT_TIME Time to wait between requests to the same link if it has that card in stock In seconds, default: 0
LOG_LEVEL Logging levels Debugging related, default: info
LOW_BANDWIDTH Blocks images/fonts to reduce traffic Disables ad blocker, default: false
MAX_PRICE_SERIES_3070 Maximum price allowed for a match, applies 3070 series cards (does not apply to these sites: Nvidia, Asus, EVGA) Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: 1234 - Cards above 1234 will be skipped.
MAX_PRICE_SERIES_3080 Maximum price allowed for a match, applies 3080 series cards (does not apply to these sites: Nvidia, Asus, EVGA) Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: 1234 - Cards above 1234 will be skipped.
MAX_PRICE_SERIES_3090 Maximum price allowed for a match, applies 3090 series cards (does not apply to these sites: Nvidia, Asus, EVGA) Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: 1234 - Cards above 1234 will be skipped.
MICROCENTER_LOCATION Specific MicroCenter location(s) to search Comma separated, e.g.: marietta,duluth, default: web
NVIDIA_ADD_TO_CART_ATTEMPTS The maximum number of times the nvidia-api add to cart feature will be attempted before failing Default: 10
NVIDIA_SESSION_TTL The time in milliseconds to keep the cart active while using nvidia-api Default: 60000
OPEN_BROWSER Toggle for whether or not the browser should open when item is found Default: true
PAGE_BACKOFF_MIN Minimum backoff time between retrying requests for the same store when a forbidden response is received Default: 10000
PAGE_BACKOFF_MAX Maximum backoff time between retrying requests for the same store when a forbidden response is received Default: 3600000
PAGE_SLEEP_MIN Minimum sleep time between queries of the same product page In milliseconds, default: 5000
PAGE_SLEEP_MAX Maximum sleep time between queries of the same product page In milliseconds, default: 10000
PAGE_TIMEOUT Navigation Timeout in milliseconds 0 for infinite, default: 30000
PHONE_CARRIER Supported carriers for SMS Email configuration required
PHONE_NUMBER 10 digit phone number E.g.: 1234567890, email configuration required
PLAY_SOUND Play this sound notification if a card is found Relative path accepted, valid formats: wav, mp3, flac, E.g.: path/to/notification.wav, free sounds available
PROXY_ADDRESS IP Address or fqdn of proxy server
PROXY_PORT TCP Port number on which the proxy is listening for connections Default: 80
PUSHBULLET PushBullet API key Generate at https://www.pushbullet.com/#settings/account
PUSHOVER_TOKEN Pushover access token Generate at https://pushover.net/apps/build
PUSHOVER_USER Pushover username
PUSHOVER_PRIORITY Pushover message priority
SCREENSHOT Capture screenshot of page if a card is found Default: true
SHOW_ONLY_BRANDS Filter to show specified brands Comma separated, e.g.: evga,zotac
SHOW_ONLY_MODELS Filter to show specified models Comma separated, e.g.: founders edition,rog strix
SHOW_ONLY_SERIES Filter to show specified series Comma separated, e.g.: 3080
SLACK_CHANNEL Slack channel for posting E.g.: update, no need for #
SLACK_TOKEN Slack API token
SMTP_ADDRESS IP Address or fqdn of smtp server
SMTP_PORT TCP Port number on which the smtp server is listening for connections Default: 25
STORES Supported stores you want to be scraped Comma separated, default: nvidia
SCREENSHOT Capture screenshot of page if a card is found Default: true
TELEGRAM_ACCESS_TOKEN Telegram access token
TELEGRAM_CHAT_ID Telegram chat ID
TWILIO_ACCOUNT_SID Twilio Account SID Can be found on twilio.com/console
TWILIO_AUTH_TOKEN Twilio Auth Token Can be found on twilio.com/console
TWILIO_FROM_NUMBER Twilio provided phone number to send messages from Include country code e.g +4401234567890
TWILIO_TO_NUMBER Mobile number to send SMS to Include country code e.g +4401234567890
TWITTER_ACCESS_TOKEN_KEY Twitter Token Key
TWITTER_ACCESS_TOKEN_SECRET Twitter Token Secret
TWITTER_CONSUMER_KEY Twitter Consumer Key Generate all Twitter keys at: https://developer.twitter.com/
TWITTER_CONSUMER_SECRET Twitter Consumer Secret
TWITTER_TWEET_TAGS Optional list of hashtags to append to the tweet message E.g.: #nvidia #nvidiastock
USER_AGENT Custom User-Agent header for HTTP requests Default: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36

👉 If you have multi-factor authentication (MFA), you will need to create an app password and use this instead of your Gmail password.

👉 You can find your computer's user agent by searching google for "my user agent"

👉 You can test your notification configuration by running npm run test:notification.

👉 Data usage is known to be high. This is expected as the program scrapes many websites in parallel 24/7. To help reduce this, use LOW_BANDWIDTH="true". We are looking into other solutions as well, but is low priority.

Supported stores

Stores Environment variable
Adorama adorama
Alternate (DE) alternate
Amazon amazon
Amazon (CA) amazon-ca
Amazon (DE) amazon-de
Amazon (NL) amazon-nl
Amazon (UK) amazon-uk
Aria PC aria
ASUS asus
B&H bandh
Best Buy bestbuy
Best Buy (CA) bestbuy-ca
Box box
Caseking caseking
CCL ccl
Coolblue coolblue
Currys currys
eBuyer ebuyer
EVGA evga
EVGA (EU) evga-eu
Gamestop gamestop
Mediamarkt (DE) mediamarkt
Micro Center microcenter
Newegg newegg
Newegg (CA) newegg-ca
Notebooksbilliger (DE) notebooksbilliger
Novatech novatech
Nvidia nvidia
Nvidia (API) nvidia-api
Office Depot officedepot
Overclockers overclockers
PNY pny
Proshop (DE) proshop-de
Proshop (DK) proshop-dk
Scan scan
Very very
Zotac zotac
Micro Center stores

👉 Before using web, please review this issue comment.

Store name
brooklyn
brentwood
cambridge
chicago
columbus
dallas
denver
duluth
fairfax
flushing
houston
madison-heights
marietta
mayfield-heights
north-jersey
overland-park
parkville
rockville
sharonville
st-davids
st-louis-park
tustin
westbury
westmont
yonkers

Supported Brands and Models

Brand Model
asus rog strix, rog strix oc, strix, tuf, tuf oc
evga ftw3, ftw3 ultra, xc3 black, xc3, xc3 ultra
gigabyte aorus master, eagle, eagle oc, gaming, gaming oc, vision
msi gaming x trio, ventus 3x, ventus 3x oc
nvidia founders edition
pny dual fan, xlr8, xlr8 rgb
zotac trinity, trinity oc

Supported carriers

Carrier Environment variable Notes
AT&T att
AT&T Prepaid attgo
Bell bell
Fido fido
Google google
Koodo koodo
Mint mint
Rogers rogers
Sprint sprint
Telus telus
T-Mobile tmobile
Verizon verizon Works with Visible
Virgin virgin
Virgin (CA) virgin-ca

Supported countries

COUNTRY is only used by the nvidia and nvidia-api stores.

Country 3080 FE 3090 FE Test Card Notes
austria ✔ ✔ ✔
belgium ✔ ✔ ✔
canada ✔ ✔ ✔
czechia ✔ ✔ ✔
denmark ✔ ✔ Missing RTX 3090
finland ✔ ✔ Missing RTX 3090
france ✔ ✔ ✔
germany ✔ ✔ ✔
great_britain ✔ ✔ ✔
ireland ✔ ✔ ✔
italy ✔ ✔ ✔
luxembourg ✔ ✔ ✔
netherlands ✔ ✔ ✔
norway ✔ ✔ ✔
poland ✔ ✔ ✔
portugal ✔ RTX 3080 only
spain ✔ ✔ ✔
sweden ✔ ✔ ✔
usa ✔ ✔ ✔

FAQ

Q: What's Node.js and how do I install it? Visit their website and download and install it. Very straight forward. Otherwise, Google more information related to your system needs.

Q: Will this harm my computer? No.

Q: Have you gotten a card yet? YES! 🎉 🚀

Screenshot

screenshot

Q: Will I get banned from of the stores? Perhaps, but getting a card is a nice outcome.

Q: I got a problem and need help! Join the Discord or file an issue, I'll do my best to get to you. I work a full time job and this is only a hobby of mine.

Q: How do I get the latest code? Take look at this wiki page

Q: Why don't my notifications work? There are probably an issue [that] has already been resolved

Q: I'd love to contribute, how do I do that? Make a pull request! All contributions are welcome.

Q: Why do I have to download all this stuff just to get this bot working? Well, I would rather you didn't either. See #11.

Acknowledgements

Thanks to the great contributors that make this project possible

Special shout to initial developers: