Marketplace API
Get Runes listing

Get Runes listing#

This API is used to get listings on OKX Runes, supporting retrieving specific collection listing information by runesId.

Request address#

GET https://www.okx.com/api/v5/mktplace/nft/runes/get-runes-order-list

Request parameters#

ParameterTypeRequiredDescription
runesIdStringYesrunesId, the unique identifier for the runes token
cursorStringNoCursor pointing to the sorting sequence to retrieve (maximum 1,000)
limitIntegerNoPagination size (default value 10, maximum 100). Returns the maximum number of orders
sortByStringNoOrder sorting rule, default is ascending unit price (unitPriceAsc). Sorting enum: unitPriceAsc, unitPriceDesc, totalPriceAsc, totalPriceDesc, listedTimeAsc, listedTimeDesc

Response parameters#

ParameterTypeDescription
assetIdIntegerid (DB primary key, no actual meaning)
tickerTypeStringToken type (4-Runes)
tickerIntegerToken name
tickerIdStringToken id
ownerAddressStringWallet address
amountStringXRC20 amount in the UTXO
chainIntegerChain
inscriptionNumStringInscription number
utxoTxHashStringTransaction hash
utxoVoutIntegerutxoVout
utxoValueStringutxoValue
txHashStringTransaction hash
nameStringToken name
tickerIconStringToken icon link
statusIntegerListing status (0-unlisted, 1-listed, 2-pending)
listTimeLongListing time
orderIdLongOrder id
confirmationsLongBlock height information
currencyStringTotal price - currency
currencyUrlStringTotal price - currency URL
satPriceBigDecimalTotal price in sat
priceBigDecimalTotal price in BTC
usdPriceBigDecimalTotal price in USD
currencyStringUnit price - currency
currencyUrlStringUnit price - currency URL
satPriceBigDecimalUnit price in sat
priceBigDecimalUnit price in BTC
usdPriceBigDecimalUnit price in USD
unavailableInteger1 - UTXO contains multiple Atomicals assets; 2 - UTXO contains multiple protocol assets
symbolStringSymbol

Request example#

shell
curl --location --request GET 'https://beta.okex.org/api/v5/mktplace/nft/runes/get-runes-order-list?runesId=840000:3' \
--header 'OK-ACCESS-KEY: XXXX' \
--header 'OK-ACCESS-PASSPHRASE: XXXX'

Response example#

200
{
    "code": 0,
    "data": {
        "cursor": "1",
        "items": [
            {
                "amount": "889806",
                "assetId": "28734126488062286",
                "chain": 0,
                "confirmations": null,
                "inscriptionNum": "",
                "listTime": 1714398972,
                "name": "DOG•GO•TO•THE•MOON",
                "orderId": 201268,
                "ownerAddress": "bc1pxav32udnt0062dlvmjn7tp3qneamudpg492t7qmxsu7m73ldd7uq768q8p",
                "status": 1,
                "symbol": "🐕",
                "ticker": "DOG•GO•TO•THE•MOON",
                "tickerIcon": "https://static.coinall.ltd/cdn/web3/currency/token/1714125941761.png/type=png_350_0",
                "tickerId": "840000:3",
                "tickerType": 4,
                "totalPrice": {
                    "currency": "BTC",
                    "currencyUrl": "https://static.coinall.ltd/cdn/nft/4834651a-7c4e-4249-91c1-cf680af39dc0.png",
                    "price": "0.05472306",
                    "satPrice": "5472306",
                    "usdPrice": "3388.298650632"
                },
                "txHash": "",
                "unavailable": null,
                "unitPrice": {
                    "currency": "BTC",
                    "currencyUrl": "https://static.coinall.ltd/cdn/nft/4834651a-7c4e-4249-91c1-cf680af39dc0.png",
                    "price": "0.0000000615",
                    "satPrice": "6.15",
                    "usdPrice": "0.0038079078"
                },
                "utxoTxHash": "80efaeffcbf70be91579afb631e45cd28df75b0883f45525d1bb6b04b21969f3",
                "utxoValue": "546",
                "utxoVout": 1015
            }
        ]
    },
    "msg": ""
}