Skip to main content

GetTotemDividends

Retrieves dividend payments for a totem.

Endpoint: GET /nxt?requestType=GetTotemDividends

Parameters:

  • totem (long, optional): Totem ID to filter by
  • firstIndex (int, optional, default: 0): Starting index for pagination
  • lastIndex (int, optional, default: 99): Ending index for pagination
  • timestamp (int, optional, default: 0): Minimum timestamp to include (epoch seconds)
  • includeHoldingInfo (boolean, optional, default: false): Include holding information in results

Request Example: /nxt?requestType=GetTotemDividends&totem=123456789&timestamp=123456000

Response:

{
"dividends": [
{
"totemDividendFullHash": "abc123...",
"totem": "123456789",
"amountMTAPerShare": "100",
"totalDividend": "100000000",
"dividendHeight": 123450,
"numberOfAccounts": 100,
"height": 123456,
"timestamp": 123456789,
"holding": "123456789",
"holdingType": 1
}
]
}

Response Fields:

  • dividends: array - Array of dividend objects
  • dividends[].totemDividendFullHash: string - Full hash of the dividend transaction
  • dividends[].totem: string - Totem ID (unsigned string)
  • dividends[].amountMTAPerShare: string - Dividend amount per share in MTA
  • dividends[].totalDividend: string - Total dividend amount in MTA
  • dividends[].dividendHeight: number - Block height at which dividend was calculated
  • dividends[].numberOfAccounts: number - Number of accounts eligible for dividend
  • dividends[].height: number - Block height of dividend payment
  • dividends[].timestamp: number - Timestamp of dividend payment
  • dividends[].holding: string - Holding ID (unsigned string)
  • dividends[].holdingType: number - Type of holding (1=TOTEM)
  • dividends[].holdingInfo: object - Only if includeHoldingInfo=true, contains holding details from holdingInfoJson()

Source: GetTotemDividends.java, JSONData.totemDividend() Notes: Entries filtered by timestamp. Can query by chain.