Documentation
/
リファレンス
/
HTTP / WebSocket API リファレンス
/
rippledのパブリックメソッド
/
Accountメソッド
/
account_offers
最終更新:
編集

account_offers

[ソース]

account_offersメソッドは、特定のアカウントから出されたオファーのうち、特定のレジャーバージョンで未処理であったオファーのリストを取得します。

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

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

{
  "id": 2,
  "command": "account_offers",
  "account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM"
}

試してみる >

リクエストには以下のパラメーターを指定できます。

Field型必須?説明
account文字列 - Addressはいこのアカウントからのオファーを検索します。
ledger_hashハッシュいいえ使用するレジャーバージョンを識別する20バイトの16進文字列。
ledger_indexレジャーインデックスいいえ使用するレジャーのレジャーインデックス、レジャーを自動的に選択するためのショートカット文字列。（レジャーの指定をご覧ください
limit整数いいえ取得するオファーの数を制限します。サーバはこの数より少ない結果を返すことがあります。10～400の範囲内でなければなりません。この範囲外の正の値は、最も近い有効なオプションに置き換えられます。デフォルトは200です。
markerマーカーいいえ以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。

以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。ledger,strict

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

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

{
  "id": 9,
  "status": "success",
  "type": "response",
  "result": {
    "account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
    "ledger_current_index": 18539550,
    "offers": [
      {
        "flags": 0,
        "quality": "0.00000000574666765650638",
        "seq": 6577664,
        "taker_gets": "33687728098",
        "taker_pays": {
          "currency": "EUR",
          "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
          "value": "193.5921774819578"
        }
      },
      {
        "flags": 0,
        "quality": "7989247009094510e-27",
        "seq": 6572128,
        "taker_gets": "2361918758",
        "taker_pays": {
          "currency": "XAU",
          "issuer": "rrh7rf1gV2pXAoqA8oYbpHd8TKv5ZQeo67",
          "value": "0.01886995237307572"
        }
      },
      ... trimmed for length ...
    ],
    "validated": false
  }
}

このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。

Field型説明
account文字列オファーを出したアカウントを識別する一意のアドレス
offers配列オブジェクトの配列。各オブジェクトは、このアカウントが出したオファーの中で、レジャーバージョンがリクエストされた時点で未処理のオファーを表します。オファーの数が多い場合は、一度にlimitの数までのオファーが返されます。
ledger_current_index数値 - レジャーインデックス（ledger_hashまたはledger_indexが指定されている場合は省略可） このデータの取得時に使用した、現在処理中のレジャーバージョンのレジャーインデックス。
ledger_index数値 - レジャーインデックス（ledger_current_indexが指定されている場合は省略可） リクエストに従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。
ledger_hash文字列 - ハッシュ（省略される場合があります） このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。
markerマーカー（省略される場合があります） レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。

各Offerオブジェクトのフィールドを次に示します。

Field型説明
flags符号なし整数このオファーエントリに対してビットフラグとして設定されているオプション。
seq符号なし整数このエントリを作成したトランザクションのシーケンス番号。（トランザクションのシーケンス番号はアカウントに関連付けられています。）
taker_gets文字列またはオブジェクトオファーを受け入れるアカウントが受領する額。XRPまたは通貨指定オブジェクトの額を表す文字列として示されます。(通貨額の指定をご覧ください。)
taker_pays文字列またはオブジェクトオファーを受け入れるアカウントが提供する額。XRPまたは通貨指定オブジェクトの額を表す文字列として示されます。(通貨額の指定をご覧ください。)
quality文字列オファーの為替レート。元のtaker_paysを元のtaker_getsで割った比率です。オファーの実行時には、最も好ましい（最も低い）クオリティのオファーが最初に消費されます。同じクオリティのオファーは古いものから新しいものの順で実行されます。新規: rippled 0.29.0
expiration符号なし整数（省略される場合があります）この時刻の経過後は、資金化されなかったオファーとみなされます（Rippleエポック以降の経過秒数）。関連項目: オファーの有効期限。新規: rippled 0.30.1

考えられるエラー

  • いずれかの汎用エラータイプ。
  • invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
  • actNotFound - リクエストのaccountフィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
  • lgrNotFound - ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
  • actMalformed - 指定されているmarkerフィールドが受け入れられない場合。
前のページ
次のページ