Cosmos Gov V1 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/gov/v1",
"baseURL": "https://lcd.cosmos.network",
"operations": [
{
"method": "GET",
"path": "/cosmos/gov/v1/constitution",
"operationId": "Constitution",
"summary": "Constitution queries the chain's constitution.",
"tags": [
"Query"
],
"parameters": [],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/gov/v1/params/{paramsType}",
"operationId": "GovV1Params",
"summary": "Params queries all parameters of the gov module.",
"tags": [
"Query"
],
"parameters": [
{
"name": "paramsType",
"in": "path",
"required": true,
"description": "params_type defines which parameters to query for, can be one of \"voting\",\n\"tallying\" or \"deposit\".",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/gov/v1/proposals",
"operationId": "GovV1Proposal",
"summary": "Proposals queries all proposals based on given status.",
"tags": [
"Query"
],
"parameters": [
{
"name": "proposalStatus",
"in": "query",
"required": false,
"description": "proposal_status defines the status of the proposals.\n\n - PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.\n - PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit\nperiod.\n - PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting\nperiod.\n - PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has\npassed.\n - PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has\nbeen rejected.\n - PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has\nfailed.",
"type": "string"
},
{
"name": "voter",
"in": "query",
"required": false,
"description": "voter defines the voter address for the proposals.",
"type": "string"
},
{
"name": "depositor",
"in": "query",
"required": false,
"description": "depositor defines the deposit addresses from the proposals.",
"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/gov/v1/proposals/{proposalId}",
"operationId": "GovV1Proposal",
"summary": "Proposal queries proposal details based on ProposalID.",
"tags": [
"Query"
],
"parameters": [
{
"name": "proposalId",
"in": "path",
"required": true,
"description": "proposal_id defines the unique id of the proposal.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/gov/v1/proposals/{proposalId}/deposits",
"operationId": "GovV1Deposit",
"summary": "Deposits queries all deposits of a single proposal.",
"tags": [
"Query"
],
"parameters": [
{
"name": "proposalId",
"in": "path",
"required": true,
"description": "proposal_id defines the unique id of the proposal.",
"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/gov/v1/proposals/{proposalId}/deposits/{depositor}",
"operationId": "GovV1Deposit",
"summary": "Deposit queries single deposit information based on proposalID, depositAddr.",
"tags": [
"Query"
],
"parameters": [
{
"name": "proposalId",
"in": "path",
"required": true,
"description": "proposal_id defines the unique id of the proposal.",
"type": "string"
},
{
"name": "depositor",
"in": "path",
"required": true,
"description": "depositor defines the deposit addresses from the proposals.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/gov/v1/proposals/{proposalId}/tally",
"operationId": "GovV1TallyResult",
"summary": "TallyResult queries the tally of a proposal vote.",
"tags": [
"Query"
],
"parameters": [
{
"name": "proposalId",
"in": "path",
"required": true,
"description": "proposal_id defines the unique id of the proposal.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
},
{
"method": "GET",
"path": "/cosmos/gov/v1/proposals/{proposalId}/votes",
"operationId": "GovV1Votes",
"summary": "Votes queries votes of a given proposal.",
"tags": [
"Query"
],
"parameters": [
{
"name": "proposalId",
"in": "path",
"required": true,
"description": "proposal_id defines the unique id of the proposal.",
"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/gov/v1/proposals/{proposalId}/votes/{voter}",
"operationId": "GovV1Vote",
"summary": "Vote queries voted information based on proposalID, voterAddr.",
"tags": [
"Query"
],
"parameters": [
{
"name": "proposalId",
"in": "path",
"required": true,
"description": "proposal_id defines the unique id of the proposal.",
"type": "string"
},
{
"name": "voter",
"in": "path",
"required": true,
"description": "voter defines the voter address for the proposals.",
"type": "string"
}
],
"example_request": {},
"example_response": {}
}
]
}