amm_info

amm_infoメソッドは、自動マーケットメーカー（AMM）インスタンスに関する情報を取得します。

(AMM amendmentにより追加されました。)

リクエストのフォーマット

リクエストの例

注記

このメソッドにはコマンドライン構文がありません。代わりにjsonメソッドを使って、コマンドラインからこのメソッドにアクセスすることができます。

{
    "command": "amm_info",
    "asset": {
      "currency": "XRP"
    },
    "asset2": {
      "currency": "TST",
      "issuer": "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"
    }
}

試してみる>

リクエストには以下のパラメーターが含まれます。

`フィールド`	型	必須?	説明
`account`	文字列 - アドレス	いいえ	この流動性プロバイダーが保有するLPトークンのみを表示します。
`amm_account`	文字列 - アドレス	いいえ	AMMの特別なAccountRootのアドレス。(これはAMMのLPトークンの`issuer`です)。
`asset`	オブジェクト	いいえ	通貨額のように、`currency`と`issuer`フィールドを持つオブジェクトとして（XRPの場合は`issuer`を省略）、検索するAMMの資産の一つを指定します。
`asset2`	オブジェクト	いいえ	AMMの資産のもう一方を、`currency`と`issuer`フィールド（XRPの場合は`issuer`を省略）を持つオブジェクトとして、通貨額のように指定することが可能です。

amm_account、またはassetとasset2の両方を指定する必要があります。

レスポンスのフォーマット

処理が成功したレスポンスの例:

{
  "result": {
    "amm": {
      "account": "rp9E3FN3gNmvePGhYnf414T2TkUuoxu8vM",
      "amount": "296890496",
      "amount2": {
        "currency": "TST",
        "issuer": "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
        "value": "25.81656470648473"
      },
      "asset2_frozen": false,
      "auction_slot": {
        "account": "rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm",
        "auth_accounts": [
          {
            "account": "r3f2WpQMsAd8k4Zoijv2PZ78EYFJ2EdvgV"
          },
          {
            "account": "rnW8FAPgpQgA6VoESnVrUVJHBdq9QAtRZs"
          }
        ],
        "discounted_fee": 0,
        "expiration": "2023-Jan-26 00:28:40.000000000 UTC",
        "price": {
          "currency": "039C99CD9AB0B70B32ECDA51EAAE471625608EA2",
          "issuer": "rp9E3FN3gNmvePGhYnf414T2TkUuoxu8vM",
          "value": "0"
        },
        "time_interval": 0
      },
      "lp_token": {
        "currency": "039C99CD9AB0B70B32ECDA51EAAE471625608EA2",
        "issuer": "rp9E3FN3gNmvePGhYnf414T2TkUuoxu8vM",
        "value": "87533.41976112682"
      },
      "trading_fee": 600,
      "vote_slots": [
        {
          "account": "rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm",
          "trading_fee": 600,
          "vote_weight": 9684
        }
      ]
    },
    "ledger_current_index": 316725,
    "validated": false
  },
  "status": "success",
  "type": "response"
}

レスポンスは標準フォーマットに従っており、成功した場合は以下のフィールドを含みます。

フィールド	型	説明
`amm`	オブジェクト	リクエストに含まれる資産ペアのAMM詳細オブジェクトです。
`ledger_current_index`	レジャーインデックス	(`ledger_index`の指定がある場合は省略) この情報を取得する際に使用された、現在の進行中の台帳のレジャーインデックス。
`ledger_hash`	ハッシュ	(`ledger_current_index`の指定がある場合は省略) この情報を取得する際に使用された台帳のバージョンの識別ハッシュ。
`ledger_index`	レジャーインデックス	(`ledger_current_index`の指定がある場合は省略) この情報を取得する際に使用した台帳のバージョンのレジャーインデックス。
`validated`	真偽値	もし`true`なら、このリクエストに使用された台帳は検証済みで、これらの結果は最終的なものです。もし省略されるか`false`に設定されると、データは未確定で変更される可能性があります。

