28 KiB
html, parent, blurb, label
| html | parent | blurb | label | ||
|---|---|---|---|---|---|
| ledger_entry.html | ledger-methods.html | XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。 |
|
ledger_entry
ledger_entryメソッドは、XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。取得可能な各種オブジェクトについては、[レジャーフォーマット][]を参照してください。
要求フォーマット
このメソッドは複数の異なる種類のデータを取得することができます。以下に記載されている一般的なフィールドと特定のタイプのフィールドで構成される適切なパラメータを渡し、標準のリクエストフォーマットに従うことで、取得するアイテムの種類を選択できます。(例えば、WebSocketリクエストは常にcommandフィールドとオプションでidフィールドを持ち、JSON-RPCリクエストはmethodフィールドとparamsフィールドを使います)。
{% include '_snippets/no-cli-syntax.ja.md' %}
一般的なフィールド
| フィールド | 型 | 説明 |
|---|---|---|
binary |
ブール値 | (省略可) trueの場合、要求したレジャーオブジェクトの内容がXRPレジャーのバイナリ形式の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトはfalseです。[更新: rippled 1.2.0][] |
ledger_hash |
文字列 | (省略可) 使用するレジャーバージョンの20バイトの16進数の文字列。([レジャーの指定][]を参照してください |
ledger_index |
文字列 または 符号なし整数 | (省略可) 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列("validated"や"closed"、"current"など)。([レジャーの指定][]を参照してください) |
generatorとledgerパラメータは非推奨であり、予告なく削除される可能性があります。
上記の一般的なフィールドに加えて、オブジェクトを取得するタイプを示すために、以下のフィールドのうち 正確に1つ を指定する必要があります。有効なフィールドは以下のとおりです。
indexaccount_rootdirectoryofferripple_statecheckescrowpayment_channeldeposit_preauthticketnft_page
注意: リクエストでこれらの型固有のフィールドを1つ以上指定した場合、サーバはそのうちの1つだけの結果を取得します。サーバがどれを選択するかは定義されていないため、こうした行為は避けるべきです。
IDからレジャーオブジェクトを取得する
ユニークな ID を使用して、任意のタイプのレジャーオブジェクトを取得します。
| フィールド | 型 | 説明 |
|---|---|---|
index |
文字列 | レジャーから取得する1オブジェクトのオブジェクトIDを、64文字(256ビット)の16進数の文字列。 |
WebSocket
{
"command": "ledger_entry",
"index": "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4",
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [
{
"index": "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4",
"ledger_index": "validated"
}
]
}
コマンドライン
rippled json ledger_entry '{ "index": "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4", "ledger_index": "validated" }'
ヒント: このタイプのリクエストは、レジャーデータにシングルトンオブジェクトが存在する場合、そのIDは常に同一であるため、任意のシングルトンオブジェクトを取得するために使用できます。たとえば
Amendments-7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4FeeSettings-4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651- Recent History
LedgerHashes-B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66BNegativeUNL-2E8A59AA9D3B5B186B0B9E0F62E6C02587CA74A4D778938E957B6357D364B244
AccountRootオブジェクトを取得する
アドレスからAccountRootオブジェクトを取得します。これは[account_infoメソッド][]とほぼ同じです。
| フィールド | 型 | 説明 |
|:----------- ---|:--------------------|:----------------------|
| account_root | 文字列 - [アドレス][] | 取得するAccountRootオブジェクトの標準アドレス。 |
WebSocket
{
"id": "example_get_accountroot",
"command": "ledger_entry",
"account_root": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [
{
"account_root": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ledger_index": "validated"
}
]
}
コマンドライン
rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "ledger_index": "validated" }'
DirectoryNodeオブジェクトを取得する
他のレジャーオブジェクトのリストを含むDirectoryNodeを取得します。文字列(DirectoryのオブジェクトID)またはオブジェクトを指定します。
| フィールド | 型 | 説明 |
|---|---|---|
directory |
オブジェクト または 文字列 | 取得するDirectoryNode。文字列の場合は、ディレクトリのオブジェクトIDを16進数で指定します。オブジェクトの場合は、サブフィールドとしてdir_rootまたはownerが必要で、オプションとしてsub_indexサブフィールドを指定可能です。 |
directory.sub_index |
符号なし整数 | (省略可) 指定された場合、その"ページ"以降のDirectoryNodeにジャンプします。 |
directory.dir_root |
文字列 | (省略可) 取得するディレクトリを表す一意のインデックス。 |
directory.owner |
文字列 | (省略可) このディレクトリに関連付けられているアカウントの一意のアドレス。 |
WebSocket
{
"id": 3,
"command": "ledger_entry",
"directory": {
"owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"sub_index": 0
},
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [
{
"directory": {
"owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"sub_index": 0
},
"ledger_index": "validated"
}
]
}
コマンドライン
rippled json ledger_entry '{ "directory": { "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "sub_index": 0 }, "ledger_index": "validated" }'
Offerオブジェクトを取得する
通貨交換のオファーを定義した Offer オブジェクト を取得します。文字列 (オファーの一意なインデックス) あるいはオブジェクトを指定します。
| フィールド | 型 | 説明 |
|---|---|---|
offer |
オブジェクトまたは 文字列 | 取得するオファーオブジェクト。文字列の場合、オファーに対する一意のオブジェクトIDを指定します。オブジェクトの場合、オファーを一意に識別するためのサブフィールドaccountとseqを指定します。 |
offer.account |
文字列 - [アドレス][] | (offerがオブジェクト形式で指定されている場合、必須) オファーを作成したアカウント。 |
offer.seq |
符号なし整数 | (offerがオブジェクト形式で指定されている場合、必須) オファーオブジェクトを作成したトランザクションの[シーケンス番号][]。 |
WebSocket
{
"id": "example_get_offer",
"command": "ledger_entry",
"offer": {
"account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"seq": 359
},
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [
{
"offer": {
"account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"seq": 359
},
"ledger_index": "validated"
}
]
}
コマンドライン
rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "seq": 359}, "ledger_index": "validated" }'
RippleStateオブジェクトを取得する
2つのアカウント間の(XRP以外の)通貨残高を追跡するRippleStateオブジェクトを取得します。
| フィールド | 型 | 説明 |
|---|---|---|
ripple_state |
オブジェクト | 取得するRippleState(trust line)オブジェクトを指定するオブジェクト。取得するRippleStateエントリを一意に指定するには、accountsとcurrencyのサブフィールドが必要です。 |
ripple_state.accounts |
配列 | (ripple_stateが指定されている場合、必須) このRippleStateオブジェクトによってリンクされた2つのアカウントを長さ2の配列で指定します。 |
ripple_state.currency |
文字列 | (ripple_stateが指定されている場合、必須) 取得するRippleStateオブジェクトの[通貨コード][]を指定します。 |
WebSocket
{
"id": "example_get_ripplestate",
"command": "ledger_entry",
"ripple_state": {
"accounts": [
"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW"
],
"currency": "USD"
},
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [{
"ripple_state": {
"accounts": [
"rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW"
],
"currency": "USD"
},
"ledger_index": "validated"
}]
}
コマンドライン
rippled json ledger_entry '{ "ripple_state": { "accounts": ["rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW"], "currency": "USD"}, "ledger_index": "validated" }'
Checkオブジェクトを取得する
Checkオブジェクトを取得します。[新規: rippled 1.0.0][].
| フィールド | 型 | 説明 |
|---|---|---|
check |
文字列 | 取得するCheckオブジェクトのオブジェクトID。 |
WebSocket
{
"id": "example_get_check",
"command": "ledger_entry",
"check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D7944C28B95127C2659C47CBEB",
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [{
"check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D7944C28B95127C2659C47CBEB",
"ledger_index": "validated"
}]
}
コマンドライン
rippled json ledger_entry '{ "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D7944C28B95127C2659C47CBEB", "ledger_index": "validated" }'
Escrowオブジェクトを取得する
Escrowオブジェクトを取得します。文字列(エスクローのオブジェクトID)またはオブジェクトとして指定します。[新規: rippled 1.0.0][]
| フィールド | 型 | 説明 |
|---|---|---|
escrow |
オブジェクト または 文字列 | 取得するEscrowオブジェクトを指定します。文字列の場合は、エスクローのオブジェクトIDを16進数で指定します。オブジェクトの場合、ownerとseqサブフィールドを指定します。. |
escrow.owner |
文字列 - [アドレス][] | (escrowがオブジェクト形式で指定されている場合、必須) Escrowオブジェクトの所有者(送信者)。 |
escrow.seq |
符号なし整数 | (escrowがオブジェクト形式で指定されている場合、必須) エスクローオブジェクトを作成したトランザクションの[シーケンス番号][]。 |
WebSocket
{
"id": "example_get_escrow",
"command": "ledger_entry",
"escrow": {
"owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9NTjKK",
"seq": 126
},
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [{
"escrow": {
"owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9NTjKK",
"seq": 126
},
"ledger_index": "validated"
}]
}
コマンドライン
rippled json ledger_entry '{ "escrow": { "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9NTjKK", "seq": 126 }, "ledger_index": "validated" }'
PayChannelオブジェクトを取得する
非同期決済用のXRPを保持するPayChannelオブジェクトを取得します。[新規: rippled 1.0.0][].
| フィールド | 型 | 説明 |
|---|---|---|
payment_channel |
文字列 | 取得するPayChannelオブジェクトのオブジェクトID。 |
WebSocket
{
"id": "example_get_paychannel",
"command": "ledger_entry",
"payment_channel": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7",
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [{
"payment_channel": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7",
"ledger_index": "validated"
}]
}
コマンドライン
rippled json ledger_entry '{ "payment_channel": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7", "ledger_index": "validated" }'
DepositPreauthオブジェクトを取得する
DepositPreauthオブジェクトを取得します。このオブジェクトは、Deposit Authorizationを必要とする口座への支払いの事前承認を記録します。文字列(DepositPreauthのオブジェクトID)またはオブジェクトとして指定します。[新規: rippled 1.1.0][].
| フィールド | 型 | 説明 |
|---|---|---|
deposit_preauth |
オブジェクト または 文字列 | 取得するDepositPreauthオブジェクトを指定します。文字列の場合、DepositPreauthオブジェクトのオブジェクトIDを16進数で指定します。オブジェクトの場合、ownerとauthorizedのサブフィールドを指定します。 |
deposit_preauth.owner |
文字列 - [アドレス][] | (deposit_preauthがオブジェクト形式で指定されている場合、必須) 事前承認を行ったアカウント。 |
deposit_preauth.authorized |
文字列 - [アドレス][] | (deposit_preauthがオブジェクト形式で指定されている場合、必須) 事前承認を受けたアカウント。 |
WebSocket
{
"id": "example_get_deposit_preauth",
"command": "ledger_entry",
"deposit_preauth": {
"owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"authorized": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX"
},
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [{
"deposit_preauth": {
"owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"authorized": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX"
},
"ledger_index": "validated"
}]
}
コマンドライン
rippled json ledger_entry '{ "deposit_preauth": { "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "authorized": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX" }, "ledger_index": "validated" }'
Ticketオブジェクトを取得する
将来の使用のために確保された[シーケンス番号][]を表すTicketオブジェクトを取得します。文字列(TicketのオブジェクトID)またはオブジェクトを指定します。 ([TicketBatch amendment][]により追加されました。)
| フィールド | 型 | 説明 |
|---|---|---|
ticket |
オブジェクト または 文字列 | 取得するTicketオブジェクト。文字列の場合、チケットのオブジェクトIDを16進数で指定します。オブジェクトの場合、チケットエントリを一意に指定するためにaccountとticket_seqサブフィールドを指定します。 |
ticket.account |
文字列 - [アドレス][] | (ticketがオブジェクト形式で指定されている場合、必須) Ticketオブジェクトの所有者を指定します。 |
ticket.ticket_seq |
数値 | (ticketがオブジェクト形式で指定されている場合、必須) 取得するTicketのTicketシーケンス番号を指定します。 |
WebSocket
{
"id": "example_get_ticket",
"command": "ledger_entry",
"ticket": {
"account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ticket_seq": 389
},
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [{
"ticket": {
"account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ticket_seq": 389
},
"ledger_index": "validated"
}]
}
コマンドライン
rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "ticket_seq: 389 }, "ledger_index": "validated" }'
NFT Pageを取得する
NFT ページを生のレジャー形式で取得します。
| フィールド | 型 | 説明 |
|---|---|---|
nft_page |
文字列 | 取得するNFTページのオブジェクトID。 |
WebSocket
{
"id": "example_get_nft_page",
"command": "ledger_entry",
"nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF",
"ledger_index": "validated"
}
JSON-RPC
{
"method": "ledger_entry",
"params": [{
"nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF",
"ledger_index": "validated"
}]
}
コマンドライン
rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", "ledger_index": "validated" }'
応答フォーマット
レスポンスは[標準フォーマット][]に従って、成功結果には以下のフィールドが含まれます。
| フィールド | 型 | 説明 |
|---|---|---|
index |
文字列 | レジャーオブジェクトの一意のID。 |
ledger_index |
符号なし整数 | このデータを取得する際に使用したレジャーの [レジャーインデックス][]。 |
node |
オブジェクト | ("binary": trueが指定されている場合、省略) [レジャーフォーマット][]に基づいた、この元帳オブジェクトのデータを含むオブジェクト。 |
node_binary |
文字列 | ("binary": trueが指定されていない場合、省略) レジャーオブジェクトのバイナリ形式を16進数で表したもの。 |
処理が成功したレスポンスの例:
WebSocket
{
"id": "example_get_accountroot",
"result": {
"index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8",
"ledger_hash": "31850E8E48E76D1064651DF39DF4E9542E8C90A9A9B629F4DE339EB3FA74F726",
"ledger_index": 61966146,
"node": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"AccountTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
"Balance": "424021949",
"Domain": "6D64756F31332E636F6D",
"EmailHash": "98B4375E1D753E5B91627516F6D70977",
"Flags": 9568256,
"LedgerEntryType": "AccountRoot",
"MessageKey": "0000000000000000000000070000000300",
"OwnerCount": 12,
"PreviousTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
"PreviousTxnLgrSeq": 61965653,
"RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ",
"Sequence": 385,
"TransferRate": 4294967295,
"index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8"
},
"validated": true
},
"status": "success",
"type": "response"
}
JSON-RPC
200 OK
{
"result": {
"index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8",
"ledger_hash": "395946243EA36C5092AE58AF729D2875F659812409810A63096AC006C73E656E",
"ledger_index": 61966165,
"node": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"AccountTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
"Balance": "424021949",
"Domain": "6D64756F31332E636F6D",
"EmailHash": "98B4375E1D753E5B91627516F6D70977",
"Flags": 9568256,
"LedgerEntryType": "AccountRoot",
"MessageKey": "0000000000000000000000070000000300",
"OwnerCount": 12,
"PreviousTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
"PreviousTxnLgrSeq": 61965653,
"RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ",
"Sequence": 385,
"TransferRate": 4294967295,
"index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8"
},
"status": "success",
"validated": true
}
}
コマンドライン
{
"result": {
"index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8",
"ledger_hash": "395946243EA36C5092AE58AF729D2875F659812409810A63096AC006C73E656E",
"ledger_index": 61966165,
"node": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"AccountTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
"Balance": "424021949",
"Domain": "6D64756F31332E636F6D",
"EmailHash": "98B4375E1D753E5B91627516F6D70977",
"Flags": 9568256,
"LedgerEntryType": "AccountRoot",
"MessageKey": "0000000000000000000000070000000300",
"OwnerCount": 12,
"PreviousTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
"PreviousTxnLgrSeq": 61965653,
"RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ",
"Sequence": 385,
"TransferRate": 4294967295,
"index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8"
},
"status": "success",
"validated": true
}
}
考えられるエラー
- いずれかの[汎用エラータイプ][]。
deprecatedFeature- 削除されたフィールド(generatorなど)が要求に指定されていました。entryNotFound- 要求されたレジャーオブジェクトはレジャーに存在しません。invalidParams- 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。lgrNotFound-ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。malformedAddress- 要求の[アドレス][]フィールドが誤って指定されています。malformedCurrency- 要求の[通貨コード][]フィールドが誤って指定されています。malformedOwner- 要求のescrow.ownerサブフィールドが誤って指定されています。malformedRequest- 要求にフィールドが無効な組み合わせで指定されているか、1つ以上のフィールドの型が誤っています。unknownOption- 要求に指定されたフィールドが、予期される要求フォーマットのいずれにも一致していません。
{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}