Skip to content

blockscout-api.mdx

Latest commit

 

History

History
678 lines (488 loc) · 13.9 KB

blockscout-api.mdx

File metadata and controls

678 lines (488 loc) · 13.9 KB
title BlockScout API
description Complete REST API for querying blockchain data on Paxeer Network
icon magnifying-glass

Overview

Complete REST API for interacting with PaxeerScan (BlockScout). Query transactions, blocks, addresses, tokens, and network statistics.

**Base URL:** `https://paxscan.paxeer.app/api/v2` All endpoints are publicly accessible without authentication.

Search & Discovery

Universal Search

Search query (address, transaction hash, block number, token name) 
curl "https://paxscan.paxeer.app/api/v2/search?q=USDT"

Search for tokens, addresses, blocks, and transactions across the network.

Check Redirect

Search query to check for redirect 
curl "https://paxscan.paxeer.app/api/v2/search/check-redirect?q=0x..."

Returns redirect information for search results.

Transactions

Get Transactions

Filter type: `pending` | `validated` Transaction type: `token_transfer`, `contract_call`, etc. Method name: `approve`, `transfer`, `mint`, etc. 
curl "https://paxscan.paxeer.app/api/v2/transactions?filter=validated&type=token_transfer"

Retrieve paginated list of transactions with optional filters.

Get Transaction Details

Transaction hash 
curl "https://paxscan.paxeer.app/api/v2/transactions/0x..."

Get detailed information about a specific transaction.

Response Example:

{
  "hash": "0x...",
  "block_number": 1234567,
  "from": {
    "hash": "0x..."
  },
  "to": {
    "hash": "0x..."
  },
  "value": "1000000000000000000",
  "gas_used": "21000",
  "gas_price": "1000000000",
  "status": "ok",
  "method": "transfer",
  "timestamp": "2024-01-01T00:00:00Z"
}

Get Transaction Token Transfers

curl "https://paxscan.paxeer.app/api/v2/transactions/0x.../token-transfers?type=ERC-20"

Get all token transfers within a transaction.

Get Internal Transactions

curl "https://paxscan.paxeer.app/api/v2/transactions/0x.../internal-transactions"

Get internal transactions (contract calls) within a transaction.

Get Transaction Logs

curl "https://paxscan.paxeer.app/api/v2/transactions/0x.../logs"

Get all event logs emitted by a transaction.

Get Transaction State Changes

curl "https://paxscan.paxeer.app/api/v2/transactions/0x.../state-changes"

Get all state changes caused by a transaction.

Blocks

Get Blocks

Block type: `block` | `uncle` | `reorg` 
curl "https://paxscan.paxeer.app/api/v2/blocks"

Retrieve paginated list of blocks.

Get Block Details

Block number or hash 
curl "https://paxscan.paxeer.app/api/v2/blocks/1000"

Get detailed information about a specific block.

Get Block Transactions

curl "https://paxscan.paxeer.app/api/v2/blocks/1000/transactions"

Get all transactions in a specific block.

Get Block Withdrawals

curl "https://paxscan.paxeer.app/api/v2/blocks/1000/withdrawals"

Get all withdrawals in a specific block.

Addresses

Get Address Details

Address hash (0x...) 
curl "https://paxscan.paxeer.app/api/v2/addresses/0x..."

Get detailed information about an address.

Response Example:

{
  "hash": "0x...",
  "balance": "1000000000000000000",
  "transactions_count": 42,
  "token_transfers_count": 100,
  "is_contract": true,
  "creator_hash": "0x...",
  "creation_tx_hash": "0x..."
}

Get Address Counters

curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../counters"

Get transaction counts and other metrics for an address.

Get Address Transactions

Direction filter: `to` | `from` 
curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../transactions?filter=from"

Get all transactions for a specific address.

Get Address Token Transfers

Token type: `ERC-20`, `ERC-721`, `ERC-1155` Direction filter: `to` | `from` 
curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../token-transfers?type=ERC-20"

Get all token transfers for an address.

Get Address Token Balances

Token type: `ERC-20`, `ERC-721`, `ERC-1155` 
curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../tokens?type=ERC-20"

Get all token balances for an address.

Get Address Balance History

curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../coin-balance-history"

Get historical balance changes for an address.

Get Address Internal Transactions

curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../internal-transactions?filter=to"

Get internal transactions involving an address.

Get Address Logs

curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../logs"

Get all event logs related to an address.

Tokens

Get All Token Transfers

curl "https://paxscan.paxeer.app/api/v2/token-transfers"

Get paginated list of all token transfers on the network.

Get Tokens

Token type: `ERC-20` | `ERC-721` | `ERC-1155` 
curl "https://paxscan.paxeer.app/api/v2/tokens?type=ERC-20"

Get list of tokens deployed on Paxeer Network.

Get Token Details

Token contract address 
curl "https://paxscan.paxeer.app/api/v2/tokens/0x..."

Get detailed information about a specific token.

Response Example:

{
  "address": "0x...",
  "name": "USD Tether",
  "symbol": "USDT",
  "decimals": 6,
  "type": "ERC-20",
  "total_supply": "1000000000000",
  "holders": 1234,
  "exchange_rate": "1.00"
}

