Skip to content

Coin Screener

Query coin data with the Coin Screener.

Overview

typescript
import { CoinScreener, CoinField } from 'tradingview-screener';

const screener = new CoinScreener();

Basic Usage

typescript
screener
  .where(CoinField.CLOSE.gt(0.01))
  .select(CoinField.NAME, CoinField.CLOSE);

const results = await screener.get();
console.table(results.data);

Available Fields

typescript
CoinField.NAME     // Coin name
CoinField.CLOSE    // Current price

Complete Example

typescript
import { CoinScreener, CoinField } from 'tradingview-screener';

async function findCoins() {
  const screener = new CoinScreener();

  screener
    .where(CoinField.CLOSE.between(0.001, 10))
    .select(CoinField.NAME, CoinField.CLOSE)
    .sortBy(CoinField.CLOSE, false)
    .setRange(0, 50);

  const results = await screener.get();
  console.table(results.data);
}

findCoins().catch(console.error);

Next Steps

Released under the MIT License.