@satuchain/radar-sdk

Official JavaScript/TypeScript SDK for the SatuDex Radar API — real-time token prices, DEX pairs, OHLCV candles, and trades on SATUCHAIN and BNB Chain.

Requirements

• An API key from radar.satudex.com/account
• Hold ≥ 10,000 STU on BNB Chain to generate a key
• Node.js ≥ 18 (or any modern browser / edge runtime)

Installation

npm install @satuchain/radar-sdk

Quick Start

import { RadarClient } from "@satuchain/radar-sdk";

const radar = new RadarClient("sk-satu-your-api-key");

// List trending tokens on BNB Chain
const { data: tokens } = await radar.getTokens({ sort: "trending", chainId: 56 });
for (const t of tokens) {
  const icon = radar.iconUrl(t.token.image); // full URL to token logo
  console.log(t.token.symbol, t.price, icon);
}

// Get a single token with all pairs
const { data: token } = await radar.getToken("0xTOKEN_ADDRESS");
console.log(token.attributes.symbol);
console.log(token.relationships.topPair?.price);
console.log(radar.iconUrl(token.attributes.image)); // token logo URL

// OHLCV candles (1m / 5m / 1h / 4h / 1d)
const { data: candles } = await radar.getCandles("0xPAIR_ADDRESS", { tf: "1h", limit: 100 });
for (const c of candles) {
  console.log(new Date(c.time * 1000), c.open, c.high, c.low, c.close, c.volume);
}

// Recent trades
const { data: trades } = await radar.getTrades("0xPAIR_ADDRESS", { limit: 50 });
for (const trade of trades) {
  console.log(trade.side, trade.price, trade.volumeQuote);
}

// Token price
const { data: price } = await radar.getPrice("0xTOKEN_ADDRESS");
console.log(price.priceUsd);

Token Icons

Every token detail and list item includes an image field containing a relative path. Use radar.iconUrl() to get the full URL:

const { data: token } = await radar.getToken("0xADDRESS");
const iconUrl = radar.iconUrl(token.attributes.image);
// → "https://radar.satudex.com/uploads/tokens/satu/0x.../logo.png"

// Download the icon (no API key needed for /uploads/)
const img = await fetch(iconUrl);

For list items:

const { data: tokens } = await radar.getTokens({ chainId: 56 });
for (const t of tokens) {
  const iconUrl = radar.iconUrl(t.token.image);
  // use iconUrl in <img src={iconUrl} />
}

API Reference

new RadarClient(options)

| Option | Type | Default | Description | |--------|------|---------|-------------| | apiKey | string | required | Your API key (sk-satu-...) | | baseUrl | string | https://radar.satudex.com/api/v1 | API base URL | | timeout | number | 10000 | Request timeout in ms |

Methods

| Method | Description | |--------|-------------| | getTokens(opts?) | List tokens — sort, filter by chain/DEX/query | | getToken(address, opts?) | Single token detail + all pairs | | getPairs(opts?) | List all trading pairs (paginated) | | getTrades(pairAddress, opts?) | Recent trades for a pair | | getCandles(pairAddress, opts?) | OHLCV candles (1m/5m/1h/4h/1d) | | getPrice(tokenAddress, opts?) | Current USD price for a token | | iconUrl(relativePath) | Convert relative image path → full URL |

Sort Keys (getTokens)

| Key | Description | |-----|-------------| | trending | By boost score (default) | | gainers | Biggest 24h price gainers | | losers | Biggest 24h price losers | | volume | Highest 24h volume | | newest | Recently added | | top | Highest liquidity |

Chain IDs

| Chain | ID | |-------|----| | SATU Testnet | 17081945 | | BNB Chain | 56 |

DEX IDs (BNB Chain)

pancakeswap · biswap · apeswap · sushiswap · four.meme · uniswap

Error Handling

import { RadarClient, RadarAuthError, RadarRateLimitError } from "@satuchain/radar-sdk";

const radar = new RadarClient("sk-satu-...");

try {
  const { data } = await radar.getTokens();
} catch (err) {
  if (err instanceof RadarAuthError) {
    console.error("Invalid API key:", err.message);
  } else if (err instanceof RadarRateLimitError) {
    console.error(`Rate limited. Retry after ${err.retryAfter}s`);
  } else {
    console.error(err.message);
  }
}

| Error Class | HTTP | Description | |-------------|------|-------------| | RadarAuthError | 401 | Invalid/missing API key | | RadarForbiddenError | 403 | Insufficient STU balance | | RadarRateLimitError | 429 | Rate limit exceeded (.retryAfter in seconds) | | RadarUpstreamError | 5xx | Server error | | RadarError | — | Base error class |

Rate Limits

| Tier | Min. Hold | Limit | |------|-----------|-------| | Basic | 10,000 STU | 300 req/min | | Pro | 1,000,000 STU | 3,000 req/min |

Check remaining quota via radar.rateLimit after any request.

CommonJS

const { RadarClient } = require("@satuchain/radar-sdk");

Links

• SatuDex Radar
• Get API Key
• SATUCHAIN

License

MIT © SATU TEAM