Cosmos Bank V1Beta1 is an example object payload from Cosmos, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
groupbaseURLoperations
Example Payload
{
"group": "cosmos/bank/v1beta1",
"baseURL": "https://lcd.cosmos.network",
"operations": [
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/balances/{address}",
"operationId": "AllBalances",
"summary": "AllBalances queries the balance of all coins for a single account.",
"tags": [
"Query"
],
"parameters": [
{
"name": "address",
"in": "path",
"required": true,
"description": "address is the address to query balances for.",
"type": "string"
},
{
"name": "pagination.key",
"in": "query",
"required": false,
"description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.",
"type": "string"
},
{
"name": "pagination.offset",
"in": "query",
"required": false,
"description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.",
"type": "string"
},
{
"name": "pagination.limit",
"in": "query",
"required": false,
"description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.",
"type": "string"
},
{
"name": "pagination.countTotal",
"in": "query",
"required": false,
"description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.",
"type": "boolean"
},
{
"name": "pagination.reverse",
"in": "query",
"required": false,
"description": "reverse is set to true if results are to be returned in the descending order.",
"type": "boolean"
},
{
"name": "resolveDenom",
"in": "query",
"required": false,
"description": "resolve_denom is the flag to resolve the denom into a human-readable form from the metadata.",
"type": "boolean"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/balances/{address}/by_denom",
"operationId": "Balance",
"summary": "Balance queries the balance of a single coin for a single account.",
"tags": [
"Query"
],
"parameters": [
{
"name": "address",
"in": "path",
"required": true,
"description": "address is the address to query balances for.",
"type": "string"
},
{
"name": "denom",
"in": "query",
"required": false,
"description": "denom is the coin denom to query balances for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/denom_owners/{denom}",
"operationId": "DenomOwners",
"summary": "DenomOwners queries for all account addresses that own a particular token\ndenomination.",
"tags": [
"Query"
],
"parameters": [
{
"name": "denom",
"in": "path",
"required": true,
"description": "denom defines the coin denomination to query all account holders for.",
"type": "string"
},
{
"name": "pagination.key",
"in": "query",
"required": false,
"description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.",
"type": "string"
},
{
"name": "pagination.offset",
"in": "query",
"required": false,
"description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.",
"type": "string"
},
{
"name": "pagination.limit",
"in": "query",
"required": false,
"description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.",
"type": "string"
},
{
"name": "pagination.countTotal",
"in": "query",
"required": false,
"description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.",
"type": "boolean"
},
{
"name": "pagination.reverse",
"in": "query",
"required": false,
"description": "reverse is set to true if results are to be returned in the descending order.",
"type": "boolean"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/denom_owners_by_query",
"operationId": "DenomOwnersByQuery",
"summary": "DenomOwnersByQuery queries for all account addresses that own a particular token\ndenomination.",
"tags": [
"Query"
],
"parameters": [
{
"name": "denom",
"in": "query",
"required": false,
"description": "denom defines the coin denomination to query all account holders for.",
"type": "string"
},
{
"name": "pagination.key",
"in": "query",
"required": false,
"description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.",
"type": "string"
},
{
"name": "pagination.offset",
"in": "query",
"required": false,
"description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.",
"type": "string"
},
{
"name": "pagination.limit",
"in": "query",
"required": false,
"description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.",
"type": "string"
},
{
"name": "pagination.countTotal",
"in": "query",
"required": false,
"description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.",
"type": "boolean"
},
{
"name": "pagination.reverse",
"in": "query",
"required": false,
"description": "reverse is set to true if results are to be returned in the descending order.",
"type": "boolean"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/denoms_metadata",
"operationId": "DenomsMetadata",
"summary": "DenomsMetadata queries the client metadata for all registered coin\ndenominations.",
"tags": [
"Query"
],
"parameters": [
{
"name": "pagination.key",
"in": "query",
"required": false,
"description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.",
"type": "string"
},
{
"name": "pagination.offset",
"in": "query",
"required": false,
"description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.",
"type": "string"
},
{
"name": "pagination.limit",
"in": "query",
"required": false,
"description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.",
"type": "string"
},
{
"name": "pagination.countTotal",
"in": "query",
"required": false,
"description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.",
"type": "boolean"
},
{
"name": "pagination.reverse",
"in": "query",
"required": false,
"description": "reverse is set to true if results are to be returned in the descending order.",
"type": "boolean"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/denoms_metadata/{denom}",
"operationId": "DenomMetadata",
"summary": "DenomMetadata queries the client metadata of a given coin denomination.",
"tags": [
"Query"
],
"parameters": [
{
"name": "denom",
"in": "path",
"required": true,
"description": "denom is the coin denom to query the metadata for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/denoms_metadata_by_query_string",
"operationId": "DenomMetadataByQueryString",
"summary": "DenomMetadataByQueryString queries the client metadata of a given coin denomination.",
"tags": [
"Query"
],
"parameters": [
{
"name": "denom",
"in": "query",
"required": false,
"description": "denom is the coin denom to query the metadata for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/params",
"operationId": "BankParams",
"summary": "Params queries the parameters of x/bank module.",
"tags": [
"Query"
],
"parameters": [],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/send_enabled",
"operationId": "SendEnabled",
"summary": "SendEnabled queries for SendEnabled entries.",
"tags": [
"Query"
],
"parameters": [
{
"name": "denoms",
"in": "query",
"required": false,
"description": "denoms is the specific denoms you want look up. Leave empty to get all entries.",
"type": "array"
},
{
"name": "pagination.key",
"in": "query",
"required": false,
"description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.",
"type": "string"
},
{
"name": "pagination.offset",
"in": "query",
"required": false,
"description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.",
"type": "string"
},
{
"name": "pagination.limit",
"in": "query",
"required": false,
"description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.",
"type": "string"
},
{
"name": "pagination.countTotal",
"in": "query",
"required": false,
"description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.",
"type": "boolean"
},
{
"name": "pagination.reverse",
"in": "query",
"required": false,
"description": "reverse is set to true if results are to be returned in the descending order.",
"type": "boolean"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/spendable_balances/{address}",
"operationId": "SpendableBalances",
"summary": "SpendableBalances queries the spendable balance of all coins for a single\naccount.",
"tags": [
"Query"
],
"parameters": [
{
"name": "address",
"in": "path",
"required": true,
"description": "address is the address to query spendable balances for.",
"type": "string"
},
{
"name": "pagination.key",
"in": "query",
"required": false,
"description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.",
"type": "string"
},
{
"name": "pagination.offset",
"in": "query",
"required": false,
"description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.",
"type": "string"
},
{
"name": "pagination.limit",
"in": "query",
"required": false,
"description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.",
"type": "string"
},
{
"name": "pagination.countTotal",
"in": "query",
"required": false,
"description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.",
"type": "boolean"
},
{
"name": "pagination.reverse",
"in": "query",
"required": false,
"description": "reverse is set to true if results are to be returned in the descending order.",
"type": "boolean"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/spendable_balances/{address}/by_denom",
"operationId": "SpendableBalanceByDenom",
"summary": "SpendableBalanceByDenom queries the spendable balance of a single denom for\na single account.",
"tags": [
"Query"
],
"parameters": [
{
"name": "address",
"in": "path",
"required": true,
"description": "address is the address to query balances for.",
"type": "string"
},
{
"name": "denom",
"in": "query",
"required": false,
"description": "denom is the coin denom to query balances for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/supply",
"operationId": "TotalSupply",
"summary": "TotalSupply queries the total supply of all coins.",
"tags": [
"Query"
],
"parameters": [
{
"name": "pagination.key",
"in": "query",
"required": false,
"description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set.",
"type": "string"
},
{
"name": "pagination.offset",
"in": "query",
"required": false,
"description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set.",
"type": "string"
},
{
"name": "pagination.limit",
"in": "query",
"required": false,
"description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app.",
"type": "string"
},
{
"name": "pagination.countTotal",
"in": "query",
"required": false,
"description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set.",
"type": "boolean"
},
{
"name": "pagination.reverse",
"in": "query",
"required": false,
"description": "reverse is set to true if results are to be returned in the descending order.",
"type": "boolean"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/bank/v1beta1/supply/by_denom",
"operationId": "SupplyOf",
"summary": "SupplyOf queries the supply of a single coin.",
"tags": [
"Query"
],
"parameters": [
{
"name": "denom",
"in": "query",
"required": false,
"description": "denom is the coin denom to query balances for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
}
]
}