Cosmos Staking 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/staking/v1beta1",
"baseURL": "https://lcd.cosmos.network",
"operations": [
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/delegations/{delegatorAddr}",
"operationId": "DelegatorDelegations",
"summary": "DelegatorDelegations queries all delegations of a given delegator address.",
"tags": [
"Query"
],
"parameters": [
{
"name": "delegatorAddr",
"in": "path",
"required": true,
"description": "delegator_addr defines the delegator address to query 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/staking/v1beta1/delegators/{delegatorAddr}/redelegations",
"operationId": "Redelegations",
"summary": "Redelegations queries redelegations of given address.",
"tags": [
"Query"
],
"parameters": [
{
"name": "delegatorAddr",
"in": "path",
"required": true,
"description": "delegator_addr defines the delegator address to query for.",
"type": "string"
},
{
"name": "srcValidatorAddr",
"in": "query",
"required": false,
"description": "src_validator_addr defines the validator address to redelegate from.",
"type": "string"
},
{
"name": "dstValidatorAddr",
"in": "query",
"required": false,
"description": "dst_validator_addr defines the validator address to redelegate to.",
"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/staking/v1beta1/delegators/{delegatorAddr}/unbonding_delegations",
"operationId": "DelegatorUnbondingDelegations",
"summary": "DelegatorUnbondingDelegations queries all unbonding delegations of a given\ndelegator address.",
"tags": [
"Query"
],
"parameters": [
{
"name": "delegatorAddr",
"in": "path",
"required": true,
"description": "delegator_addr defines the delegator address to query 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/staking/v1beta1/delegators/{delegatorAddr}/validators",
"operationId": "StakingDelegatorValidators",
"summary": "DelegatorValidators queries all validators info for given delegator\naddress.",
"tags": [
"Query"
],
"parameters": [
{
"name": "delegatorAddr",
"in": "path",
"required": true,
"description": "delegator_addr defines the delegator address to query 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/staking/v1beta1/delegators/{delegatorAddr}/validators/{validatorAddr}",
"operationId": "DelegatorValidator",
"summary": "DelegatorValidator queries validator info for given delegator validator\npair.",
"tags": [
"Query"
],
"parameters": [
{
"name": "delegatorAddr",
"in": "path",
"required": true,
"description": "delegator_addr defines the delegator address to query for.",
"type": "string"
},
{
"name": "validatorAddr",
"in": "path",
"required": true,
"description": "validator_addr defines the validator address to query for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/historical_info/{height}",
"operationId": "HistoricalInfo",
"summary": "HistoricalInfo queries the historical info for given height.",
"tags": [
"Query"
],
"parameters": [
{
"name": "height",
"in": "path",
"required": true,
"description": "height defines at which height to query the historical info.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/params",
"operationId": "StakingParams",
"summary": "Parameters queries the staking parameters.",
"tags": [
"Query"
],
"parameters": [],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/pool",
"operationId": "Pool",
"summary": "Pool queries the pool info.",
"tags": [
"Query"
],
"parameters": [],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/validators",
"operationId": "Validators",
"summary": "Validators queries all validators that match the given status.",
"tags": [
"Query"
],
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"description": "status enables to query for validators matching a given status.",
"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/staking/v1beta1/validators/{validatorAddr}",
"operationId": "Validator",
"summary": "Validator queries validator info for given validator address.",
"tags": [
"Query"
],
"parameters": [
{
"name": "validatorAddr",
"in": "path",
"required": true,
"description": "validator_addr defines the validator address to query for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/validators/{validatorAddr}/delegations",
"operationId": "ValidatorDelegations",
"summary": "ValidatorDelegations queries delegate info for given validator.",
"tags": [
"Query"
],
"parameters": [
{
"name": "validatorAddr",
"in": "path",
"required": true,
"description": "validator_addr defines the validator address to query 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/staking/v1beta1/validators/{validatorAddr}/delegations/{delegatorAddr}",
"operationId": "Delegation",
"summary": "Delegation queries delegate info for given validator delegator pair.",
"tags": [
"Query"
],
"parameters": [
{
"name": "validatorAddr",
"in": "path",
"required": true,
"description": "validator_addr defines the validator address to query for.",
"type": "string"
},
{
"name": "delegatorAddr",
"in": "path",
"required": true,
"description": "delegator_addr defines the delegator address to query for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/validators/{validatorAddr}/delegations/{delegatorAddr}/unbonding_delegation",
"operationId": "UnbondingDelegation",
"summary": "UnbondingDelegation queries unbonding info for given validator delegator\npair.",
"tags": [
"Query"
],
"parameters": [
{
"name": "validatorAddr",
"in": "path",
"required": true,
"description": "validator_addr defines the validator address to query for.",
"type": "string"
},
{
"name": "delegatorAddr",
"in": "path",
"required": true,
"description": "delegator_addr defines the delegator address to query for.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/staking/v1beta1/validators/{validatorAddr}/unbonding_delegations",
"operationId": "ValidatorUnbondingDelegations",
"summary": "ValidatorUnbondingDelegations queries unbonding delegations of a validator.",
"tags": [
"Query"
],
"parameters": [
{
"name": "validatorAddr",
"in": "path",
"required": true,
"description": "validator_addr defines the validator address to query 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": {}
}
]
}