Accessing accurate and timely data about blockchain-based digital assets is essential for developers, analysts, and investors navigating the rapidly evolving Web3 ecosystem. The Runes API by OKX provides a powerful, streamlined way to retrieve comprehensive details about NFT collections—specifically those based on the Bitcoin-native Runes protocol. This guide dives into how you can use the Get Collection Information endpoint to access key metrics such as holder count, floor price, trading volume, market cap, and more.
Whether you're building a marketplace analytics dashboard, conducting on-chain research, or integrating real-time NFT data into your dApp, this API delivers reliable, structured responses with minimal latency.
👉 Discover how to integrate real-time NFT data into your application effortlessly.
Understanding the Runes Protocol and Its Data Needs
The Runes protocol is a token standard built on Bitcoin that enables the creation and transfer of fungible tokens directly on the Bitcoin blockchain. Unlike other token standards that rely on sidechains or smart contract platforms, Runes leverages Bitcoin’s native UTXO model for efficiency and security. As interest in Bitcoin-based digital collectibles grows, so does the demand for transparent, accessible data about these assets.
This is where the Runes API becomes invaluable. By offering a dedicated endpoint to fetch detailed collection information, it empowers developers to monitor market trends, assess asset performance, and enhance user experiences in decentralized applications.
API Endpoint: Get Collection Information
The primary function of this interface is to return comprehensive metadata and market statistics for one or multiple Runes collections.
Request URL
GET https://web3.okx.com/api/v5/mktplace/nft/runes/detailThis secure HTTPS endpoint supports GET requests and returns JSON-formatted data containing all relevant collection metrics.
Request Parameters
To query specific Runes collections, include the following parameter in your request:
| Parameter | Type | Required | Description |
|---|---|---|---|
runesId | String | Yes | The unique identifier(s) for the Runes collection. Supports batch queries by separating multiple IDs with commas (e.g., 840000:3,840000:28) |
This flexibility allows developers to fetch data for multiple collections in a single call, reducing latency and improving efficiency when building dashboards or comparison tools.
Response Parameters
The API returns a rich set of fields that provide both technical and economic insights into each Runes collection:
rune: The official name of the rune.spacename: The formatted name with dots representing hierarchy (e.g., "CAT.SAT").maxMintNumber: Maximum number of tokens allowed to be minted.mintedNumber: Number of tokens already minted.limitPerMint: Maximum amount that can be minted per transaction.deployedTime: Timestamp (in milliseconds) indicating when the rune was deployed.startBlock: The blockchain block at which minting became active.endBlock: The final block in which minting is permitted (if applicable).symbol: Trading symbol associated with the rune.divisibility: Number of decimal places the token supports.collectionUrl: Direct link to the collection page on OKX NFT Marketplace.totalVolume: Total trading volume in BTC.usdTotalVolume: Total trading volume in USD.marketCap: Market capitalization measured in BTC.usdMarketCap: Market capitalization measured in USD.floorprice: Lowest listed price in satoshis (Sats).usdFloorPrice: Floor price converted to USD.holders: Total number of unique addresses holding the asset.salesCount: Total number of completed sales transactions.
These parameters offer a holistic view of a collection’s health, popularity, and market dynamics—critical for decision-making in trading, investment, and product development.
👉 Unlock live NFT market insights with seamless API access today.
Use Cases and Practical Applications
1. Market Analytics Dashboards
Developers can aggregate data from multiple Runes collections to build real-time dashboards showing trends in trading volume, floor prices, and holder growth across different projects.
2. Portfolio Tracking Tools
Wallet services or portfolio managers can integrate this API to display performance metrics for users’ Runes holdings, including unrealized P&L based on current floor prices and USD valuations.
3. Research and Due Diligence
Analysts can evaluate newly launched runes by comparing mint progress (mintedNumber vs maxMintNumber), community adoption (holders), and early trading activity (salesCount, totalVolume).
4. Automated Trading Bots
High-frequency traders can use changes in floor price and volume spikes to trigger buy/sell signals for arbitrage or trend-following strategies.
Frequently Asked Questions (FAQ)
Q: Can I query more than one Runes collection at a time?
A: Yes. You can pass multiple runesId values separated by commas (e.g., 840000:3,840000:28) to retrieve data for several collections in a single API call.
Q: What does "floor price in Sats" mean?
A: The floor price is given in satoshis—the smallest unit of Bitcoin (1 BTC = 100,000,000 Sats). This ensures precision in pricing low-value assets commonly seen in Bitcoin-native token markets.
Q: Is there a rate limit for this API?
A: While specific rate limits are not detailed here, best practices suggest implementing exponential backoff and caching mechanisms to ensure stable integration.
Q: How often is the data updated?
A: The API provides near real-time updates pulled from on-chain activity and marketplace listings, ensuring high accuracy for time-sensitive applications.
Q: Can I get historical data using this endpoint?
A: This endpoint returns current state data. For historical trends, consider polling the endpoint periodically and storing snapshots over time.
Q: Is authentication required to access this API?
A: No—this is a public endpoint that does not require API keys or authentication for basic access, making it easy to integrate into any frontend or backend system.
Example Request and Response
While full JSON examples aren't included here due to formatting constraints, a typical workflow involves sending an HTTP GET request with the runesId parameter and receiving a structured JSON object containing all the fields listed above.
For instance:
GET https://web3.okx.com/api/v5/mktplace/nft/runes/detail?runesId=840000:3Would return:
{
"rune": "CAT",
"spacename": "CAT.SAT",
"maxMintNumber": "21000000",
"mintedNumber": "18500000",
...
}Developers should validate response structures and handle optional fields gracefully.
👉 Start leveraging real-time Runes data for your next Web3 project now.
Final Thoughts
As the Web3 space continues to expand beyond Ethereum-centric ecosystems, tools like the Runes API play a crucial role in democratizing access to on-chain data. With its clean structure, robust parameter support, and rich dataset, this endpoint simplifies how developers interact with Bitcoin-based digital assets.
By integrating this API, you gain actionable insights into collection performance, user engagement, and market movements—all vital components for building intelligent, responsive decentralized applications.
Whether you're monitoring emerging runes or analyzing long-term trends, the ability to programmatically retrieve accurate NFT and token data has never been more accessible.