website·Indexed 32 days ago
https://api.subfrost.io/docsA comprehensive API platform for Bitcoin and blockchain data, featuring JSON-RPC and REST endpoints for Alkanes, BRC-20, Ordinals, and mempool data. It provides tools for threshold signature wallets via FROST, server-side Lua scripting, and specialized indexers like Metashrew and OPI. The platform includes a CLI (alkanes-cli), a TypeScript SDK (@alkanes/ts-sdk), and support for WalletConnect-style protocols for mobile app signature requests.
The alkanes_* namespace provides access to the Alkanes protocol (a variant of protorunes and subprotocol of runes) on Bitcoin L1. These methods are convenience wrappers that encode inputs into a MessageContextParcel protobuf, call metashrew_view, and decode the result.
Recommendation: For new integrations, prefer calling metashrew_view directly for stable behavior and broader feature coverage. The mapping between convenience methods and their canonical metashrew_view functions is as follows:
| Convenience method | metashrew_view function | Notes |
|---|---|---|
alkanes_protorunesbyaddress | protorunesbyaddress | DEPRECATED in v3.0. Use Esplora UTXO API + protorunesbyoutpoint. |
alkanes_getbytecode | getbytecode | |
alkanes_simulate | simulate | Use for read-only contract evaluation. |
alkanes_meta | meta | Returns narrow token-shape; use metashrew_view for non-token alkanes. |
alkanes_trace | trace | |
alkanes_traceblock | traceblock |
alkanes-cli tool and @alkanes/ts-sdk library provide a comprehensive interface for interacting with the Alkanes protocol, Bitcoin blockchain, and SUBFROST APIs. Key capabilities include wallet management (HD wallets), Alkanes protocol operations (contracts, swaps, liquidity), Bitcoin operations (UTXOs, blocks), and support for Ordinals, Runes, and BRC20-Prog EVM-compatible contracts.The Ethereum Mempool API provides a live view of the public mempool ingested directly from the eth devp2p wire network. This allows users to see transactions before they are mined and before they appear in many RPC providers' pools.
Important Constraints:
seq field and handle reset events to manage potential stream gaps.# JSON-RPC Endpoint
POST https://mainnet.subfrost.io/v4/{api_key}/ethereum/mempool
# WebSocket Change Stream Endpoint
GET wss://mainnet.subfrost.io/v4/{api_key}/ethereum/mempool/wsord_rune to get details about a specific rune. The rune name should include spacers (e.g., •).{
"jsonrpc": "2.0",
"method": "ord_rune",
"params": ["UNCOMMON•GOODS"],
"id": 1
}ord_sat to retrieve information about a specific satoshi by its ordinal number, including rarity, block, and associated inscriptions.{
"jsonrpc": "2.0",
"method": "ord_sat",
"params": [1000000000000],
"id": 1
}The frUSD indexer allows developers to track deposits made into the frUSD vault on Ethereum, indexed by the BTC recipient script. This is used to determine if a cross-chain deposit has landed on Ethereum and the amount deposited. The API uses a dedicated endpoint separate from the main Subfrost API.
Endpoint: POST https://mainnet.subfrost.io/v4/<your-api-key>/ethereum/frusd
(Note: The free anchor /v4/jsonrpc/ethereum/frusd is available without a key for public on-chain history.)
ord rune command to get details about a Rune. If the rune name contains a bullet character (•), ensure it is included in the query string.alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
ord rune "UNCOMMON•GOODS"ord_inscription to retrieve full details about a specific Ordinal inscription. The inscription ID must be in the format txidi0.{
"jsonrpc": "2.0",
"method": "ord_inscription",
"params": ["6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0"],
"id": 1
}