Interface AMMInfoRequest

The amm_info method gets information about an Automated Market Maker (AMM) instance. Returns an AMMInfoResponse.

interface AMMInfoRequest {
    amm_account?: string;
    api_version?: number;
    asset?: Currency;
    asset2?: Currency;
    command: "amm_info";
    id?: string | number;
    [x: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [x: string]: unknown

Properties

amm_account? api_version? asset? asset2? command id?

Properties

Optionalamm_account

amm_account?: string

The address of the AMM Account to look up.

Optionalapi_version

api_version?: number

The API version to use. If omitted, use version 1.

Optionalasset

asset?: Currency

One of the assets of the AMM pool to look up.

Optionalasset2

asset2?: Currency

The other asset of the AMM pool.

command

command: "amm_info"

The name of the API method.

Optionalid

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Settings

Member Visibility

On This Page

Properties