# GatewayBalancesRequest | xrpl
Documentation for xrpl

# Interface GatewayBalancesRequest

The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses. Expects a response in the form of a GatewayBalancesResponse.

#### Example

    const gatewayBalances: GatewayBalanceRequest = {
      "id": "example_gateway_balances_1",
      "command": "gateway_balances",
      "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
      "strict": true,
      "hotwallet": ["rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ","ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"],
      "ledger_index": "validated"
    }

#### Hierarchy

- BaseRequest
- LookupByLedgerRequest
  - GatewayBalancesRequest

- Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:22

#####
Index

### Properties

account
api_version?
command
hotwallet?
id?
ledger_hash?
ledger_index?
strict?

## Properties

### account

account: string

The Address to check. This should be the issuing address.

- Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:27

### `Optional` api_version

api_version?: number

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

Inherited from BaseRequest.api_version

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

### command

command: "gateway_balances"

The name of the API method.

Overrides BaseRequest.command

- Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:25

### `Optional` hotwallet

hotwallet?: string | string[]

An operational address to exclude from the balances issued, or an array of Such addresses.

- Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:37

### `Optional` id

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.

Inherited from BaseRequest.id

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

### `Optional` ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

Inherited from LookupByLedgerRequest.ledger_hash

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

### `Optional` ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string.

Inherited from LookupByLedgerRequest.ledger_index

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

### `Optional` strict

strict?: boolean

If true, only accept an address or public key for the account parameter. Defaults to false.

- Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:32

Generated using TypeDoc