XChain Platform Explorer — API Reference

Overview

The explorer exposes a REST API for querying all XChain Platform state. Every endpoint returns JSON and uses parameterized SQL internally to prevent injection.

All API URLs follow the pattern:

GET /{COIN}/api/{method}/{query}/{type}

Where:

• {COIN} — Coin prefix identifying the chain and network (e.g., BTC, TBTC, RDOGE)
• {method} — The data category (e.g., sends, balances, token)
• {query} — The search value (address, block index, token ticker, tx hash, action index)
• {type} — The filter type that determines how {query} is interpreted (e.g., address, block, token)

Coin Prefixes

Base URL

http://{host}:{port}/{COIN}/api/

Response Format

API Response

All API endpoints return:

{
    "data": [ ... ],
    "total": 42,
    "runtime": "15ms"
}

Error Responses

Pagination

All list endpoints support pagination via query parameters:

Result limits:

• Most endpoints: max 100 results per page
• getBalances and getHolders: max 500 results per page

# Page 2 of sends, 25 per page, newest first
curl "http://localhost:8080/BTC/api/sends/bc1q.../address?page=2&limit=25&sortorder=DESC"

System Endpoints

Get Status

Returns configuration info about all supported and available coins.

GET /{COIN}/api/status

Parameters: None

Response:

{
    "data": {
        "supported": ["BTC", "TBTC", "RBTC", "LTC", ...],
        "available": ["BTC", "RBTC"]
    }
}

Get Network

Returns aggregate network statistics: total counts of each action type and overall network info.

GET /{COIN}/api/network

Parameters: None

Response:

{
    "data": {
        "total_sends": 1234,
        "total_issues": 567,
        "total_orders": 89,
        "total_dispensers": 45,
        ...
    }
}

Token Endpoints

Get Token

Returns full token information for a single ticker.

GET /{COIN}/api/token/{tick}

Parameters:

Response fields: Token metadata including supply, max supply, decimals, owner address, description, lock states, mint parameters, and creation info.

Example:

curl http://localhost:8080/BTC/api/token/MYTOKEN

{
    "data": {
        "tick": "MYTOKEN",
        "max_supply": "1000000.00000000",
        "supply": "500000.00000000",
        "decimals": 8,
        "owner": "bc1q...",
        "description": "My token description",
        "lock_supply": 0,
        "lock_mint": 0,
        "lock_description": 0,
        "block_index": 800000,
        "action_index": 42
    }
}

Get Tokens

Returns a list of tokens filtered by various criteria.

GET /{COIN}/api/tokens/{query}/{type}

Parameters:

Type values:

Pagination: Supported

Example:

# All tokens owned by an address
curl "http://localhost:8080/BTC/api/tokens/bc1q.../address?limit=50"

# Search tokens by name
curl http://localhost:8080/BTC/api/tokens/MY/token

Balance & Address Endpoints

Get Balances

Returns all token balances held by an address.

GET /{COIN}/api/balances/{address}

Parameters:

Pagination: Supported (max 500 results)

Response: Array of balance objects with tick, balance amount, and token details.

Example:

curl http://localhost:8080/BTC/api/balances/bc1qexampleaddress

Get Address

Returns summary information for an address.

GET /{COIN}/api/address/{address}

Parameters:

Get Holders

Returns a ranked list of all holders for a given token.

GET /{COIN}/api/holders/{tick}

Parameters:

Pagination: Supported (max 500 results)

Response: Array of holder objects with address and balance, sorted by balance descending.

Example:

curl "http://localhost:8080/BTC/api/holders/MYTOKEN?limit=100"

Get Credits

Returns credit records (incoming tokens: transfers, mints, airdrops, dispenser releases, escrow releases).

GET /{COIN}/api/credits/{query}/{type}

Type values: block, address

Pagination: Supported

Get Debits

Returns debit records (outgoing tokens: transfers, destroys, fees, DEX funding).

GET /{COIN}/api/debits/{query}/{type}

Type values: block, address

Pagination: Supported

Get Escrows

Returns escrow records (tokens locked in DEX orders, dispensers, or swaps).

GET /{COIN}/api/escrows/{query}/{type}

Type values: block, address

Pagination: Supported

Transaction & History Endpoints

Get Transaction

Returns a decoded XChain transaction with all associated actions.

GET /{COIN}/api/transaction/{query}/{type}

Type values:

Response fields: tx_index, tx_hash, block_index, and an array of actions contained in the transaction.

Example:

curl http://localhost:8080/BTC/api/transaction/abc123.../tx_hash

Get Action

Returns comprehensive details for a single XChain action by its action index. Includes the action record, associated credits, debits, escrows, and fees.

