account_currencies
account_currenciesコマンドは、アカウントのトラストラインに基づいてそのアカウントが送金または受領できる通貨のリストを返します。（このリストは完全に確認されたリストではありませんが、ユーザインターフェイスへの入力に使用できます。）
リクエストのフォーマット
リクエストのフォーマットの例:
{
"command": "account_currencies",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated"
}リクエストには以下のパラメーターが含まれます。
Field | 型 | 説明 |
|---|---|---|
account | 文字列 | このアカウントが送受信できる通貨を検索します。 |
strict | ブール値 | （省略可） trueの場合は、アカウントパラメーターにアドレスまたは公開鍵だけを受け入れます。デフォルトではfalseです。 |
ledger_hash | 文字列 | （省略可） 使用するレジャーバージョンの20バイトの16進文字列。（レジャーの指定をご覧ください） |
ledger_index | 文字列または符号なし整数 | （省略可） 使用するレジャーインデックス、またはレジャーを自動的に選択するためのショートカット文字列。（レジャーの指定をご覧ください） |
次のフィールドは廃止予定であるため、指定しないでください。account_index.
レスポンスのフォーマット
処理が成功したレスポンスの例:
{
"result": {
"ledger_index": 11775844,
"receive_currencies": [
"BTC",
"CNY",
"DYM",
"EUR",
"JOE",
"MXN",
"USD",
"015841551A748AD2C1F76FF6ECB0CCCD00000000"
],
"send_currencies": [
"ASP",
"BTC",
"CHF",
"CNY",
"DYM",
"EUR",
"JOE",
"JPY",
"MXN",
"USD"
],
"validated": true
},
"status": "success",
"type": "response"
}このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれています。
Field | 型 | 説明 |
|---|---|---|
ledger_hash | 文字列 - ハッシュ | （省略される場合があります）このデータの取得に使用するレジャーバージョンの識別用ハッシュ（16進数）。 |
ledger_index | 整数 - レジャーインデックス | このデータの取得に使用するレジャーバージョンのシーケンス番号。 |
receive_currencies | 文字列の配列 | このアカウントが受領できる通貨の通貨コードの配列。 |
send_currencies | 文字列の配列 | このアカウントが送金できる通貨の通貨コードの配列。 |
validated | ブール値 | trueの場合、このデータは検証済みレジャーから取得されます。 |
注記
アカウントが送金または受領できる通貨は、アカウントのトラストラインのチェックに基づいて定義されます。アカウントに通貨のトラストラインがあり、残高を増額できる余裕がある場合、その通貨を受領できます。トラストラインの残高を減らせる場合、アカウントはその通貨を送金できます。このメソッドでは、トラストラインが凍結または承認されているかどうかは確認 されません 。
考えられるエラー
- 汎用エラータイプのすべて。
invalidParams- 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。actNotFound- リクエストのaccountフィールドに指定されているアドレスが、レジャーのアカウントに対応していません。lgrNotFound-ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。