Skip to main content

nft_buy_offers

POST
Returns the list of buy offers on a given NFToken.It lets you check the offered amount and the creator of each offer.

📘 If the NFToken has no buy offers, an objectNotFound error is returned.

param[0]
parametersobjectrequired
nft_idstringrequired
The identifier of the NFToken to look up.
limitinteger
The number of offers to return. Pass a value between 50 and 500.
markerstring
A value that marks a pagination position. Pass the marker value from a previous response to retrieve the next page.Its format depends on the server implementation, so use it verbatim without interpreting its contents.
ledger_hashstring
The hash of the ledger version to use. Pass a 32-byte hex string.
ledger_indexoneOf
Specifies the ledger version to use. Pass a ledger index as an integer, or use one of the shortcut strings below.
  • validated: Uses the most recent ledger version validated by the network.
  • closed: Uses the most recent ledger version the server has closed. It may not be validated.
  • current: Uses the in-progress ledger version the server is currently building.
The ledger index of the version to use.
Responses
nft_idstring
The identifier of the NFToken from the request.
The list of offers.
amountoneOf
Represents an amount. XRP is expressed as a string in drops; tokens are expressed as an object.
An XRP amount in drops. 1 XRP equals 1,000,000 drops.
flagsinteger
A bit-map of flags enabled for the offer.
nft_offer_indexstring
The ID that identifies this offer ledger entry.
ownerstring
The address of the account that created the offer.
destinationstring
The address of the account designated to accept this offer. Returned only when one is designated.
expirationinteger
The expiration time of the offer, in seconds since the Ripple Epoch. Returned only when an expiration is set.
limitinteger
The limit value used in the request.
markerstring
A value that marks a pagination position. Pass the marker value from a previous response to retrieve the next page.Its format depends on the server implementation, so use it verbatim without interpreting its contents.
codestringrequired
Code identifying the cause of the failed request.
messagestringrequired
Detailed message including the name and value of the invalid parameter.
{
  "code": "ERROR_CODE",
  "message": "Unauthorized"
}
cURL
curl -X POST 'https://xrpl-mainnet.nodit.io' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "method": "nft_buy_offers",
    "params": [
      {
        "nft_id": "000800006203F49C21D5D6E022CB16DE3538F248662FC73C00000E39",
        "limit": 250
      }
    ]
  }'