API Documentation

Get started with Pearl Scanner API in three simple steps

Getting Started

Create your free account to get started. Click the button below to sign up and access the dashboard.

Generate API Key

Once logged in, navigate to the API Keys section in your dashboard. Create a new API key with a descriptive name. You can have up to 5 active API keys at a time.

Your API key will look like:

psk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Go to API Keys

Make Requests

Include your API key in the request header and start scanning transactions. See the examples below for different use cases.

Example request:

curl -X GET "https://api.pearlscanner.com/api/scanner/BTC/scan?address=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa" \

-H "x-api-key: psk_your_api_key_here"

API Reference

Scan Transactions

Endpoint:

GET /api/scanner/:coin/scan

Parameters

Parameter	Type	Required	Description
coin	string	Yes	Coin symbol: BTC, ETH, BNB, TRX, DOGE, USDT, or USDC (SOL coming soon)
address	string	Yes	Wallet address to scan
network	string	Required for tokens	Network: TRC20, ERC20, or BEP20 (required for USDT/USDC)
x-api-key	string	Yes	Your API key (header)

Examples

Native Coin (BTC)

Request:

GET /api/scanner/BTC/scan?address=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

Header: x-api-key: psk_your_api_key_here

Token (USDT on ERC20)

Request:

GET /api/scanner/USDT/scan?address=0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb&network=ERC20

Header: x-api-key: psk_your_api_key_here

Response

{
  "success": true,
  "transactions": [
    {
      "timestamp": 1234567890000,
      "hash": "0xabc123...",
      "confirmed": true,
      "amount": 0.5,
      "token": "BTC",
      "isCredit": true
    }
  ],
  "lookup": {
    "coin": "BTC",
    "network": null
  }
}

Response Schema

Transaction Object

timestamp: number // Unix timestamp in milliseconds

hash: string // Transaction hash

confirmed: boolean // Whether transaction is confirmed

amount: number // Amount in decimal units

token: string // Token symbol (BTC, ETH, USDT, etc.)

isCredit: boolean // true = incoming, false = outgoing

Error Handling

401 Unauthorized

Missing or invalid API key

400 Bad Request

Invalid parameters or unsupported coin/network

Error Response:

{
  "success": false,
  "error": "Error message here"
}

Ready to Start?

Get your API key and start scanning blockchain transactions today

Get Your API Key View Dashboard