Skip to main content

GetTotemProperties

Retrieves properties for totems, filtered by totem ID, setter account, and/or property key.

Endpoint: GET /nxt?requestType=GetTotemProperties

Parameters:

  • totem (long, optional): Totem ID to filter by
  • setter (long, optional): Account ID of the property setter
  • property (string, optional): Property key to filter by
  • firstIndex (int, optional, default: 0): Starting index for pagination
  • lastIndex (int, optional, default: 99): Ending index for pagination

Request Example: /nxt?requestType=GetTotemProperties&totem=123456789&setter=987654321

Response:

{
  "totem": "123456789",
  "setter": "987654321",
  "properties": [
    {
      "totem": "123456789",
      "setter": "987654321",
      "property": "Freeze",
      "value": "1000000",
      "certificateId": "123456789"
    },
    {
      "totem": "123456789",
      "setter": "987654321",
      "property": "certificateId",
      "value": "CERT12345"
    }
  ],
  "moreAvailable": false
}

Response Fields:

  • totem: string - Totem ID (unsigned string), only if totem parameter provided
  • setter: string - Setter account ID (unsigned string), only if setter parameter provided
  • properties: array - Array of property objects
  • properties[].totem: string - Totem ID (unsigned string), only if includeTotem=true in request
  • properties[].setter: string - Setter account ID (unsigned string), only if includeSetter=true in request
  • properties[].property: string - Property key
  • properties[].value: string - Property value
  • properties[].certificateId: string - Certificate ID (unsigned string), only if property has certificate
  • moreAvailable: boolean - True if more properties exist beyond the page

Source: GetTotemProperties.java, JSONData.totemProperty() Notes: At least one of totem or setter must be provided. Pagination fetches extra item for moreAvailable. Not chain-specific.