Bank

Last updated 1 month ago

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

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Path parameters

addressanyRequired

address is the address to query balances for.

Query parameters

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

resolve_denomanyOptional

resolve_denom is the flag to resolve the denom into a human-readable form from the metadata.

Since: cosmos-sdk 0.50

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/balances/{address} HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "balances": [
    {
      "denom": "text",
      "amount": "text"
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

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

get

Path parameters

addressanyRequired

address is the address to query balances for.

Query parameters

denomanyOptional

denom is the coin denom to query balances for.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/balances/{address}/by_denom HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "balance": {
    "denom": "text",
    "amount": "text"
  }
}

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

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.46

Path parameters

denomanyRequired

denom defines the coin denomination to query all account holders for.

Query parameters

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/denom_owners/{denom} HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "denom_owners": [
    {
      "address": "text",
      "balance": {
        "denom": "text",
        "amount": "text"
      }
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

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

get

Since: cosmos-sdk 0.50.3

Query parameters

denomanyOptional

denom defines the coin denomination to query all account holders for.

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/denom_owners_by_query HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "denom_owners": [
    {
      "address": "text",
      "balance": {
        "denom": "text",
        "amount": "text"
      }
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

DenomsMetadata queries the client metadata for all registered coin denominations.

get

Query parameters

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/denoms_metadata HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "metadatas": [
    {
      "description": "text",
      "denom_units": [
        {
          "denom": "text",
          "exponent": 1,
          "aliases": [
            "text"
          ]
        }
      ],
      "base": "text",
      "display": "text",
      "name": "text",
      "symbol": "text",
      "uri": "text",
      "uri_hash": "text"
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

DenomMetadata queries the client metadata of a given coin denomination.

get

Path parameters

denomanyRequired

denom is the coin denom to query the metadata for.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/denoms_metadata/{denom} HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "metadata": {
    "description": "text",
    "denom_units": [
      {
        "denom": "text",
        "exponent": 1,
        "aliases": [
          "text"
        ]
      }
    ],
    "base": "text",
    "display": "text",
    "name": "text",
    "symbol": "text",
    "uri": "text",
    "uri_hash": "text"
  }
}

DenomMetadataByQueryString queries the client metadata of a given coin denomination.

get

Query parameters

denomanyOptional

denom is the coin denom to query the metadata for.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/denoms_metadata_by_query_string HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "metadata": {
    "description": "text",
    "denom_units": [
      {
        "denom": "text",
        "exponent": 1,
        "aliases": [
          "text"
        ]
      }
    ],
    "base": "text",
    "display": "text",
    "name": "text",
    "symbol": "text",
    "uri": "text",
    "uri_hash": "text"
  }
}

Params queries the parameters of x/bank module.

get

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/params HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "params": {
    "send_enabled": [
      {
        "denom": "text",
        "enabled": true
      }
    ],
    "default_send_enabled": true
  }
}

SendEnabled queries for SendEnabled entries.

get

This query only returns denominations that have specific SendEnabled settings. Any denomination that does not have a specific setting will use the default params.default_send_enabled, and will not be returned by this query.

Since: cosmos-sdk 0.47

Query parameters

denomsanyOptional

denoms is the specific denoms you want look up. Leave empty to get all entries.

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/send_enabled HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "send_enabled": [
    {
      "denom": "text",
      "enabled": true
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

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

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.46

Path parameters

addressanyRequired

address is the address to query spendable balances for.

Query parameters

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/spendable_balances/{address} HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "balances": [
    {
      "denom": "text",
      "amount": "text"
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

SpendableBalanceByDenom queries the spendable balance of a single denom for a single account.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.47

Path parameters

addressanyRequired

address is the address to query balances for.

Query parameters

denomanyOptional

denom is the coin denom to query balances for.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/spendable_balances/{address}/by_denom HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "balance": {
    "denom": "text",
    "amount": "text"
  }
}

TotalSupply queries the total supply of all coins.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Query parameters

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/supply HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "supply": [
    {
      "denom": "text",
      "amount": "text"
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

SupplyOf queries the supply of a single coin.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Query parameters

denomanyOptional

denom is the coin denom to query balances for.

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

GET /cosmos/bank/v1beta1/supply/by_denom HTTP/1.1
Host: lcd.uno.sentry.testnet.v3.kiivalidator.com
Accept: */*

{
  "amount": {
    "denom": "text",
    "amount": "text"
  }
}