Class Api<SecurityDataType>

Title

cosmos/bank/v1beta1/authz.proto

Version

version not set

Type Parameters

SecurityDataType extends unknown

Hierarchy

HttpClient<SecurityDataType>
- Api

Index

Constructors

constructor

new Api<SecurityDataType>(__namedParameters?: ApiConfig<SecurityDataType>): Api<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- __namedParameters: ApiConfig<SecurityDataType> = {}
Returns Api<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in cosmos.bank.v1beta1/rest.ts:372

Properties

instance

instance: AxiosInstance

Methods

queryAllBalances

queryAllBalances(address: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryAllBalancesResponse>>
No description

Tags
Query

Name
QueryAllBalances

Summary
AllBalances queries the balance of all coins for a single account.

Request
GET:/cosmos/bank/v1beta1/balances/{address}
Parameters
- address: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryAllBalancesResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:463

queryBalance

queryBalance(address: string, query?: {
denom?: string;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryBalanceResponse>>
No description

Tags
Query

Name
QueryBalance

Summary
Balance queries the balance of a single coin for a single account.

Request
GET:/cosmos/bank/v1beta1/balances/{address}/by_denom
Parameters
- address: string
- Optional query: {
  denom?: string;
  }
  - Optional denom?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryBalanceResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:490

queryDenomMetadata

queryDenomMetadata(denom: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDenomMetadataResponse>>
No description

Tags
Query

Name
QueryDenomMetadata

Summary
DenomsMetadata queries the client metadata of a given coin denomination.

Request
GET:/cosmos/bank/v1beta1/denoms_metadata/{denom}
Parameters
- denom: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDenomMetadataResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:562

queryDenomOwners

queryDenomOwners(denom: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDenomOwnersResponse>>
Description
Since: cosmos-sdk 0.46

Tags
Query

Name
QueryDenomOwners

Summary
DenomOwners queries for all account addresses that own a particular token denomination.

Request
GET:/cosmos/bank/v1beta1/denom_owners/{denom}
Parameters
- denom: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDenomOwnersResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:508

queryDenomsMetadata

queryDenomsMetadata(query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryDenomsMetadataResponse>>
No description

Tags
Query

Name
QueryDenomsMetadata

Summary
DenomsMetadata queries the client metadata for all registered coin denominations.

Request
GET:/cosmos/bank/v1beta1/denoms_metadata
Parameters
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryDenomsMetadataResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:536

queryParams

queryParams(params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryParamsResponse>>
No description

Tags
Query

Name
QueryParams

Summary
Params queries the parameters of x/bank module.

Request
GET:/cosmos/bank/v1beta1/params
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryParamsResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:578

querySpendableBalances

querySpendableBalances(address: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QuerySpendableBalancesResponse>>
Description
Since: cosmos-sdk 0.46

Tags
Query

Name
QuerySpendableBalances

Summary
SpendableBalances queries the spenable balance of all coins for a single account.

Request
GET:/cosmos/bank/v1beta1/spendable_balances/{address}
Parameters
- address: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QuerySpendableBalancesResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:595

querySupplyOf

querySupplyOf(query?: {
denom?: string;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QuerySupplyOfResponse>>
No description

Tags
Query

Name
QuerySupplyOf

Summary
SupplyOf queries the supply of a single coin.

Request
GET:/cosmos/bank/v1beta1/supply/by_denom
Parameters
- Optional query: {
  denom?: string;
  }
  - Optional denom?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QuerySupplyOfResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:648

queryTotalSupply

queryTotalSupply(query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryTotalSupplyResponse>>
No description

Tags
Query

Name
QueryTotalSupply

Summary
TotalSupply queries the total supply of all coins.

Request
GET:/cosmos/bank/v1beta1/supply
Parameters
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryTotalSupplyResponse>>
- Defined in cosmos.bank.v1beta1/rest.ts:622

request

request<T, _E>(__namedParameters: FullRequestParams): Promise<AxiosResponse<T>>
Type Parameters
- T = any
- _E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<AxiosResponse<T>>
Inherited from HttpClient.request
- Defined in cosmos.bank.v1beta1/rest.ts:411

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in cosmos.bank.v1beta1/rest.ts:379

Class Api<SecurityDataType>

Title

Version

Type Parameters

SecurityDataType extends unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

SecurityDataType extends unknown

Parameters

__namedParameters: ApiConfig<SecurityDataType> = {}

Returns Api<SecurityDataType>

Properties

instance

Methods

queryAllBalances

Tags

Name

Summary

Request

Parameters

address: string

Optional query: { pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryAllBalancesResponse>>

queryBalance

Tags

Name

Summary

Request

Parameters

address: string

Optional query: { denom?: string; }

Optional denom?: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryBalanceResponse>>

queryDenomMetadata

Tags

Name

Summary

Request

Parameters

denom: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDenomMetadataResponse>>

queryDenomOwners

Description

Tags

Name

Summary

Request

Parameters

denom: string

Optional query: { pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryDenomOwnersResponse>>

queryDenomsMetadata

Tags

Name

Summary

Request

Parameters

Optional query: { pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional pagination.count_total?: boolean

Optional pagination.key?: string

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` query: {
denom?: string;
}

`Optional` denom?: string

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` query: {
denom?: string;
}

`Optional` denom?: string

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean