Opensea Scraper

🎉 UPDATE 2021-Nov-3: Opensea officially updated their API. You can get accurate realtime floor prices from this endpoint: https://api.opensea.io/api/v1/collection/{slug}/stats:

1const axios = require("axios");
2
3async function getFloorPrice(slug) {
4  try {
5    const url = `https://api.opensea.io/collection/${slug}/stats`;
6    const response = await axios.get(url);
7    return response.data.stats.floor_price;
8  } catch (err) {
9    console.log(err);
10    return undefined;
11  }
12}
13
14await getFloorPrice("lostpoets");
15await getFloorPrice("treeverse");
16await getFloorPrice("cool-cats-nft");

If you need floor prices, please use the official API (see above 👆👆👆). This scraper still can be used to scrape additional information about offers (tokenId, name, tokenContractAddress and offerUrl) as well as the ranking.

Install

1npm install opensea-scraper

Usage

ℹ slug is the human readable identifier that opensea uses to identify a collection. It can be extracted from the URL: https://opensea.io/collection/{slug}

ℹ options is an object with the following keys

• debug [Boolean] launches chromium locally, omits headless mode (default: false)
• logs [Boolean]: display logs in the console (default: false)
• sort [Boolean]: sorts the offers by lowest to highest (default: true)
• browserInstance [PuppeteerBrowser]: bring your own browser instance for more control

1const OpenseaScraper = require("opensea-scraper");
2
3// which nft project to scrape?
4const slug = "cool-cats-nft";
5
6// options
7const options = {
8  debug: false,
9  logs: false,
10  sort: true,
11  browserInstance: undefined,
12}
13
14// get basic info (from the opensea API)
15const basicInfo = await OpenseaScraper.basicInfo(slug);
16
17// get offers from opensea. Each offer includes the floor price, tokenName,
18// tokenId, tokenContractAddress and offerUrl
19let result = await OpenseaScraper.offers(slug, options);
20console.dir(result, {depth: null}); // result object contains keys `stats` and `offers`
21
22// get offers from opensea using a custom link
23// Opensea supports encoding filtering in the URL so this method is helpful for getting
24// a specific asset (for example floor price for a LAND token from the sandbox collection)
25let url = "https://opensea.io/collection/sandbox?search[sortAscending]=true&search[sortBy]=PRICE&search[stringTraits][0][name]=Type&search[stringTraits][0][values][0]=Land&search[toggles][0]=BUY_NOW";
26result = await OpenseaScraper.offersByUrl(url, options);
27console.dir(result, {depth: null}); // result object contains keys `stats` and `offers`
28
29// get offersByScrolling from opensea. This is an alternative method to get the same
30// data as in the function `offers`, with the only difference that the data is here
31// scraped actively by scrolling through the page. This method is not as efficient
32// as the `offers` method, but it can scrape more than 32 offers. You could even scrape
33// a whole collection with ~10k spots (this is not recommended though).
34let resultSize = 40; // if you need less than 32 offers, please use the function `offers()` instead
35result = await OpenseaScraper.offersByScrolling(slug, resultSize, options);
36console.dir(result, {depth: null}); // result object contains keys `stats` and `offers`
37
38// get offersByScrollingByUrl from opensea using a custom link instead of the slug
39// the same logic applies as in `offersByScrolling()`
40// Opensea supports encoding filtering in the URL so this method is helpful for getting
41// a specific asset (for example floor price for a LAND token from the sandbox collection)
42url = "https://opensea.io/collection/sandbox?search[sortAscending]=true&search[sortBy]=PRICE&search[stringTraits][0][name]=Type&search[stringTraits][0][values][0]=Land&search[toggles][0]=BUY_NOW";
43resultSize = 40; // if you need less than 32 offers, please use the function `offers()` instead
44result = await OpenseaScraper.offersByScrollingByUrl(url, resultSize, options);
45console.dir(result, {depth: null}); // result object contains keys `stats` and `offers`
46
47// scrape all slugs, names and ranks from the top collections from the rankings page
48// sorted by all time volume => https://opensea.io/rankings?sortBy=total_volume
49// `nbrOfPages` specifies how many pages should be scraped (1 page = 100 collections)
50const nbrOfPages = 2;
51const ranking = await OpenseaScraper.rankings(nbrOfPages, options);

Debugging

To investigate an issue turn on logs and debug mode (debug: true and logs: true):

1const result = await OpenseaScraper.offers("treeverse", {
2  debug: true,
3  logs: true
4});

Bring your own puppeteer

if you want to customize the settings for your puppeteer instance you can add your own puppeteer browser instance in the options:

1const puppeteer = require("puppeteer");
2const myPuppeteerInstance = await puppeteer.launch(myCustomSettings);
3
4const result = await OpenseaScraper.offer("cool-cats-nft", {
5  browserInstance: myPuppeteerInstance
6});

Demo

1npm run demo

Contribute

Open PR or issue if you would like to have more features added.

Donations 🙏

Thanks for your support!
BTC: bc1qq5qn96ahlqjxfxz2n9l20kem8p9nsz5yzz93f7
ETH: 0x3e4503720Fb8f4559Ecf64BE792b3100722dE940

nftfloorprice.info 🔔

Simple NFT floor price alerts. Easily track all your NFTs and receive realtime email alerts with: https://nftfloorprice.info