Solscan API TypeScript Client

A TypeScript client library for Solscan API. This library provides a convenient way to interact with both public and pro endpoints of the Solscan API.

DISCLAIMER: This is an unofficial library and is not affiliated with, maintained, authorized, endorsed, or sponsored by Solscan or any of its affiliates. This is an independent tool created to help developers interact with the Solscan API.

Installation

npm install solscan-js

Features

• TypeScript support with proper typing
• Support for all Solscan API endpoints (public and pro)
• Clean, Promise-based API
• Lazy initialization of API modules
• Helper utilities for building query parameters

API Key

To use the Solscan Pro API endpoints, you need to obtain an API key from Solscan. You can sign up and get your API key at Solscan.

Basic Usage

import { SolscanAPI } from 'solscan-js';

// Initialize with your API key
const solscan = new SolscanAPI('YOUR_API_KEY');

// Public API - Chain info
solscan.public.chainInfo()
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Direct access to account transfers
solscan.account.transfer('ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

API Sections

The library provides direct access to all API endpoints. You can now use clean, direct calls without nested structures:

Public API

// Get chain information
solscan.public.chainInfo()
  .then(result => console.log(result))
  .catch(error => console.error(error));

Account API

// Get account details
solscan.account.detail('ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get account transfers (direct access!)
solscan.account.transfer('ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get account token accounts
solscan.account.tokenAccounts('ADDRESS', 'token', { hideZero: true })
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get defi activities
solscan.account.defiActivities('ADDRESS', {
  page: 1,
  pageSize: 20,
  sortBy: 'block_time',
  sortOrder: 'desc'
})
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get balance change activities
solscan.account.balanceChangeActivities('ADDRESS', {
  page: 1,
  pageSize: 20
})
  .then(result => console.log(result))
  .catch(error => console.error(error));

Token API

// Get token metadata
solscan.token.meta('TOKEN_ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get trending tokens
solscan.token.trending(10)
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get token price
solscan.token.tokenPrice('TOKEN_ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get top tokens
solscan.token.top()
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get token defi activities
solscan.token.defiActivities('TOKEN_ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

NFT API

// Get NFT news
solscan.nft.news()
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get NFT collections
solscan.nft.collectionLists({ range: 7 })
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get collection items
solscan.nft.collectionItems('COLLECTION_ID')
  .then(result => console.log(result))
  .catch(error => console.error(error));

Transaction API

// Get transaction details
solscan.transaction.detail('TX_SIGNATURE')
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get latest transactions
solscan.transaction.last({ limit: 20 })
  .then(result => console.log(result))
  .catch(error => console.error(error));

Block API

// Get latest blocks
solscan.block.last(50)
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Get block details
solscan.block.detail(BLOCK_NUMBER)
  .then(result => console.log(result))
  .catch(error => console.error(error));

Monitoring API

// Get API usage information
solscan.monitoring.usage()
  .then(result => console.log(result))
  .catch(error => console.error(error));

Advanced Usage

Using with async/await

async function getAccountInfo(address: string) {
  try {
    const accountDetail = await solscan.account.detail(address);
    const tokenAccounts = await solscan.account.tokenAccounts(address, 'token');
    const transfers = await solscan.account.transfer(address);
    
    return {
      account: accountDetail,
      tokens: tokenAccounts,
      transfers: transfers
    };
  } catch (error) {
    console.error('Error fetching account info:', error);
    throw error;
  }
}

Legacy API Access (Backward Compatibility)

If you have existing code using the old structure, it will still work:

// Legacy access (still supported)
solscan.apiV2.account.detail('ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

// But you can now use the cleaner direct access:
solscan.account.detail('ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

Direct class usage

You can also use the API classes directly if you prefer:

import { TokenAPI } from 'solscan-js';

const tokenApi = new TokenAPI('YOUR_API_KEY');
tokenApi.meta('TOKEN_ADDRESS')
  .then(result => console.log(result))
  .catch(error => console.error(error));

Migration Guide

If you're upgrading from a previous version, you can easily migrate to the new direct access pattern:

// Old way
solscan.apiV2.account.transfer('ADDRESS')
solscan.apiV2.token.meta('TOKEN_ADDRESS')
solscan.publicApi.chainInfo()

// New way (recommended)
solscan.account.transfer('ADDRESS')
solscan.token.meta('TOKEN_ADDRESS')
solscan.public.chainInfo()

The old way still works for backward compatibility, but the new direct access is cleaner and more intuitive.

Error Handling

All API methods return promises that will reject with an error if the API request fails. We recommend using try/catch blocks or promise error handlers to handle these cases.

try {
  const result = await solscan.account.detail('ADDRESS');
  // Process result
} catch (error) {
  // Handle error
  console.error('API request failed:', error);
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT

Disclaimer

This library is not affiliated with, maintained, authorized, endorsed, or sponsored by Solscan or any of its affiliates. All product and company names are the registered trademarks of their original owners. The use of any trade name or trademark is for identification and reference purposes only and does not imply any association with the trademark holder.