diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md index 77e2b1e584..11a48e6dc2 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md @@ -32,7 +32,8 @@ An example of the request format: "asset2": { "currency": "TST", "issuer": "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd" - } + }, + "ledger_index": "validated" } ``` {% /tab %} @@ -48,7 +49,8 @@ An example of the request format: "asset2": { "currency": "TST", "issuer": "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd" - } + }, + "ledger_index": "validated" }] } ``` @@ -60,12 +62,14 @@ An example of the request format: The request includes the following parameters: -| `Field` | Type | Required? | Description | -|:--------------|:-----------------|:----------|-------------| -| `account` | String - [Address][] | No | Show only LP Tokens held by this liquidity provider. | -| `amm_account` | String - [Address][] | No | The address of the AMM's special AccountRoot. (This is the `issuer` of the AMM's LP Tokens.) | -| `asset` | Object | No | One of the assets of the AMM to look up, as an object with `currency` and `issuer` fields (omit `issuer` for XRP), like [currency amounts][Currency Amount]. | -| `asset2` | Object | No | The other of the assets of the AMM, as an object with `currency` and `issuer` fields (omit `issuer` for XRP), like [currency amounts][Currency Amount]. | +| `Field` | Type | Required? | Description | +|:---------------|:---------------------|:----------|-------------| +| `account` | String - [Address][] | No | Show only LP Tokens held by this liquidity provider. | +| `amm_account` | String - [Address][] | No | The address of the AMM's special AccountRoot. (This is the `issuer` of the AMM's LP Tokens.) | +| `asset` | Object | No | One of the assets of the AMM to look up, as an object with `currency` and `issuer` fields (omit `issuer` for XRP), like [currency amounts][Currency Amount]. | +| `asset2` | Object | No | The other of the assets of the AMM, as an object with `currency` and `issuer` fields (omit `issuer` for XRP), like [currency amounts][Currency Amount]. | +| `ledger_hash` | String | No | The unique hash of the ledger version to use. See [Specifying Ledgers][]. | +| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. See [Specifying Ledgers][]. | You must specify _either_ `amm_account` or both `asset` and `asset2`. diff --git a/resources/dev-tools/components/websocket-api/data/command-list.json b/resources/dev-tools/components/websocket-api/data/command-list.json index 06b3675407..f019ce57a2 100644 --- a/resources/dev-tools/components/websocket-api/data/command-list.json +++ b/resources/dev-tools/components/websocket-api/data/command-list.json @@ -286,7 +286,8 @@ "asset2": { "currency": "TST", "issuer": "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd" - } + }, + "ledger_index": "validated" } }, {