like-dexscreener v1.0.5

like-dexscreener

DEX Screener wrapper for Node.js

npm i like-dexscreener

Usage

const Dexscreener = require('like-dexscreener')

const dex = new Dexscreener()

await dex.ready()

const pairs = await dex.pairs()

console.log(pairs)

/* => [..., {
  chainId,
  dexId,
  pairAddress,
  baseToken: { address, name, symbol, decimals },
  quoteToken: { address, name, symbol, decimals },
  quoteTokenSymbol,
  price,
  priceUsd,
  txns: { ... },
  buyers: { ... }, sellers: { ... },
  makers: { ... },
  volume: { ... }, volumeBuy: { ... }, volumeSell: { ... },
  priceChange: { ... },
  liquidity: { usd, base, quote },
  marketCap,
  fdv,
  pairCreatedAt,
  isBoostable,
  launchpad: { progress, creator, migrationDex, meta }
}] */

API

dex = new Dexscreener()

Opens a browser, saves cookies into ~/.dexscreener/cookies.json.

await dex.ready()

Wait until the browser is ready.

await dex.close()

Close the browser.

pairs = await dex.pairs([options])

Get list of pairs.

Options:

{
  order: 'desc', // 'desc' or 'asc'
  rankBy: 'trendingScoreH6', // Possible values below
  page: 1, // Default page
  timeframe: '24h', // '5m', '1h', '6h', or '24h'
  filters: null // E.g. { maxAge: 3 }
}

Available rank by:

• trendingScoreM5
• trendingScoreH1
• trendingScoreH6
• trendingScoreH24
• txns
• buys
• sells
• volume
• priceChangeH24
• priceChangeH6
• priceChangeH1
• priceChangeM5
• liquidity
• marketCap
• fdv
• pairAge
• activeBoosts
• activeBoosts

Available filters:

{
  minAge,
  maxAge,
  min24HVol,
  max24HVol,
  minLiq,
  maxLiq,
  minMarketCap,
  maxMarketCap,
  min24HTxns,
  max24HTxns,
  minFdv,
  maxFdv,
  min24HChg,
  max24HChg,
  ... // Any other filter
}

License

MIT