Rename API method categories

2025-11-30 08:35:50 +00:00 · 2022-06-28 04:09:37 -07:00
parent 42117756c6
commit 3458809228
160 changed files with 279 additions and 257 deletions
--- a/content/references/http-websocket-apis/public-api-methods/account-methods/account_lines.ja.md
+++ b/content/references/http-websocket-apis/public-api-methods/account-methods/account_lines.ja.md
@@ -0,0 +1,195 @@
+---
+html: account_lines.html
+parent: account-methods.html
+blurb: アカウントのトラストラインに関する情報を返します。
+labels:
+  - トークン
+---
+# account_lines
+[[ソース]](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/AccountLines.cpp "Source")
+
+`account_lines`メソッドは、アカウントのトラストラインに関する情報（XRP以外のあらゆる通貨の残高と資産など）を返します。取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
+
+## 要求フォーマット
+
+要求フォーマットの例:
+
+<!-- MULTICODE_BLOCK_START -->
+
+*WebSocket*
+
+```
+{
+  "id": 1,
+  "command": "account_lines",
+  "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
+}
+```
+
+*JSON-RPC*
+
+```
+{
+    "method": "account_lines",
+    "params": [
+        {
+            "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
+        }
+    ]
+}
+```
+
+<!-- MULTICODE_BLOCK_END -->
+
+[試してみる >](websocket-api-tool.html#account_lines)
+
+要求には以下のパラメーターを指定できます。
+
+| `Field`        | 型                                         | 説明           |
+|:---------------|:-------------------------------------------|:---------------|
+| `account` | 文字列 | アカウントの一意のIDであり、通常はアカウントの[アドレス][]です。 |
+| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
+| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
+| `peer` | 文字列 | _（省略可）_ 2番目のアカウントの[アドレス][]。指定されている場合は、2つのアカウントを結ぶトラストラインだけが出力されます。 |
+| `limit` | 整数 | （省略可、デフォルト値は可変）取得するトラストラインの数を制限します。サーバーはこの値を受け入れる必要はありません。10以上400以下の範囲で値を指定する必要があります。[新規: rippled 0.26.4][] |
+| `marker` | [マーカー][] | _（省略可）_ 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。[新規: rippled 0.26.4][] |
+
+以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。`ledger`および`peer_index`。
+
+## 応答フォーマット
+
+処理が成功した応答の例:
+
+<!-- MULTICODE_BLOCK_START -->
+
+*WebSocket*
+
+```
+{
+    "id": 1,
+    "status": "success",
+    "type": "response",
+    "result": {
+        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+        "lines": [
+            {
+                "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
+                "balance": "0",
+                "currency": "ASP",
+                "limit": "0",
+                "limit_peer": "10",
+                "quality_in": 0,
+                "quality_out": 0
+            },
+            {
+                "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
+                "balance": "0",
+                "currency": "XAU",
+                "limit": "0",
+                "limit_peer": "0",
+                "no_ripple": true,
+                "no_ripple_peer": true,
+                "quality_in": 0,
+                "quality_out": 0
+            },
+            {
+                "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
+                "balance": "3.497605752725159",
+                "currency": "USD",
+                "limit": "5",
+                "limit_peer": "0",
+                "no_ripple": true,
+                "quality_in": 0,
+                "quality_out": 0
+            }
+        ]
+    }
+}
+```
+
+*JSON-RPC*
+
+```
+200 OK
+{
+    "result": {
+        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+        "lines": [
+            {
+                "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
+                "balance": "0",
+                "currency": "ASP",
+                "limit": "0",
+                "limit_peer": "10",
+                "quality_in": 0,
+                "quality_out": 0
+            },
+            {
+                "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
+                "balance": "0",
+                "currency": "XAU",
+                "limit": "0",
+                "limit_peer": "0",
+                "no_ripple": true,
+                "no_ripple_peer": true,
+                "quality_in": 0,
+                "quality_out": 0
+            },
+            {
+                "account": "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx",
+                "balance": "0",
+                "currency": "015841551A748AD2C1F76FF6ECB0CCCD00000000",
+                "limit": "10.01037626125837",
+                "limit_peer": "0",
+                "no_ripple": true,
+                "quality_in": 0,
+                "quality_out": 0
+            }
+        ],
+        "status": "success"
+    }
+}
+```
+
+<!-- MULTICODE_BLOCK_END -->
+
+この応答は[標準フォーマット][]に従っており、正常に完了した場合には、アカウントのアドレスとトラストラインオブジェクトの配列が含まれています。具体的には、結果オブジェクトには以下のフィールドが含まれます。
+
+| `Field`                | 型                         | 説明                   |
+|:-----------------------|:---------------------------|:-----------------------|
+| `account` | 文字列 | この要求に対応するアカウントの一意の[アドレス][]。トラストラインのための「パースペクティブアカウント」です。 |
+| `lines` | 配列 | トラストラインオブジェクトからなる配列。以下で説明します。トラストラインの数が多い場合は、一度に`limit`の数までのトラストラインが返されます。 |
+| `ledger_current_index` | 整数 - [レジャーインデックス][] | _（`ledger_hash`または`ledger_index`が指定されている場合は省略）_ この情報の取得時に使用した、現行のオープンレジャーのレジャーインデックス。[新規: rippled 0.26.4-sp1][] |
+| `ledger_index` | 整数 - [レジャーインデックス][] | _（`ledger_current_index`が代わりに指定されている場合は省略）_ このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。[新規: rippled 0.26.4-sp1][] |
+| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。[新規: rippled 0.26.4-sp1][] |
+| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。[新規: rippled 0.26.4][] |
+
+各トラストラインオブジェクトには以下のフィールドの組み合わせが含まれています。
+
+| `Field`          | 型               | 説明                                   |
+|:-----------------|:-----------------|:---------------------------------------|
+| `account` | 文字列 | このトラストラインの相手側の一意の[アドレス][]。 |
+| `balance` | 文字列 | 現在このラインに対して保留されている残高（数値）の表示。残高がプラスの場合はパースペクティブアカウントがその額を保有しており、マイナスの場合はパースペクティブアカウントがその額を借用しています。 |
+| `currency` | 文字列 | このトラストラインが保有できる通貨を示す[通貨コード][]。 |
+| `limit` | 文字列 | このアカウントがピアアカウントからの借用を希望する特定の通貨の上限額。 |
+| `limit_peer` | 文字列 | 相手側アカウントがパースペクティブアカウントからの借用を希望する特定の通貨の上限額。 |
+| `quality_in` | 符号なし整数 | このアカウントが、このトラストラインの入金時残高を評価する際のレート（この数値対10億単位の比率）。（たとえば5億の場合は0.5:1の比率を表します。）特殊なケースとして、0は1:1の比率として扱われます。 |
+| `quality_out` | 符号なし整数 | このアカウントが、このトラストラインの出金時残高を評価する際のレート（この数値対10億単位の比率）。（たとえば5億の場合は0.5:1の比率を表します。）特殊なケースとして、0は1:1の比率として扱われます。 |
+| `no_ripple` | ブール値 | （省略される場合があります）このアカウントでこのラインに対し[NoRippleフラグ](rippling.html)が有効な場合は、`true`。省略されている場合は、`false`と同じです。 |
+| `no_ripple_peer` | ブール値 | （省略される場合があります）ピアアカウントでこのラインに対し[NoRippleフラグ](rippling.html)が有効な場合は`true`。省略されている場合は、`false`と同じです。 |
+| `authorized` | ブール値 | （省略される場合があります）このアカウントが[このトラストラインを承認した](authorized-trust-lines.html)場合は、`true`。省略されている場合は、`false`と同じです。 |
+| `peer_authorized` | ブール値 | （省略される場合があります）ピアアカウントが[このトラストラインを承認した](authorized-trust-lines.html)場合は`true`。省略されている場合は、`false`と同じです。 |
+| `freeze` | ブール値 | （省略される場合があります）このアカウントがこのトラストラインを[凍結](freezes.html)した場合は`true`。省略されている場合は、`false`と同じです。 |
+| `freeze_peer` | ブール値 | （省略される場合があります）ピアアカウントがこのトラストラインを[凍結](freezes.html)した場合は、`true`。省略されている場合は、`false`と同じです。 |
+
+## 考えられるエラー
+
+* いずれかの[汎用エラータイプ][]。
+* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
+* `actNotFound` - 要求の`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
+* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
+* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。
+
+
+{% include '_snippets/rippled_versions.md' %}
+{% include '_snippets/rippled-api-links.md' %}