Overview
This API enables developers to retrieve Runes token listings on OKX, providing access to specific collection details via runesId
. The interface supports advanced filtering, sorting, and pagination for seamless marketplace integration.
API Endpoint
GET https://web3.okx.com/api/v5/mktplace/nft/runes/get-runes-order-list
Key Features
- Collection-Specific Retrieval: Fetch listings using unique
runesId
- Dynamic Sorting: Six sorting options including price/time ascending/descending
- Pagination Support: Process large datasets efficiently (up to 100 records per request)
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
runesId | String | Yes | Unique identifier for the Runes token collection |
cursor | String | No | Pagination marker (max 1,000 records) |
limit | Integer | No | Results per page (default: 10, max: 100) |
sortBy | String | No | Sorting method: unitPriceAsc , unitPriceDesc , totalPriceAsc , etc. |
Response Data Structure
Field | Type | Description |
---|---|---|
assetId | Integer | Database primary key |
ticker | Integer | Token name identifier |
ownerAddress | String | Wallet address holding the asset |
amount | String | XRC20 token quantity |
listTime | Long | Unix timestamp of listing |
price | BigDecimal | BTC-denominated total price |
usdPrice | BigDecimal | USD conversion value |
๐ Explore Runes token marketplace
Implementation Notes
- Rate Limiting: Adhere to OKX API request limits
- Error Handling: Check
status
field for listing validity (0=unlisted, 1=listed) - Currency Conversion: All prices include BTC, USD, and satoshi values
FAQ
What is the maximum number of listings per request?
The API returns up to 100 listings per call. Use the cursor
parameter for pagination.
How do I sort by cheapest available Runes?
Set sortBy=unitPriceAsc
to prioritize lowest unit prices.
Can I filter unavailable listings?
Yes - check the unavailable
flag (1=multi-asset UTXO, 2=multi-protocol UTXO).
๐ View complete API documentation
Best Practices
- Cache frequently accessed
runesId
data - Monitor
inscriptionNum
for unique token identification - Verify
confirmations
count for transaction security
This comprehensive integration solution empowers developers to build efficient Runes marketplace applications with robust data access capabilities.