NFT Listing Monitor Bot

NFT listing monitor bot of the marketplace.

Market Coverage

• Opensea

• Looksrare

• X2Y2

Prerequisites

• Install Node.js version 16
  • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
• Opensea API Key - apply here
• X2Y2 API Key - apply here
• Etherscan API Key - apply here

Notify Method

• Twitter

• Discord

Notification is optional. You can turn it on in the ./.env file.

For example:

TWITTER_ENABLED=1
DISCORD_ENABLED=1

Twitter Guide

1. Register Twitter developer account with Elevated access. 🔗 Link

2. Create a development app with OAuth 1.0a read-write permissions. 🔗 Link

3. Install Twurl and run following command:

   twurl authorize --consumer-key <your-app-key> --consumer-secret <your-app-secret>
   

   This will return an URL that you should open up in your browser. Authenticate to Twitter, and then enter the returned PIN back into the terminal.

   This should create a file called .twurlrc in your home directory with all the necessary information.

Discord Guide

1. Open the Discord channel you want to receive sales event notifications.
2. From the channel menu, select Edit channel.
3. Select Integrations.
4. Select Create Webhook.
5. Enter the name of the bot that will post the message.
6. Copy the URL from the WEBHOOK URL field.
7. Click Save.

Configuration

Create an .env file in the root directory of the project with the following contents:

COLLECTION_SLUG=
CONTRACT_ADDRESS=
X2Y2_API_KEY=
OPENSEA_API_KEY=
ETHERSCAN_API_KEY=
TWITTER_API_KEY=
TWITTER_API_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_SECRET=
WEBHOOK_URL=
DISCORD_ENABLED=
TWITTER_ENABLED=

Do not commit/include your .env file in your repository.

To find the collection slug, visit the collection page on Opensea. You will see the collection slug in the URL.

https://opensea.io/collection/<collection-slug>

Installation

npm install

Usage

Run the following command to start the bot:

node app.js

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

LICENSE

This project is MIT licensed.