GET /{COIN}/api/action/{actionIndex}

Parameters:

Response: Full action detail including the action type, all fields, transaction info, block info, and all ledger entries (credits, debits, escrows, fees) associated with this action.

Example:

curl http://localhost:8080/BTC/api/action/42

Get Block

Returns block-level summary information.

GET /{COIN}/api/block/{blockIndex}

Parameters:

Response fields: block_index, block_hash, block_time, transaction count, and action summary.

Get History

Returns a unified history of all XChain activity matching the query. Combines all action types into a single chronological feed.

GET /{COIN}/api/history/{query}/{type}

Type values:

Pagination: Supported

Example:

# Recent history for an address
curl "http://localhost:8080/BTC/api/history/bc1q.../address?limit=50&sortorder=DESC"

# Recent global activity
curl "http://localhost:8080/BTC/api/history/0/recent?limit=20"

ACTION-Specific Endpoints

All ACTION-specific endpoints share the same URL pattern and accept pagination:

GET /{COIN}/api/{action_plural}/{query}/{type}

Each returns records of the corresponding ACTION type. The {type} parameter controls how {query} is interpreted.

Sends

Token transfer records.

GET /{COIN}/api/sends/{query}/{type}

Example:

curl "http://localhost:8080/BTC/api/sends/bc1q.../address?limit=25&sortorder=DESC"

Issues

Token creation and update records (ISSUE action).

GET /{COIN}/api/issues/{query}/{type}

Mints

Token minting records.

GET /{COIN}/api/mints/{query}/{type}

Destroys

Token burn/destroy records.

GET /{COIN}/api/destroys/{query}/{type}

Orders

DEX order records (create, with status info).

GET /{COIN}/api/orders/{query}/{type}

Response includes: give/get coin, give/get tick, give/get amounts, expiration, status, and computed price fields.

Order Matches

Records of matched (filled) orders.

GET /{COIN}/api/order_matches/{query}/{type}

Order Cancels

Records of cancelled orders.

GET /{COIN}/api/order_cancels/{query}/{type}

Order Edits

Records of edited orders.

GET /{COIN}/api/order_edits/{query}/{type}

Order Expires

Records of expired orders.

GET /{COIN}/api/order_expires/{query}/{type}

COINPay

Native coin payment actions that fulfill ORDER_MATCH obligations.

GET /{COIN}/api/coinpays/{query}/{type}

Response includes: obligation action_index, coin amount, txid, vout, status, block, timestamp.

GET /{COIN}/api/coinpay_expires/{query}/{type}

GET /{COIN}/api/coinpay_obligations/{query}/{type}

Response includes: payer address, payee address, coin, coin amount, expiration timestamp, status (pending_coinpay/fulfilled/expired).

Dispensers

Vending-machine style token dispensers.

GET /{COIN}/api/dispensers/{query}/{type}

Response includes: give/get coin, give/get tick, give/get amounts, escrow amount, fiat pricing, status, expiration, allow/block lists.

Dispenses

Records of dispenser purchases (triggered when someone sends the required amount to a dispenser address).

GET /{COIN}/api/dispenses/{query}/{type}

Dispenser Cancels

GET /{COIN}/api/dispenser_cancels/{query}/{type}

Dispenser Closes

GET /{COIN}/api/dispenser_closes/{query}/{type}

Dispenser Edits

GET /{COIN}/api/dispenser_edits/{query}/{type}

Dispenser Expires

GET /{COIN}/api/dispenser_expires/{query}/{type}

Swaps

Cross-chain token swap records.

GET /{COIN}/api/swaps/{query}/{type}

Response includes: give/get coin, give/get tick, give/get amounts, get address, expiration, status, allow/block lists.

Swap Matches

GET /{COIN}/api/swap_matches/{query}/{type}

Swap Cancels

GET /{COIN}/api/swap_cancels/{query}/{type}

Swap Edits

GET /{COIN}/api/swap_edits/{query}/{type}

Swap Expires

GET /{COIN}/api/swap_expires/{query}/{type}

Sweeps

Records of SWEEP actions (transfer all assets to a destination).

GET /{COIN}/api/sweeps/{query}/{type}

Dividends

Proportional distribution records.

GET /{COIN}/api/dividends/{query}/{type}

Airdrops

Airdrop distribution records.

GET /{COIN}/api/airdrops/{query}/{type}

Broadcasts

On-chain broadcast/oracle data.

GET /{COIN}/api/broadcasts/{query}/{type}

Messages

On-chain encrypted or plaintext messages.

GET /{COIN}/api/messages/{query}/{type}

Files

On-chain file attachments.

GET /{COIN}/api/files/{query}/{type}

Response includes: file name, mime type, title, memo, and action metadata.

