Sandbox version
For experimental use only. Proceed with caution.
nftokens
Get an NFT by NFTokenOffer ID
get
/nft/by-offer/{offerId}
operationId: nft-getByOffer

Resolves a single on-chain NFTokenOffer object ID to the NFT it targets. Returns the same nftDetail shape as /nft/{nftId} (subject to the same metadata / metrics inclusion flags). Returns null when the offer is not indexed. Pairs with /nft/by-offers (batch).

Unlock protected endpoints

Enter your Bearer token once to enable every protected route in this API reference.

HTTP bearer

Saved for this browser tab only. The credential is never sent until you test an endpoint.

Authorizations
NameLocationDetails
BearerAuthAuthorization header · bearerJWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.
Path Parameters
NameTypeDefaultDescription
offerId
required
string
On-chain NFTokenOffer object ID (64-char hex).
Query Parameters
NameTypeDefaultDescription
metadata
boolean
metrics
boolean
Responses
200
application/json
Successful response
Example
Json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "token_id": "string",
  "issuer": "string",
  "owner": "string",
  "taxon": 0,
  "serial_number": 0,
  "uri": "string",
  "transfer_fee": 0,
  "flags": {
    "burnable": false,
    "only_xrp": false,
    "trust_line": false,
    "transferable": false,
    "mutable": false
  },
  "burned": false,
  "burned_at": 1745798400,
  "minted_at_ledger": 0,
  "mint_tx_hash": "string",
  "metadata": {
    "asset": {
      "name": "string",
      "description": "string",
      "meta_url": "string",
      "media_url": "string",
      "external_url": "string",
      "marketplace": "string"
    },
    "collection": {
      "issuer": "string",
      "taxon": 0,
      "name": "string",
      "description": "string",
      "image_url": "string"
    }
  },
  "metrics": {
    "total_sales": 0,
    "total_volume_xrp": "string",
    "last_sale_price_xrp": "string",
    "last_sale_at": 1745798400,
    "current_floor_offer_xrp": "string"
  }
}
400
application/json
Invalid input data
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
401
application/json
Authorization not provided
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
403
application/json
Insufficient access
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
404
application/json
Not found
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
500
application/json
Internal server error
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}