The Runes protocol has emerged as a groundbreaking development in the blockchain space, enabling token creation and transfers directly on Bitcoin through UTXO-based mechanics. For developers and platforms aiming to integrate real-time marketplace data, the Runes API by OKX provides a powerful, scalable solution for retrieving live listing information from the OKX Runes marketplace.
Whether you're building a Web3 analytics dashboard, a decentralized NFT marketplace, or a wallet interface that supports Runes tokens, this API allows seamless access to critical market data — all with minimal latency and maximum reliability.
This guide dives deep into the get-runes-order-list
endpoint, detailing how to fetch listings using runesId
, apply sorting and pagination, and interpret response data for downstream applications.
🔍 Understanding the Runes Listing API
The get-runes-order-list
endpoint is designed to return current order listings for a specific Runes collection. By querying this API, developers can retrieve comprehensive details including pricing (in BTC, USD, and satoshis), listing status, owner addresses, and blockchain-level metadata such as transaction hashes and UTXO values.
This makes it ideal for:
- Real-time price tracking
- Market aggregation tools
- On-chain analytics platforms
- Wallet integrations displaying asset listings
👉 Access live Runes market data seamlessly with advanced Web3 APIs.
🛠️ Endpoint Details
Request URL
GET https://web3.okx.com/api/v5/mktplace/nft/runes/get-runes-order-list
This secure HTTPS endpoint supports cross-origin requests and returns JSON-formatted responses optimized for programmatic consumption.
📥 Request Parameters
To customize your query and retrieve targeted data, the following parameters are available:
Parameter | Type | Required | Description |
---|---|---|---|
runesId | String | Yes | The unique identifier of the Runes token (e.g., "RUNES-12345"). This is mandatory to specify which collection's listings you want. |
cursor | String | No | Used for pagination; represents the position in the dataset. Maximum depth: 1,000 records. |
limit | Integer | No | Number of results per page. Default: 10. Maximum: 100. |
sortBy | String | No | Sorting rule for returned orders. Options include: • unitPriceAsc – Lowest unit price first• unitPriceDesc – Highest unit price first• totalPriceAsc , totalPriceDesc • listedTimeAsc , listedTimeDesc |
✅ Tip: Use limit=100
and manage cursors efficiently to minimize request frequency when syncing large datasets.
📤 Response Parameters
Each returned listing includes rich on-chain and marketplace metadata:
Field | Type | Description |
---|---|---|
assetId | Integer | Internal database ID (no functional use) |
tickerType | String | Token standard — "4" indicates Runes |
ticker | Integer | Numeric representation of token name |
tickerId | String | Unique token identifier |
ownerAddress | String | Owner’s wallet address |
amount | String | XRC20 amount held in UTXO |
chain | Integer | Blockchain network ID |
inscriptionNum | String | Associated inscription number |
utxoTxHash | String | Transaction hash of the UTXO |
utxoVout | Integer | Output index in transaction |
utxoValue | String | Value of the UTXO in satoshis |
txHash | String | Listing transaction hash |
name | String | Full name of the token |
tickerIcon | String | URL to token icon image |
status | Integer | Listing state: 0 = unlisted, 1 = active, 2 = pending |
listTime | Long | Timestamp (ms) when listed |
orderId | Long | Unique order identifier |
confirmations | Long | Block confirmations for listing tx |
currency , price , satPrice , usdPrice (repeated for unit/total) | Mixed | Pricing details in multiple formats |
unavailable | Integer | Flags if UTXO contains mixed assets (1 = multiple Atomicals, 2 = multiple protocols) |
symbol | String | Token ticker symbol (e.g., "PEPE") |
⚠️ Note: The same field names likecurrency
,price
, etc., appear under different contexts (unit vs total). Always parse based on context within the response structure.
🧪 Example Usage
Sample Request
GET https://web3.okx.com/api/v5/mktplace/nft/runes/get-runes-order-list?runesId=RUNES-7890&limit=5&sortBy=unitPriceAsc
This retrieves the five cheapest listings for RUNES-7890 by unit price.
Sample Response (Simplified)
{
"code": "0",
"msg": "",
"data": [
{
"orderId": 1001,
"tickerId": "RUNES-7890",
"ownerAddress": "bc1qabc...xyz",
"amount": "1000",
"status": 1,
"listTime": 1715000000000,
"unitPrice": {
"currency": "BTC",
"price": "0.0005",
"satPrice": 50000,
"usdPrice": 30.5
},
"totalPrice": {
"currency": "BTC",
"price": "0.5",
"satPrice": 50000000,
"usdPrice": 30500
},
"symbol": "MOCK"
}
]
}
This shows an active listing with both unit and total pricing clearly broken down.
👉 Start integrating real-time Runes market data into your app today.
🔑 Core Keywords
To ensure strong SEO performance and visibility in search results related to blockchain and Web3 development, the following keywords have been naturally integrated throughout this article:
- Runes listing
- Runes API
- Marketplace API
- Web3 API
- Get Runes order list
- OKX Runes
- NFT marketplace API
- UTXO-based tokens
These reflect high-intent queries from developers and businesses exploring Runes ecosystem integration.
❓ Frequently Asked Questions
What is the Runes protocol?
Runes is a token protocol built on Bitcoin that uses UTXOs to manage fungible token balances. Unlike BRC-20, it avoids reliance on inscriptions for balance tracking, making it more efficient and scalable for decentralized exchanges and marketplaces.
Can I get listings for multiple runesId at once?
No. The current version of the API requires one request per runesId
. To monitor multiple collections, implement batched requests with proper rate-limiting.
How often is listing data updated?
The API reflects near real-time changes. Listings typically appear within seconds after confirmation on-chain, depending on block propagation and indexing speed.
Is there a rate limit for this API?
While not explicitly documented, best practices suggest limiting requests to no more than 20 per second per IP. For high-frequency use cases, consider caching strategies or leveraging WebSocket streams if available.
What does “unavailable” mean in the response?
An unavailable
value of 1 or 2 indicates the UTXO contains mixed assets (e.g., multiple Atomicals or protocol tokens), making it ineligible for clean transfer or listing.
How do I handle pagination with cursor?
Use the cursor
parameter to fetch subsequent pages. The response should include a next cursor value; if absent, you've reached the end of available data.
🚀 Final Thoughts
The OKX Runes API empowers developers to build next-generation Web3 experiences centered around Bitcoin-native tokens. With precise control over sorting, filtering, and pagination, the get-runes-order-list
endpoint delivers actionable insights straight from the marketplace floor.
Whether you're monitoring price trends, enabling peer-to-peer trading interfaces, or aggregating liquidity across Runes collections, this API lays the foundation for robust, data-driven applications.
👉 Unlock full potential of Runes with powerful Web3 API tools.