# Spectrum Nodes Docs

> RPC endpoints for 200+ blockchain networks and a unified API across 24 chains, on bare-metal infrastructure with 99.99% uptime. These docs cover the REST API, TypeScript SDK, CLI, per-chain reference and platform guides.

## Overview
- [Welcome](https://spectrumnodes.com/docs/index.md): Documentation home: quick start, product overview and links to every section.
- [Getting Started](https://spectrumnodes.com/docs/getting-started.md): Get up and running with the Spectrum API in under a minute.
- [Authentication](https://spectrumnodes.com/docs/authentication.md): Authentication is tied to your assigned endpoint URL. Your API key is embedded in the URL path, so any request sent to your full endpoint URL is authenticated; there is no separate API-key header.

## Platform Guide
- [Platform Guide](https://spectrumnodes.com/docs/user-guides.md): Step-by-step guides to help you get the most out of Spectrum.
- [Create Your Account](https://spectrumnodes.com/docs/user-guides/create-your-account.md): Before you can deploy nodes or access your dashboard, you'll need to create an account. This guide will walk you through the process step-by-step.
- [Create Your First Endpoint](https://spectrumnodes.com/docs/user-guides/create-your-first-endpoint.md): Once you've created your Spectrum account, you're ready to deploy your first endpoint. This guide walks you through the process step-by-step so you can get your node online quickly and reliably.
- [CORS](https://spectrumnodes.com/docs/user-guides/setup-cors.md): Accessing your Spectrum endpoint from a web application running in the browser will likely require CORS configuration to allow your frontend to connect successfully.
- [IP Whitelist](https://spectrumnodes.com/docs/user-guides/setup-ip-whitelist.md): IP whitelisting adds an extra layer of security by ensuring that only requests from approved IP addresses can access your Spectrum endpoint.
- [Top Up](https://spectrumnodes.com/docs/user-guides/how-to-top-up.md): Topping up your account ensures you have available balance to cover usage. This balance can be used toward endpoint traffic, premium networks, or other Spectrum features.
- [Upgrade Your Tier](https://spectrumnodes.com/docs/user-guides/upgrade-your-tier.md): Upgrading your Spectrum tier unlocks higher performance, premium features, greater usage limits and enhanced support.
- [Buy Credits](https://spectrumnodes.com/docs/user-guides/purchase-additional-credits.md): Credits are used to manage your usage when approaching or exceeding your tier's limit. Buying more credits ensures your endpoints remain online and fully functional during high traffic periods.
- [Claim a Voucher](https://spectrumnodes.com/docs/user-guides/claim-a-voucher.md): Vouchers let you add balance or credits to your Spectrum account by redeeming a code.
- [Support](https://spectrumnodes.com/docs/user-guides/open-a-support-ticket.md): Need help with your account, endpoint configuration, billing, or something else? Opening a support ticket is the fastest way to get technical assistance from the Spectrum team.
- [Teams](https://spectrumnodes.com/docs/user-guides/create-a-team.md): Spectrum supports teams, allowing users to manage shared resources under one account.
- [Testnet Faucets](https://spectrumnodes.com/docs/user-guides/faucets.md): Our Faucets allow developers and builders to easily obtain testnet tokens directly to their wallet in a few seconds.
- [Monad Faucet](https://spectrumnodes.com/docs/user-guides/faucets/monad.md): Our Monad Testnet faucet allows users to drip 0.01 MON to their testnet wallets every 24 hours.
- [Ethereum Sepolia](https://spectrumnodes.com/docs/user-guides/faucets/ethereum-sepolia.md): Our Ethereum Sepolia faucet allows users to drip 0.01 ETH to their testnet wallets every 24 hours.
- [Base Sepolia](https://spectrumnodes.com/docs/user-guides/faucets/base-sepolia.md): Our Base Sepolia faucet allows users to drip 0.01 ETH to their testnet wallets every 24 hours.
- [Arbitrum Sepolia](https://spectrumnodes.com/docs/user-guides/faucets/arbitrum-sepolia.md): Our Arbitrum Sepolia faucet allows users to drip 0.01 ETH to their testnet wallets every 24 hours.
- [Optimism Sepolia](https://spectrumnodes.com/docs/user-guides/faucets/optimism-sepolia.md): Our Optimism Sepolia faucet allows users to drip 0.01 ETH to their testnet wallets every 24 hours.
- [Credit Usage](https://spectrumnodes.com/docs/user-guides/credit-usage.md): Credits are deducted from your balance on every request. This page outlines the cost per method for both the Spectrum API and direct RPC endpoints.

## API Reference
- [API Reference](https://spectrumnodes.com/docs/api-reference.md): The Spectrum API is exposed through a single JSON-RPC 2.0 endpoint.
- [Health](https://spectrumnodes.com/docs/api-reference/health.md): Endpoints: getHealth, getChainHealth.
- [Network Calendar](https://spectrumnodes.com/docs/api-reference/network-calendar.md): Lists approved network calendar entries (releases and upgrades). Entries are ordered by date ascending.
- [Blocks](https://spectrumnodes.com/docs/api-reference/blocks.md): Chain coverage: getBlockHeight, getBlockByNumber, getBlockByHash, and getBlockTransactions are dispatched through a shared service layer that supports EVM chains, Solana, Bitcoin, Starknet, and the…
- [Accounts & Balances](https://spectrumnodes.com/docs/api-reference/accounts.md): Chain coverage: getBalance and getTokenBalance are supported on EVM chains, Solana, Bitcoin (native only), Starknet (native STRK and Cairo ERC-20s), and the Cosmos SDK chains.
- [ERC-20 Tokens](https://spectrumnodes.com/docs/api-reference/tokens.md): Chain coverage: getTokenAllowance is EVM-only. getTokenMetadata works on EVM chains and the Cosmos SDK chains (cosmoshub, osmosis, axelar, noble, agoric).
- [Cosmos](https://spectrumnodes.com/docs/api-reference/cosmos.md): Spectrum supports these Cosmos SDK chains: cosmoshub, osmosis, axelar, noble, and agoric. Want another chain supported? Contact us.
- [Contracts](https://spectrumnodes.com/docs/api-reference/contracts.md): Execute a read-only contract call (ethcall) without submitting a transaction. Use this to read contract state, test function calls, or preview transaction results.
- [Portfolio](https://spectrumnodes.com/docs/api-reference/portfolio.md): Endpoints: getPortfolio.
- [ENS](https://spectrumnodes.com/docs/api-reference/ens.md): Endpoints: resolveENS, reverseENS.
- [NFTs](https://spectrumnodes.com/docs/api-reference/nfts.md): Endpoints: getNftCollection, getNftMetadata, getNftTokenOwner, getNftBalance, getNftTokens, getNftErc1155Balance, getNftBatchBalance.
- [Logs & Transfers](https://spectrumnodes.com/docs/api-reference/logs.md): Endpoints: getLogs, getTransfers.
- [Transactions](https://spectrumnodes.com/docs/api-reference/receipts.md): Chain coverage: getTransactionByHash is supported on EVM, Solana, Starknet, and the Cosmos SDK chains.
- [Gas](https://spectrumnodes.com/docs/api-reference/gas.md): Endpoints: compareGas, estimateGas.
- [Prices](https://spectrumnodes.com/docs/api-reference/prices.md): Endpoints: getPrice, getTopPrices, getPriceHistory.
- [Token Discovery](https://spectrumnodes.com/docs/api-reference/token-discovery.md): Endpoints: searchTokens, getTokenAddresses.
- [DeFi Yields](https://spectrumnodes.com/docs/api-reference/yields.md): Endpoints: getYieldsLending, getYieldsVaults, getYieldsBest, getYieldsBalance, getYieldsPrice, getYieldsPendleImpliedApy, getMorphoVaults, getMorphoVaultData.
- [DeFi Positions](https://spectrumnodes.com/docs/api-reference/defi-positions.md): Endpoints: getAaveV2UserPositions, getAaveV3UserPositions, getCompoundV3UserPositions, getCompoundV2UserPositions, getMorphoUserPositions, getLidoUserPositions, getCurvePools,…
- [Swap Quotes](https://spectrumnodes.com/docs/api-reference/swaps.md): Endpoints: getUniswapV2Quote, getUniswapV3Quote, getUniswapV4Quote, getJupiterQuote, getJupiterPrice.
- [Perps](https://spectrumnodes.com/docs/api-reference/perps.md): Endpoints: getFundingRates, getHLFunding, getDydxFunding.
- [Token Approvals](https://spectrumnodes.com/docs/api-reference/approvals.md): Endpoints: getApprovals, getApprovalsRevoke.
- [Protocol Registry](https://spectrumnodes.com/docs/api-reference/registry.md): Endpoints: getProtocols, getProtocol, getRegistryContracts, getRegistryAddress, getRegistryCategories, getRegistryChains.
- [JSON-RPC Batch](https://spectrumnodes.com/docs/api-reference/batch.md): Send a JSON array to the same POST /v1 endpoint you use for single JSON-RPC requests. Each item must include its own jsonrpc, method, params, and id.
- [JSON-RPC Proxy](https://spectrumnodes.com/docs/api-reference/rpc.md): Forward raw JSON-RPC calls to chain nodes through the same unified POST /v1 interface as all other Spectrum methods.
- [Pagination](https://spectrumnodes.com/docs/api-reference/pagination.md): Some endpoints return large result sets that are paginated using cursor-based pagination.

## TypeScript SDK
- [TypeScript SDK](https://spectrumnodes.com/docs/sdk.md): The Spectrum TypeScript SDK provides a typed, ergonomic client for the Spectrum API.
- [Installation](https://spectrumnodes.com/docs/sdk/installation.md): The SDK ships with full type definitions. No @types/ package needed.
- [Configuration](https://spectrumnodes.com/docs/sdk/configuration.md): The SDK uses intelligent per-endpoint cache TTLs:
- [Namespaces](https://spectrumnodes.com/docs/sdk/namespaces.md): The SDK organizes methods into 15 namespaces matching the API structure.
- [Error Handling](https://spectrumnodes.com/docs/sdk/error-handling.md): The SDK throws typed errors that you can catch and handle specifically.
- [Advanced](https://spectrumnodes.com/docs/sdk/advanced.md): Use hooks to log requests, collect metrics, or integrate with APM tools.

## CLI
- [CLI](https://spectrumnodes.com/docs/cli.md): The Spectrum CLI is a command-line interface for the Spectrum API: blocks, gas, balances, tokens, DeFi yields, NFTs, ENS, smart-contract reads, and raw JSON-RPC across 20+ chains.
- [Installation](https://spectrumnodes.com/docs/cli/installation.md): Install the CLI globally so the spectrum binary is on your PATH.
- [Configuration](https://spectrumnodes.com/docs/cli/configuration.md): The CLI needs an API URL (which embeds your tenant token) and optionally a default chain and timeout. Each setting resolves independently, highest precedence first.
- [Commands](https://spectrumnodes.com/docs/cli/commands.md): Every command follows the same shape: spectrum <namespace> <command>, for example spectrum core block-height or spectrum defi uniswap-v3-quote.
- [Output & Exit Codes](https://spectrumnodes.com/docs/cli/output.md): Data is raw JSON on stdout by default, so it pipes straight into jq:

## Webhooks
- [Webhooks](https://spectrumnodes.com/docs/webhooks.md): Spectrum Webhooks push real-time blockchain activity to an HTTPS endpoint, Slack channel, or Telegram chat.
- [Creating a Webhook](https://spectrumnodes.com/docs/webhooks/creating-a-webhook.md): Create webhooks from the Webhooks section of the Spectrum dashboard. Choose the complete walkthrough for the webhook you want to create:
- [Activity Categories](https://spectrumnodes.com/docs/webhooks/activity-categories.md): Every webhook has a type that determines what it watches. Spectrum currently offers one type, Address Activity (ADDRESSACTIVITY), which delivers the native, token, and NFT transfers a watched address…
- [Contract Events](https://spectrumnodes.com/docs/webhooks/contract-events.md): Contract Event webhooks (CONTRACTEVENT) deliver logs emitted by a selected smart contract. A log matches when its emitting contract and event signature match the webhook's selector.
- [Destinations](https://spectrumnodes.com/docs/webhooks/destinations.md): Spectrum can deliver a webhook to a signed HTTPS endpoint, a Slack channel, or a Telegram chat. Destination credentials are stored securely and are never returned by the API after creation.
- [Delivery & Retries](https://spectrumnodes.com/docs/webhooks/delivery-and-retries.md): For an HTTPS destination, Spectrum sends a signed POST carrying the matching events from one block. Slack and Telegram destinations receive a human-readable summary of the same logical delivery.
- [Signing & Verification](https://spectrumnodes.com/docs/webhooks/signing-and-verification.md): Every HTTPS delivery is signed so you can prove it came from Spectrum and wasn't tampered with or replayed.

## Supported Chains
- [Supported Chains](https://spectrumnodes.com/docs/chains.md): Spectrum supports 24 blockchain networks across EVM, Solana, Bitcoin, Starknet, and Cosmos SDK.
- [Ethereum](https://spectrumnodes.com/docs/chains/ethereum.md): Access Ethereum blockchain data through the Spectrum API. Ethereum is the most widely used smart contract platform and the foundation of the EVM ecosystem.
- [Polygon](https://spectrumnodes.com/docs/chains/polygon.md): Access Polygon via the Spectrum unified API. Polygon is a popular EVM-compatible sidechain with low fees and fast transactions, making it ideal for high-volume applications and DeFi protocols.
- [BNB Chain](https://spectrumnodes.com/docs/chains/bsc.md): Access BNB Chain via the Spectrum unified API. BNB Chain (formerly Binance Smart Chain) is a high throughput EVM network widely used for DeFi and token trading.
- [Optimism](https://spectrumnodes.com/docs/chains/optimism.md): Access Optimism via the Spectrum unified API. Optimism is an Ethereum L2 optimistic rollup with low fees, inheriting Ethereum's security while offering significantly cheaper transactions.
- [Base](https://spectrumnodes.com/docs/chains/base.md): Access Base via the Spectrum unified API. Base is Coinbase's OP Stack L2, designed for low-cost and high-speed transactions with the security of Ethereum.
- [Avalanche](https://spectrumnodes.com/docs/chains/avalanche.md): Access Avalanche via the Spectrum unified API. Avalanche's C-Chain is an EVM-compatible network known for fast finality and low fees, making it a popular choice for DeFi and enterprise applications.
- [Arbitrum](https://spectrumnodes.com/docs/chains/arbitrum.md): Access Arbitrum via the Spectrum unified API. Arbitrum is an Ethereum L2 optimistic rollup with high throughput and low transaction costs, making it one of the most popular Layer 2 networks for DeFi.
- [Gnosis](https://spectrumnodes.com/docs/chains/gnosis.md): Access Gnosis Chain via the Spectrum unified API. Gnosis Chain is a community-owned EVM chain with xDAI as its native token, providing stable and predictable transaction costs.
- [Moonbeam](https://spectrumnodes.com/docs/chains/moonbeam.md): Access Moonbeam via the Spectrum unified API. Moonbeam is a Polkadot parachain with full EVM compatibility, combining Ethereum tooling with the cross-chain capabilities of the Polkadot ecosystem.
- [Linea](https://spectrumnodes.com/docs/chains/linea.md): Access Linea via the Spectrum unified API. Linea is a ConsenSys zkEVM Layer 2 that provides low gas fees with the security of zero-knowledge proofs on Ethereum.
- [Hyperliquid](https://spectrumnodes.com/docs/chains/hyperliquid.md): Access Hyperliquid via the Spectrum unified API. Hyperliquid is a high-performance EVM Layer 1 purpose-built for perpetual trading, offering ultra-low latency and high throughput.
- [Berachain](https://spectrumnodes.com/docs/chains/berachain.md): Access Berachain via the Spectrum unified API. Berachain is an EVM L1 built on the Cosmos SDK with Proof-of-Liquidity consensus.
- [Monad](https://spectrumnodes.com/docs/chains/monad.md): Access Monad via the Spectrum unified API. Monad is a high-throughput EVM L1 with parallel execution and pipelined consensus.
- [Scroll](https://spectrumnodes.com/docs/chains/scroll.md): Access Scroll via the Spectrum unified API. Scroll is a bytecode-compatible zkEVM L2 rollup settling to Ethereum.
- [Plasma](https://spectrumnodes.com/docs/chains/plasma.md): Access Plasma via the Spectrum unified API. Plasma is a stablecoin-focused EVM L1 designed for high-volume USD₮ transfers.
- [X Layer](https://spectrumnodes.com/docs/chains/xlayer.md): Access X Layer via the Spectrum unified API. X Layer is OKX's Polygon CDK zkEVM L2.
- [Hyperliquid Hypercore (Coming Soon)](https://spectrumnodes.com/docs/chains/hypercore.md): Direct access to a Spectrum-operated Hyperliquid node. Hypercore is Hyperliquid's high-performance L1 state machine - the on-chain order book, perp/spot clearinghouse, vault accounting, staking, and…
- [Solana](https://spectrumnodes.com/docs/chains/solana.md): Access Solana blockchain data through the Spectrum API. Solana is a high-throughput blockchain using the Solana Virtual Machine (SVM) with sub-second finality.
- [Bitcoin](https://spectrumnodes.com/docs/chains/bitcoin.md): Access Bitcoin blockchain data through the Spectrum API. Bitcoin is the original and largest cryptocurrency network.
- [Starknet](https://spectrumnodes.com/docs/chains/starknet.md): Access Starknet blockchain data through the Spectrum API. Starknet is a permissionless ZK-rollup that runs the Cairo VM and settles to Ethereum.
- [Cosmos Hub](https://spectrumnodes.com/docs/chains/cosmoshub.md): Access Cosmos Hub blockchain data through the Spectrum API. Cosmos Hub is the central chain of the Cosmos ecosystem, built on the Cosmos SDK and Tendermint/CometBFT consensus.
- [Osmosis](https://spectrumnodes.com/docs/chains/osmosis.md): Access Osmosis blockchain data through the Spectrum API. Osmosis is a Cosmos SDK appchain and the largest decentralized exchange in the Cosmos ecosystem.
- [Axelar](https://spectrumnodes.com/docs/chains/axelar.md): Access Axelar blockchain data through the Spectrum API. Axelar is a Cosmos SDK chain that powers cross-chain messaging and asset transfers across more than 75 networks.
- [Noble](https://spectrumnodes.com/docs/chains/noble.md): Access Noble blockchain data through the Spectrum API. Noble is a Cosmos SDK appchain purpose-built for native asset issuance, most notably native USDC inside the Cosmos ecosystem.
- [Agoric](https://spectrumnodes.com/docs/chains/agoric.md): Access Agoric blockchain data through the Spectrum API. Agoric is a Cosmos SDK chain that runs hardened JavaScript ("smart wallets" and on-chain orchestration) on top of Tendermint consensus.

## For Foundations
- [For Foundations](https://spectrumnodes.com/docs/foundation-guides.md): Guides for organisations and foundations using Spectrum's shared access and dedicated infrastructure features.
- [View Dedicated/Sponsored Nodes](https://spectrumnodes.com/docs/foundation-guides/view-dedicated-nodes.md): Whether you've ordered dedicated nodes or joined a sponsored organisation/foundation, you can view your nodes directly from your Spectrum dashboard.
- [List Your Users](https://spectrumnodes.com/docs/foundation-guides/list-your-users.md): If you manage an organisation or foundation on Spectrum, you can easily view all the users who have joined using your invite code.
- [View User Metrics](https://spectrumnodes.com/docs/foundation-guides/view-user-metrics.md): As an organisation or foundation admin, you can monitor your users' activity, including request volumes and performance, directly from the Spectrum dashboard.
- [Generate Invite Code](https://spectrumnodes.com/docs/foundation-guides/generate-invite-code.md): Create invite codes to allow users to join your organisation's shared nodes and resources.
- [Join by Code](https://spectrumnodes.com/docs/foundation-guides/join-by-code.md): If you've been given an invite code, you can use it to join an organisation or foundation in Spectrum and gain access to shared nodes and resources.