Honeycluster Docs – Get sell offers for an NFT

NFT Methods

Get sell offers for an NFT

wss://honeycluster.io

rpc method: nft_sell_offers

Returns a list of current sell offers for a specific NFToken.

Try it now

Response · nft_sell_offers WS Response

{
  "result": {
    "nft_id": "00080000B4F4AFC5984A241ACF7DBAF0FA866A7B95C0A4E8166DC5230000001B",
    "offers": [
      {
        "amount": "2000000",
        "flags": 1,
        "nft_offer_index": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
        "owner": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
      }
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

nft_sell_offers WS Request

application/json

Get sell offers for an NFT

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`nft_id`	string	The 256-bit hex NFTokenID of the NFT to list sell offers for.
`ledger_index`	object	A ledger index (sequence number) or shortcut string identifying which ledger to use.
`ledger_hash`	string	256-bit hex hash identifying a specific ledger version.
`limit`	integer	Maximum number of results to return. Clio servers may return more than this.
`marker`	object	Opaque pagination marker from a previous response. Pass unchanged to fetch the next page.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "nft_sell_offers",
  "id": 1,
  "nft_id": "00080000B4F4AFC5984A241ACF7DBAF0FA866A7B95C0A4E8166DC5230000001B",
  "ledger_index": "validated"
}

Response Message

nft_sell_offers WS Response

application/json

WebSocket response for nft_sell_offers

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {
    "nft_id": "00080000B4F4AFC5984A241ACF7DBAF0FA866A7B95C0A4E8166DC5230000001B",
    "offers": [
      {
        "amount": "2000000",
        "flags": 1,
        "nft_offer_index": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
        "owner": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
      }
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "nft_sell_offers",
    "id": 1,
    "nft_id": "00080000B4F4AFC5984A241ACF7DBAF0FA866A7B95C0A4E8166DC5230000001B",
    "ledger_index": "validated"
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · nft_sell_offers WS Response

{
  "result": {
    "nft_id": "00080000B4F4AFC5984A241ACF7DBAF0FA866A7B95C0A4E8166DC5230000001B",
    "offers": [
      {
        "amount": "2000000",
        "flags": 1,
        "nft_offer_index": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
        "owner": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
      }
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}