README.md

@cryptoscan/scanner-sdk

The easiest way to get dynamic swap/exchange rates by CEX and DEX tokens

[GitHub] [Our website] [Docs] [Discord]

To install package:

npm install @cryptoscan/scanner-sdk

Usage example:

import { getPrice, getRates, getRate } from '@cryptoscan/scanner-sdk';

const network = 'solana';
const from = 'USDC';
const to = 'SOL';
const amount = 10;

async function load() {
  const price = await getPrice({ network, to, from }); // 145.3
  const amount = await getPrice({ network, to, from, amount }); // 1453
  const rates = await getRate({ network, to, from }) // Array of Rate
  const rate = await getRate({ network, to, from }) // The first Rate
}

load()

Docs

Request

• network - network name (Optional - auto-detecting)
• to - coin address to get price
• from - base coin address (Default: usdt)
• amount - amount of base coin (Deafult: 1)

Response

List of Rate

• Rate
  • contractFrom - contract of the base coin address
  • contractTo - contract of the quote coin address
  • base - base coin symbol
  • quote - quote coin symbol
  • price - price of the pair
  • priceUSD - price of the coin in USD
  • result - amount of quote tokens to pay
  • resultUSD - amount of quote tokens to pay in USD
  • fee - fee
  • feeUSD - fee in USD
  • service - exchange or platform to buy
  • impact - price impact