Get Runes Listings: Runes API and Marketplace Integration Guide

ยท

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


Request Parameters

ParameterTypeRequiredDescription
runesIdStringYesUnique identifier for the Runes token collection
cursorStringNoPagination marker (max 1,000 records)
limitIntegerNoResults per page (default: 10, max: 100)
sortByStringNoSorting method: unitPriceAsc, unitPriceDesc, totalPriceAsc, etc.

Response Data Structure

FieldTypeDescription
assetIdIntegerDatabase primary key
tickerIntegerToken name identifier
ownerAddressStringWallet address holding the asset
amountStringXRC20 token quantity
listTimeLongUnix timestamp of listing
priceBigDecimalBTC-denominated total price
usdPriceBigDecimalUSD conversion value

๐Ÿ‘‰ Explore Runes token marketplace


Implementation Notes

  1. Rate Limiting: Adhere to OKX API request limits
  2. Error Handling: Check status field for listing validity (0=unlisted, 1=listed)
  3. 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

This comprehensive integration solution empowers developers to build efficient Runes marketplace applications with robust data access capabilities.