Skip to content

Update mpt_holders, Get MPTokenIssuance, and Get MPToken with Mainnet "Try It" example #3357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update mpt_holders, Get MPTokenIssuance, and Get MPToken with Mainnet "Try It" example #3357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26fb877
Update mpt_holders method with Mainnet example
maria-robobug Oct 16, 2025
bc5e48a
Update Get MPT Issuance + Get MPToken
maria-robobug Oct 16, 2025
a2e5c3a
Remove unnecessary env
maria-robobug Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h
```json
{
"command": "mpt_holders",
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated"
}
```
Expand All @@ -36,7 +36,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h
"method": "mpt_holders",
"params": [
{
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated"
}
]
Expand All @@ -46,7 +46,7 @@ For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all h

{% /tabs %}

{% try-it method="mpt_holders" server="devnet-clio" /%}
{% try-it method="mpt_holders" /%}

The request contains the following parameters:

Expand All @@ -65,19 +65,20 @@ The request contains the following parameters:
```json
{
"result": {
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"limit": 50,
"ledger_index": 2414929,
"ledger_index": 99563041,
"mptokens": [
{
"account": "rfyWeQpYM3vCXRHA9cMLs2ZEdZv1F1jzm9",
"account": "rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP",
"flags": 0,
"mpt_amount": "200",
"mptoken_index": "22F99DCD55BCCF3D68DC3E4D6CF12602006A7563A6BE93FC57FD63298BCCEB13"
"mpt_amount": "100",
"mptoken_index": "081078D38E9C36647B4AD95ECB476F434B817753AD4F6B4B5EE0ED4C3185C80F"
}
],
"validated": true
},
"id": "example_mpt_holders",
"status": "success",
"type": "response",
"warnings": [
Expand All @@ -96,15 +97,15 @@ The request contains the following parameters:

{
"result": {
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"limit": 50,
"ledger_index": 2415033,
"ledger_index": 99563067,
"mptokens": [
{
"account": "rfyWeQpYM3vCXRHA9cMLs2ZEdZv1F1jzm9",
"account": "rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP",
"flags": 0,
"mpt_amount": "200",
"mptoken_index": "22F99DCD55BCCF3D68DC3E4D6CF12602006A7563A6BE93FC57FD63298BCCEB13"
"mpt_amount": "100",
"mptoken_index": "081078D38E9C36647B4AD95ECB476F434B817753AD4F6B4B5EE0ED4C3185C80F"
}
],
"validated": true,
Expand Down
33 changes: 14 additions & 19 deletions ...eferences/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ In addition to the general fields above, you must specify *exactly 1* of the fol
- [Get DepositPreauth Entry](#get-depositpreauth-entry)
- [Get Ticket Entry](#get-ticket-entry)
- [Get NFT Page](#get-nft-page)
- [Get MPT Issuance Object](#get-mpt-issuance-object)
- [Get MPToken Object](#get-mptoken-object)
- [Get MPT Issuance Entry](#get-mpt-issuance-entry)
- [Get MPToken Entry](#get-mptoken-entry)
- [Response Format](#response-format)
- [Possible Errors](#possible-errors)

Expand Down Expand Up @@ -885,7 +885,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0

{% try-it method="ledger_entry-nft-page" /%}

### Get MPT Issuance Object
### Get MPT Issuance Entry

Return an `MPTokenIssuance` object.

Expand All @@ -902,7 +902,7 @@ Return an `MPTokenIssuance` object.
{
"id": "example_get_mpt_issuance",
"command": "ledger_entry",
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
"mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated"
}
```
Expand All @@ -913,7 +913,7 @@ Return an `MPTokenIssuance` object.
{
"method": "ledger_entry",
"params": [{
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
"mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated"
}]
}
Expand All @@ -922,16 +922,14 @@ Return an `MPTokenIssuance` object.

{% tab label="Commandline" %}
```sh
rippled json ledger_entry '{ "mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E", "ledger_index": "validated" }'
rippled json ledger_entry '{ "mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA", "ledger_index": "validated" }'
```
{% /tab %}
{% /tabs %}

<!-- TODO: add try-it for MPT issuance
{% try-it method="ledger_entry-mpt_issuance" /%}
-->
{% try-it method="ledger_entry-mptokenissuance" /%}

### Get MPToken Object
### Get MPToken Entry

Return an `MPToken` object.

Expand All @@ -948,11 +946,11 @@ Return an `MPToken` object.
{% tab label="WebSocket" %}
```json
{
"id": "example_get_mpt_issuance",
"id": "example_get_mpt",
"command": "ledger_entry",
"mptoken": {
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
}
}
```
Expand All @@ -965,8 +963,8 @@ Return an `MPToken` object.
"params": [
{
"mptoken":{
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
}
}
]
Expand All @@ -976,15 +974,12 @@ Return an `MPToken` object.

{% tab label="Commandline" %}
```sh
rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D", "account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"} }'
rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA", "account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"} }'
```
{% /tab %}
{% /tabs %}

<!-- TODO: make a try-it link for MPT object
{% try-it method="ledger_entry-mptoken" /%}
-->


## Response Format

Expand Down
26 changes: 25 additions & 1 deletion resources/dev-tools/components/websocket-api/data/command-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@
"body": {
"id": "example_mpt_holders",
"command": "mpt_holders",
"mpt_issuance_id": "0024D204E07DDDFBCD83B1649C07FE27FD536A3A32E6FDD8",
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated"
}
}
Expand Down Expand Up @@ -802,6 +802,30 @@
},
"ledger_index": "validated"
}
},
{
"name": "ledger_entry - MPTokenIssuance",
"description": "Returns an MPTokenIssuance object in its raw ledger format.",
"link": "/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry#get-mpt-issuance-entry",
"body": {
"id": "example_get_mpt_issuance",
"command": "ledger_entry",
"mpt_issuance": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"ledger_index": "validated"
}
},
{
"name": "ledger_entry - MPToken",
"description": "Returns an MPToken object in its raw ledger format.",
"link": "/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry#get-mptoken-entry",
"body": {
"id": "example_get_mpt",
"command": "ledger_entry",
"mptoken": {
"mpt_issuance_id": "05EECEBE97A7D635DE2393068691A015FED5A89AD203F5AA",
"account":"rsNw23ygZatXv7h8QVSgAE4jktY2uW1iZP"
}
}
}
]
}
Expand Down