Callbacks

Token callback action records.

GET /{COIN}/api/callbacks/{query}/{type}

Sleeps

Address or token pause records.

GET /{COIN}/api/sleeps/{query}/{type}

Addresses

ADDRESS action records (address preference configuration).

GET /{COIN}/api/addresses/{query}/{type}

Batches

BATCH action records (multi-action transactions).

GET /{COIN}/api/batches/{query}/{type}

Links

Cross-chain link records.

GET /{COIN}/api/links/{query}/{type}

Lists

Address or tick list management records.

GET /{COIN}/api/lists/{query}/{type}

Fees

Fee records (XCHAIN gas token charges).

GET /{COIN}/api/fees/{query}/{type}

Mempool

Pending unconfirmed transaction data.

GET /{COIN}/api/mempool/{query}/{type}

Note: This endpoint is reserved for future implementation.

Market Endpoints

The explorer provides market data endpoints for the on-chain DEX (ORDER-based trading).

List Markets

Returns all active trading pairs, or all markets involving a specific token.

GET /{COIN}/api/markets
GET /{COIN}/api/markets/{tick}

Parameters:

Response: Array of market objects with tick1, tick2, and pricing information.

Example:

# All markets
curl http://localhost:8080/BTC/api/markets

# Markets involving MYTOKEN
curl http://localhost:8080/BTC/api/markets/MYTOKEN

Get Market

Returns summary information for a specific trading pair.

GET /{COIN}/api/market/{tick1}/{tick2}

Parameters:

Response: Market summary with last price, volume, and price computed in both directions (tick1→tick2 and tick2→tick1).

Example:

curl http://localhost:8080/BTC/api/market/TOKENA/TOKENB

Get Market History

Returns trade history (filled orders) for a market pair. Optionally filter to a single address.

GET /{COIN}/api/market/{tick1}/{tick2}/history
GET /{COIN}/api/market/{tick1}/{tick2}/history/{address}

Parameters:

Pagination: Supported

Example:

# All trades for a pair
curl "http://localhost:8080/BTC/api/market/TOKENA/TOKENB/history?limit=50"

# Trades by a specific address
curl http://localhost:8080/BTC/api/market/TOKENA/TOKENB/history/bc1q...

Get Market Orders

Returns open orders for a market pair. Optionally filter to a single address.

GET /{COIN}/api/market/{tick1}/{tick2}/orders
GET /{COIN}/api/market/{tick1}/{tick2}/orders/{address}

Parameters:

Pagination: Supported

Example:

curl http://localhost:8080/BTC/api/market/TOKENA/TOKENB/orders

Get Market Orderbook

Returns the aggregated order book for a market pair, split into bids and asks.

GET /{COIN}/api/market/{tick1}/{tick2}/orderbook

Parameters:

Response:

{
    "data": {
        "asks": [
            { "price": "0.50", "amount": "100" },
            ...
        ],
        "bids": [
            { "price": "0.45", "amount": "200" },
            ...
        ]
    }
}

Example:

curl http://localhost:8080/BTC/api/market/TOKENA/TOKENB/orderbook

DataTables Explorer Endpoints

In addition to the REST API, the explorer provides a parallel set of endpoints designed for the web UI’s jQuery DataTables integration. These endpoints use cursor-based pagination and return arrays instead of objects for compact transmission.

URL Pattern

GET /{COIN}/explorer/{method}/{query}/{type}

Response Format

{
    "recordsTotal": 42,
    "recordsFiltered": 42,
    "data": [
        [1, "field1|field2|field3", 100],
        ...
    ],
    "runtime": "12ms"
}

Data arrays use pipe-delimited strings for multi-value fields.

Pagination Parameters

Available Explorer Endpoints

All REST API action endpoints have a corresponding Explorer endpoint:

Additional Explorer-only endpoints:

Search

The search endpoint supports multi-entity searching:

GET /{COIN}/explorer/search/{query}/{type}

JSON-RPC 2.0 Interface

The explorer also exposes a JSON-RPC 2.0 endpoint for programmatic access:

POST / (root path)
Content-Type: application/json

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "ping",
    "params": {}
}

Available Methods

Note: The JSON-RPC interface currently exposes only the ping method. The REST API is the primary interface for data queries.

Complete Endpoint Quick Reference

Single-Item Endpoints

Market Endpoints

List Endpoints (all support /{query}/{type} and pagination)

Copyright © 2025–2026 Dankest, LLC

Based on XChain Platform by Dankest, LLC – https://dankest.llc

Licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-or-later) with a commercial license available for proprietary use.

You may use, modify, and distribute this material under the terms of the License. See LICENSE and NOTICE for full terms. See the licensing overview.