Get Token Transfers

curl "https://paxscan.paxeer.app/api/v2/tokens/0x.../transfers"

Get all transfers of a specific token.

Get Token Holders

curl "https://paxscan.paxeer.app/api/v2/tokens/0x.../holders"

Get list of addresses holding a specific token.

Statistics

Get Network Statistics

curl "https://paxscan.paxeer.app/api/v2/stats"

Get overall network statistics and metrics.

Response Example:

{
  "total_blocks": 1234567,
  "total_transactions": 9876543,
  "total_addresses": 54321,
  "average_block_time": 2.5,
  "gas_prices": {
    "average": "1000000000",
    "fast": "1500000000",
    "slow": "800000000"
  }
}

Get Transaction Chart Data

curl "https://paxscan.paxeer.app/api/v2/stats/charts/transactions"

Get historical transaction count data for charts.

Get Market Chart Data

curl "https://paxscan.paxeer.app/api/v2/stats/charts/market"

Get historical market data for PAX token.

Main Page Data

Get Latest Transactions

curl "https://paxscan.paxeer.app/api/v2/main-page/transactions"

Get most recent transactions for home page display.

Get Latest Blocks

curl "https://paxscan.paxeer.app/api/v2/main-page/blocks"

Get most recent blocks for home page display.

Get Indexing Status

curl "https://paxscan.paxeer.app/api/v2/main-page/indexing-status"

Get current blockchain indexing status.

Code Examples

```javascript // Get transaction details async function getTransaction(hash) { const response = await fetch( `https://paxscan.paxeer.app/api/v2/transactions/${hash}` ); const data = await response.json(); return data; } 
// Get address token balances
async function getTokenBalances(address) {
  const response = await fetch(
    `https://paxscan.paxeer.app/api/v2/addresses/${address}/tokens?type=ERC-20`
  );
  const data = await response.json();
  return data;
}

// Get latest blocks
async function getLatestBlocks() {
  const response = await fetch(
    'https://paxscan.paxeer.app/api/v2/main-page/blocks'
  );
  const data = await response.json();
  return data;
}
```
```python import requests 
# Get transaction details
def get_transaction(hash):
    url = f'https://paxscan.paxeer.app/api/v2/transactions/{hash}'
    response = requests.get(url)
    return response.json()

# Get address token balances
def get_token_balances(address):
    url = f'https://paxscan.paxeer.app/api/v2/addresses/{address}/tokens'
    params = {'type': 'ERC-20'}
    response = requests.get(url, params=params)
    return response.json()

# Get latest blocks
def get_latest_blocks():
    url = 'https://paxscan.paxeer.app/api/v2/main-page/blocks'
    response = requests.get(url)
    return response.json()
```
```bash # Get transaction details curl "https://paxscan.paxeer.app/api/v2/transactions/0x..." 
# Get address token balances
curl "https://paxscan.paxeer.app/api/v2/addresses/0x.../tokens?type=ERC-20"

# Get latest blocks
curl "https://paxscan.paxeer.app/api/v2/main-page/blocks"

# Search for token
curl "https://paxscan.paxeer.app/api/v2/search?q=USDT"
```

React Hook Example

import { useState, useEffect } from 'react';

export function useTransactionDetails(hash: string) {
  const [data, setData] = useState(null);
  const [loading, setLoading] = useState(true);
  const [error, setError] = useState(null);

  useEffect(() => {
    if (!hash) return;

    async function fetchTransaction() {
      try {
        const response = await fetch(
          `https://paxscan.paxeer.app/api/v2/transactions/${hash}`
        );
        if (!response.ok) throw new Error('Transaction not found');
        const data = await response.json();
        setData(data);
      } catch (err) {
        setError(err.message);
      } finally {
        setLoading(false);
      }
    }

    fetchTransaction();
  }, [hash]);

  return { data, loading, error };
}

export function useAddressTokens(address: string) {
  const [tokens, setTokens] = useState([]);
  const [loading, setLoading] = useState(true);

  useEffect(() => {
    if (!address) return;

    async function fetchTokens() {
      try {
        const response = await fetch(
          `https://paxscan.paxeer.app/api/v2/addresses/${address}/tokens?type=ERC-20`
        );
        const data = await response.json();
        setTokens(data.items || []);
      } catch (error) {
        console.error('Error fetching tokens:', error);
      } finally {
        setLoading(false);
      }
    }

    fetchTokens();
  }, [address]);

  return { tokens, loading };
}

Pagination

Most list endpoints support pagination with these query parameters:

Page number (starts at 1) Number of items per page (default: 50, max: 100) 
curl "https://paxscan.paxeer.app/api/v2/transactions?page=2&items_count=25"

Rate Limiting

  • No authentication required
  • No rate limits on public endpoints
  • Responses may be cached for performance

Error Handling

API returns standard HTTP status codes:

Code Description
200 Success
400 Bad Request
404 Not Found
422 Unprocessable Entity
500 Internal Server Error

Resources

Explore the blockchain Complete API docs View network statistics Get support

Next Steps

Get started with Paxeer Network View integration examples