AMM詳細オブジェクト

ammフィールドは、自動マーケットメーカー（AMM）の現在の状態を記述するオブジェクトであり、以下のフィールドを含みます。

フィールド	型	説明
`amm_account`	文字列	AMMアカウントのアドレスです。
`amount`	通貨額	AMMのプールにある1つの資産の合計額。(注記:リクエストに指定した`asset` または `asset2`になります。)
`amount2`	通貨額	AMMのプール内の他の資産の合計額。(注意:リクエストに指定した`asset` または `asset2`になります。)
`asset_frozen`	真偽値	(XRPの場合、省略) `true`の場合、`amount`の通貨は現在凍結されています。
`asset2_frozen`	真偽値	(XRPの場合、省略) `true`の場合、`amount2`の通貨は現在凍結されています。
`auction_slot`	オブジェクト	(省略される場合があります) 存在する場合、現在のオークションスロットの所有者を記述したオークションスロットオブジェクトです。
`lp_token`	通貨額	このAMMのLPトークンの発行残高の合計。リクエスト時に`account`フィールドで流動性プロバイダを指定した場合、その流動性プロバイダが保有するこのAMMのLPトークンの量です。
`trading_fee`	数値	AMMの現在の取引手数料。単位は1/100,000で、1は0.001%の手数料に相当します。
`vote_slots`	配列	(省略される場合があります) AMMの取引手数料に対する現在の投票数。投票スロットオブジェクトとして表示されます。

オークションスロットオブジェクト

AMMオブジェクトのauction_slotフィールドは、AMMの現在のオークションスロット保持者を表し、以下のフィールドを含みます。

フィールド	型	説明
`account`	文字列	オークションスロットを所有するアカウントのアドレスです。
`auth_accounts`	配列	オークションスロットの所有者が、取引手数料の割引の対象として指定した追加アカウントのリスト。この配列の各メンバーは、1つのフィールド`account`を持つオブジェクトで、指定したアカウントのアドレスが含まれています。
`discounted_fee`	数値	このAMMに対して取引を行う際に、オークションスロットの保有者、および対象となるアカウントに適用される割引後の取引手数料です。これは通常の取引手数料の1/10です。
`expiration`	文字列	このオークションスロットが期限切れとなるISO8601のUTCタイムスタンプ。期限切れになると、オークションスロットは適用されません (ただし、別のトランザクションで置き換えられるかクリーンアップされるまで、データは台帳に残ります)。
`price`	通貨額	オークションスロット所有者がオークションスロットを獲得するために支払った金額（LPトークン単位）です。これは、現在のスロット所有者を競り落とすための価格に影響します。
`time_interval`	数値	このオークションスロットが現在入っている72分の時間間隔を0から19までで指定します。オークションスロットは24時間後（72分間隔で20回）に失効し、現在の保有者を競り落とすためのコストと、誰かが競り落とした場合に現在の保有者が払い戻される金額に影響します。

投票スロットオブジェクト

vote_slots配列の各項目は、取引手数料を設定するための流動性供給者の投票権を表し、以下のフィールドを含みます。

フィールド	型	説明
`account`	文字列	この流動性供給者のアドレス。
`trading_fee`	数値	この流動性供給者が投票した取引手数料。単位は1/100,000です。
`vote_weight`	数値	この流動性供給者の投票が、最終的な取引手数料にどれだけカウントされるかを表します。これは、この流動性供給者がAMMのLPトークンをどれだけ保有しているかに比例します。値は、この流動性供給者が保有するこのLPトークンの数の100,000倍を、発行済LPトークンの総数で割ったものになります。例えば、値が1000の場合、流動性供給者はこのAMMのLPトークンの1%を保有していることを意味します。

考えられるエラー

汎用エラータイプのすべて。
actNotFound - この資産ペアのAMMが存在しないか、リクエストで指定された発行アカウントが存在しません。
invalidParams - 1つまたは複数のフィールドの指定に誤りがあるか、1つまたは複数の必須フィールドが欠落しています。