|
| 1 | +--- |
| 2 | +seo: |
| 3 | + description: オーダーブック情報の変更をサブスクライブします。 |
| 4 | +labels: |
| 5 | + - 分散型取引所 |
| 6 | + - クロスカレンシー |
| 7 | +--- |
| 8 | +# book_changes |
| 9 | +[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/BookChanges.h "ソース") |
| 10 | + |
| 11 | +{% code-page-name /%} メソッドは、[分散型取引所（DEX）](../../../../concepts/tokens/decentralized-exchange/index.md) のオーダーブックの変更に関する情報を、以前のレジャーバージョンと比較して提供します。これは「ローソク足」チャートの作成に役立つ場合があります。 |
| 12 | + |
| 13 | +### リクエストのフォーマット |
| 14 | + |
| 15 | +リクエストの例: |
| 16 | + |
| 17 | +{% tabs %} |
| 18 | + |
| 19 | +{% tab label="WebSocket" %} |
| 20 | +```json |
| 21 | +{ |
| 22 | + "id": "example_book_changes", |
| 23 | + "command": "{% $frontmatter.seo.title %}", |
| 24 | + "ledger_index": 88530953 |
| 25 | +} |
| 26 | +``` |
| 27 | +{% /tab %} |
| 28 | + |
| 29 | +{% tab label="JSON-RPC" %} |
| 30 | +```json |
| 31 | +{ |
| 32 | + "method": "{% $frontmatter.seo.title %}", |
| 33 | + "params": [{ |
| 34 | + "ledger_index": 88530953 |
| 35 | + }] |
| 36 | +} |
| 37 | +``` |
| 38 | +{% /tab %} |
| 39 | + |
| 40 | +{% tab label="コマンドライン" %} |
| 41 | +```sh |
| 42 | +#Syntax: book_changes [<ledger hash|id>] |
| 43 | +rippled book_changes 88530953 |
| 44 | +``` |
| 45 | +{% /tab %} |
| 46 | + |
| 47 | +{% /tabs %} |
| 48 | + |
| 49 | +[試してみる! >](/resources/dev-tools/websocket-api-tool#book_changes) |
| 50 | + |
| 51 | +リクエストには以下のパラメーターが含まれます。 |
| 52 | + |
| 53 | +| フィールド | 型 | 必須? | 説明 | |
| 54 | +|:---------------|:-------------------------|:-------|------| |
| 55 | +| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの32バイトの16進文字列。(詳しくは[レジャーの指定][]をご覧ください。) | |
| 56 | +| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、または自動的にレジャーを選択するためのショートカット文字列。([レジャーの指定][]) | |
| 57 | + |
| 58 | +{% admonition type="warning" name="既知の問題" %} |
| 59 | +`rippled`のこのメソッドにいくつかの既知の問題があります。 |
| 60 | + |
| 61 | +- デフォルトまたはショートカット文字列を使用する代わりに、`ledger_index`または`ledger_hash`を明示的に指定する必要があります。([Issue #5034](https://github.com/XRPLF/rippled/issues/5034)) |
| 62 | +- JSON-RPC APIのレスポンスは、検証済みのレジャーをクエリする場合でも`validated`フィールドが欠落する可能性があります。([#5035](https://github.com/XRPLF/rippled/issues/5035)) |
| 63 | +- 最近閉じたレジャーをクエリする場合、成功したレスポンスが意図したデータの代わりにレジャーリクエストオブジェクトを返すことがあります。([#5033](https://github.com/XRPLF/rippled/issues/5033)) |
| 64 | +- 古いレジャーからデータをクエリする場合、サーバーが長時間（30秒以上）応答しない可能性があります。([#5036](https://github.com/XRPLF/rippled/issues/5036)) |
| 65 | + |
| 66 | +これらのバグはClioサーバーには適用されません。 |
| 67 | +{% /admonition %} |
| 68 | + |
| 69 | +## レスポンスのフォーマット |
| 70 | + |
| 71 | +成功したレスポンスの例: |
| 72 | + |
| 73 | +{% tabs %} |
| 74 | + |
| 75 | +{% tab label="WebSocket" %} |
| 76 | +{% code-snippet file="/_api-examples/book_changes/ws-response.json" language="json" /%} |
| 77 | +{% /tab %} |
| 78 | + |
| 79 | +{% tab label="JSON-RPC" %} |
| 80 | +{% code-snippet file="/_api-examples/book_changes/jsonrpc-response.json" language="json" prefix="200 OK\n\n" /%} |
| 81 | +{% /tab %} |
| 82 | + |
| 83 | +{% tab label="コマンドライン" %} |
| 84 | +{% code-snippet file="/_api-examples/book_changes/jsonrpc-response.json" language="json" prefix="Loading: \"/etc/opt/ripple/rippled.cfg\"\n2024-Jun-07 18:41:45.257772761 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005\n\n" /%} |
| 85 | +{% /tab %} |
| 86 | + |
| 87 | +{% /tabs %} |
| 88 | + |
| 89 | +このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。 |
| 90 | + |
| 91 | +| フィールド | 型 | 説明 | |
| 92 | +|:---------------|:-------------------------|:-----------------| |
| 93 | +| `changes` | 配列 | このレジャーバージョンで更新された各オーダーブックの[Book Updateオブジェクト](#book-updateオブジェクト)のリスト。オーダーブックが更新されなかった場合、配列は空になります。 | |
| 94 | +| `ledger_hash` | [ハッシュ][] | このデータを取得する際に使用されたレジャーバージョンの識別ハッシュ。 | |
| 95 | +| `ledger_index` | [レジャーインデックス][] | このデータを取得する際に使用されたレジャーバージョンのレジャーインデックス。 | |
| 96 | +| `ledger_time` | 数値 | このデータを取得する際に使用されたレジャーバージョンの公式クローズ時間。[リップルエポックからの秒数][]で表されます。 | |
| 97 | +| `type` | 文字列 | 文字列`bookChanges`。これはオーダーブック更新メッセージであることを示します。 | |
| 98 | +| `validated` | 真偽値 | _(省略可)_ `true`の場合、検証済みのレジャーバージョンから取得されたことを表します。 | |
| 99 | + |
| 100 | +### Book Updateオブジェクト |
| 101 | + |
| 102 | +Book Updateオブジェクトは、1つのレジャーバージョンにおける1つのオーダーブックの変更を表し、次のフィールドを含みます。 |
| 103 | + |
| 104 | +| フィールド | 型 | 説明 | |
| 105 | +|:---------------|:-----------------|:------------------------| |
| 106 | +| `currency_a` | 文字列 | オーダーブック内の2つの通貨のうちの最初の通貨の識別子。XRPの場合、これは文字列`XRP_drops`です。[トークン](../../../../concepts/tokens/index.md)の場合、[base58][]で表された発行者のアドレスの後にスラッシュ(`/`)が続き、その後に[通貨コード][]が続きます。これは3文字の標準コードまたは20文字の16進コードになります。 | |
| 107 | +| `currency_b` | 文字列 | オーダーブック内の2つの通貨のうちの2番目の通貨の識別子。これは`currency_a`と同じ形式ですが、`currency_b`はXRPになることはありません。 | |
| 108 | +| `volume_a` | 文字列 - 数値 | このレジャーバージョンでこのオーダーブックの取引を通じて移動した最初の通貨（つまり`currency_a`）の総量、または _取引高_。 | |
| 109 | +| `volume_b` | 文字列 - 数値 | このレジャーバージョンでこのオーダーブックの取引を通じて移動した2番目の通貨（つまり`currency_b`）の取引高。 | |
| 110 | +| `high` | 文字列 - 数値 | このレジャーバージョンでこのオーダーブックの取引を通じてマッチしたすべてのオファーの中で最も高い取引レート。最初の通貨と2番目の通貨の比率として表されます。（つまり、`currency_a : currency_b`。） | |
| 111 | +| `low` | 文字列 - 数値 | このレジャーバージョンでこのオーダーブックの取引を通じてマッチしたすべてのオファーの中で最も低い取引レート。最初の通貨と2番目の通貨の比率として表されます。 | |
| 112 | +| `open` | 文字列 - 数値 | このレジャーバージョンでこのオーダーブックの取引を処理する前のオーダーブックの最初の取引の取引レート。最初の通貨と2番目の通貨の比率として表されます。 | |
| 113 | +| `close` | 文字列 - 数値 | このレジャーバージョンでこのオーダーブックの取引を処理した後のオーダーブックの最初の取引の取引レート。最初の通貨と2番目の通貨の比率として表されます。 | |
| 114 | + |
| 115 | +XRP-トークンのオーダーブックでは、XRPは常に`currency_a`で表されます。トークン-トークンのオーダーブックでは、発行者と通貨コードでアルファベット順に並べ替えられます。 |
| 116 | + |
| 117 | +XRPに関する取引レートは常に[XRPのdrop数][]を使用して計算されます。例えば、XRPからFOOへのレートが1.0 XRP に対して 1 FOOの場合、APIによって報告されたレートは`1000000`（1 FOOあたり100万ドロップのXRP）になります。 |
| 118 | + |
| 119 | +## 考えられるエラー |
| 120 | + |
| 121 | +* いずれかの[汎用エラータイプ][]。 |
| 122 | +* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。 |
| 123 | +* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。 |
| 124 | + |
| 125 | +{% raw-partial file="/docs/_snippets/common-links.md" /%} |
0 commit comments