API Reference

OpenScan REST API · Base URL: http://localhost:4000/api/v1

Response Format

{
  "items": [...],       // array of results
  "total": 12345,       // total count
  "page": 1,            // current page
  "limit": 25,          // items per page
  "next_page_params": { ... }  // cursor for next page
}

Blocks

GET	/api/v1/blocks	List latest blocks	`limit, page`	Try ↗
GET	/api/v1/blocks/:number	Get block by number	`number`	Try ↗
GET	/api/v1/blocks/:number/transactions	Transactions in block	`number, page`	Try ↗

Transactions

GET	/api/v1/transactions	List transactions	`address, block, limit, page`	Try ↗
GET	/api/v1/txs/:hash	Transaction detail	`hash`	Try ↗
GET	/api/v1/txs/internal	Internal transactions	`address, limit`	Try ↗
GET	/api/v1/txs/pending	Pending (mempool)		Try ↗

Addresses

GET	/api/v1/address/:hash	Address info + balance		Try ↗
GET	/api/v1/address/:hash/transactions	Address tx history	`page, limit`	Try ↗
GET	/api/v1/address/:hash/tokens	Token holdings		Try ↗
GET	/api/v1/address/:hash/logs	Event logs	`page`	Try ↗

Tokens

GET	/api/v1/tokens	Token list with market data	`type, search, page, limit`	Try ↗
GET	/api/v1/tokens/:address	Token detail		Try ↗
GET	/api/v1/tokens/:address/holders	Holder list	`page`	Try ↗
GET	/api/v1/tokens/:address/transfers	Token transfers	`page`	Try ↗
GET	/api/v1/token-transfers	All token transfers	`token, page, limit`	Try ↗
GET	/api/v1/stats/tokens	Token market stats		Try ↗

Contracts

GET	/api/v1/contracts	Verified contracts	`page, limit`	Try ↗
GET	/api/v1/contracts/:address	Contract + ABI		Try ↗
GET	/api/v1/contracts/:address/proxy	Detect proxy pattern (EIP-1967 etc)		Try ↗
GET	/api/v1/contracts/:address/verify	Verification status		Try ↗
POST	/api/v1/contracts/verify	Submit contract source for verification	`body: {address, compilerVersion, sourceCode, ...}`	Try ↗

Gas

GET	/api/v1/gas	Gas oracle + USD cost estimates		Try ↗
GET	/api/v1/gas/history	Gas price history	`hours`	Try ↗

Decode / Tools

GET	/api/v1/decode/input/:data	Decode method signature (4byte)		Try ↗
GET	/api/v1/decode/event/:topic0	Decode event topic		Try ↗
POST	/api/v1/decode/batch	Batch decode inputs	`body: {inputs[]}`	Try ↗

Masternodes

GET

/api/v1/masternodes

Masternode list + epoch info

Try ↗

Analytics

GET	/api/v1/stats	Network stats (price, tps, blocks)		Try ↗
GET	/api/v1/charts/tps	TPS time series (ClickHouse)	`range (hours)`	Try ↗
GET	/api/v1/charts/gas	Gas utilization trend	`range`	Try ↗

Portfolio

POST	/api/v1/portfolio	Create multi-address portfolio	`body: {addresses[]}`	Try ↗
GET	/api/v1/portfolio/:id	Portfolio with balances		Try ↗
GET	/api/v1/portfolio/:id/activity	Aggregated activity feed	`limit`	Try ↗
GET	/api/v1/portfolios	List all portfolios (session)		Try ↗

GraphQL

POST	/api/v1/graphql	GraphQL API (Apollo Server)	`body: {query, variables}`	Try ↗
GET	/api/v1/graphql/playground	GraphQL playground		Try ↗

Etherscan Compat

GET	/api?module=account&action=txlist	Account transactions	`address, page, offset`	Try ↗
GET	/api?module=block&action=getblockreward	Block reward	`blockno`	Try ↗
GET	/api?module=gastracker&action=gasoracle	Gas oracle		Try ↗
GET	/api?module=stats&action=ethsupply	XDC supply		Try ↗

WebSocket — Real-time Feed

// Connect
ws://localhost:4000/api/v1/ws/live

// Server sends
{ "type": "block",       "data": { "number": 12345, ... } }
{ "type": "transaction", "data": { "hash": "0x...", ... } }
{ "type": "log",         "data": { "address": "0x...", ... } }

// Subscribe to address
{ "action": "subscribe", "address": "0x..." }

🌐

100 req/min

Public Rate Limit

🔑

1,000 req/min

API Key Rate Limit

🔌

Unlimited

WebSocket Connections