mpt_holders

For a given MPTokenIssuanceID and ledger sequence, mpt_holders returns all holders of that MPT and their balance. This method likely returns very large data sets, so you should expect to implement paging via the marker field. This API is only available using Clio, not rippled.

Request Format

{
  "command": "mpt_holders",
  "mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
  "ledger_index": "validated"
}

試してみる

The request contains the following parameters:

Field	Type	Required?	Description
`mpt_issuance_id`	String	Yes	The `MPTokenIssuance` to query.
`ledger_index`	Ledger Index	No	The Ledger Index of the max ledger to use, or a shortcut string to choose a ledger automatically. You must specify either `ledger_index` or `ledger_hash`. See Specifying Ledgers.
`ledger_hash`	String	No	A 32-byte hex string for the ledger version to use. You must specify either `ledger_index` or ledger_hash. See Specifying Ledgers.
`marker`	Marker	No	Used to continue your query where it left off in paginating.
`limit`	Number (positive integer)	No	Specify a limit to the number of MPTs returned.

Response Format

{
  "result": {
    "mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
    "limit": 50,
    "ledger_index": 2414929,
    "mptokens": [
      {
        "account": "rfyWeQpYM3vCXRHA9cMLs2ZEdZv1F1jzm9",
        "flags": 0,
        "mpt_amount": "200",
        "mptoken_index": "22F99DCD55BCCF3D68DC3E4D6CF12602006A7563A6BE93FC57FD63298BCCEB13"
      }
    ],
    "validated": true
  },
  "status": "success",
  "type": "response",
  "warnings": [
    {
      "id": 2001,
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
    }
  ]
}

Response Fields

The response follows the standard format, with the result containing the following fields:

Field	Type	Description
`mpt_issuance_id`	String	The `MPTokenIssuance` queried.
`mptokens`	Array	An array of MPTokens. Includes all relevant fields in the underlying `MPToken` object.
`marker`	Marker	Used to continue querying where we left off when paginating. Omitted if there are no more entries after this result.
`limit`	Number	The limit, as specified in the request.
`ledger_index`	Ledger Index	The index of the ledger used.
`validated`	Boolean	If `true`, the ledger has been validated by the consensus process and is immutable. Otherwise, the contents of the ledger are not final and may change. In Clio, this is always true as Clio stores and returns validated ledger data.

MPToken

An MPToken object has the following parameters:

Field	Type	Description
`account`	String	The account address of the holder who owns the `MPToken`.
`flags`	Number	The flags assigned to the`MPToken` object.
`mpt_amount`	String Number	Specifies a positive amount of tokens currently held by the owner.
`mptoken_index`	String	Key of the `MPToken` object.

Possible Errors

Any of the universal error types.
invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.