xrpl
    Preparing search index...

    Interface GatewayBalancesResponse

    Expected response from a GatewayBalancesRequest.

    interface GatewayBalancesResponse {
        api_version?: number;
        forwarded?: boolean;
        id: string | number;
        result: {
            account: string;
            assets?: { [address: string]: GatewayBalance[] };
            balances?: { [address: string]: GatewayBalance[] };
            ledger_current_index?: number;
            ledger_hash?: string;
            ledger_index?: number;
            obligations?: { [currency: string]: string };
        };
        status?: string;
        type: string;
        warning?: "load";
        warnings?: ResponseWarning[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    api_version?: number
    forwarded?: boolean
    id: string | number
    result: {
        account: string;
        assets?: { [address: string]: GatewayBalance[] };
        balances?: { [address: string]: GatewayBalance[] };
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        obligations?: { [currency: string]: string };
    }

    Type declaration

    • account: string

      The address of the account that issued the balances.

    • Optionalassets?: { [address: string]: GatewayBalance[] }

      Total amounts held that are issued by others. In the recommended configuration, the issuing address should have none.

    • Optionalbalances?: { [address: string]: GatewayBalance[] }

      Amounts issued to the hotwallet addresses from the request. The keys are addresses and the values are arrays of currency amounts they hold.

    • Optionalledger_current_index?: number

      The ledger index of the ledger version that was used to generate this response.

    • Optionalledger_hash?: string

      The identifying hash of the ledger version that was used to generate this response.

    • Optionalledger_index?: number

      The ledger index of the current in-progress ledger version, which was used to retrieve this information.

    • Optionalobligations?: { [currency: string]: string }

      Total amounts issued to addresses not excluded, as a map of currencies to the total value issued.

    status?: string
    type: string
    warning?: "load"
    warnings?: ResponseWarning[]