Skip to content
LogoLogo

Gov

Constitution

GET/cosmos/gov/v1/constitution

Constitution queries the chain's constitution.

Responses

Params

GET/cosmos/gov/v1/params/{params_type}

Params queries all parameters of the gov module.

Path Parameters

params_typeRequired
string

params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

Responses

Proposals

GET/cosmos/gov/v1/proposals

Proposals queries all proposals based on given status.

Query Parameters

proposal_status
string

proposal_status defines the status of the proposals.

  • PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
  • PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
  • PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
  • PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
  • PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
  • PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
Values
PROPOSAL_STATUS_UNSPECIFIEDPROPOSAL_STATUS_DEPOSIT_PERIODPROPOSAL_STATUS_VOTING_PERIODPROPOSAL_STATUS_PASSEDPROPOSAL_STATUS_REJECTED
voter
string

voter defines the voter address for the proposals.

depositor
string

depositor defines the deposit addresses from the proposals.

pagination.key
string

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.offset
string <uint64>

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.limit
string <uint64>

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_total
boolean

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.reverse
boolean

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

Responses

Proposal

GET/cosmos/gov/v1/proposals/{proposal_id}

Proposal queries proposal details based on ProposalID.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Deposits

GET/cosmos/gov/v1/proposals/{proposal_id}/deposits

Deposits queries all deposits of a single proposal.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Query Parameters

pagination.key
string

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.offset
string <uint64>

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.limit
string <uint64>

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_total
boolean

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.reverse
boolean

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

Responses

Deposit

GET/cosmos/gov/v1/proposals/{proposal_id}/deposits/{depositor}

Deposit queries single deposit information based on proposalID, depositAddr.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

depositorRequired
string

depositor defines the deposit addresses from the proposals.

Responses

TallyResult

GET/cosmos/gov/v1/proposals/{proposal_id}/tally

TallyResult queries the tally of a proposal vote.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Votes

GET/cosmos/gov/v1/proposals/{proposal_id}/votes

Votes queries votes of a given proposal.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Query Parameters

pagination.key
string

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.offset
string <uint64>

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.limit
string <uint64>

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_total
boolean

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.reverse
boolean

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

Responses

Vote

GET/cosmos/gov/v1/proposals/{proposal_id}/votes/{voter}

Vote queries voted information based on proposalID, voterAddr.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

voterRequired
string

voter defines the voter address for the proposals.

Responses

Params

GET/cosmos/gov/v1beta1/params/{params_type}

Params queries all parameters of the gov module.

Path Parameters

params_typeRequired
string

params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

Responses

Proposals

GET/cosmos/gov/v1beta1/proposals

Proposals queries all proposals based on given status.

Query Parameters

proposal_status
string

proposal_status defines the status of the proposals.

  • PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
  • PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
  • PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
  • PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
  • PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
  • PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
Values
PROPOSAL_STATUS_UNSPECIFIEDPROPOSAL_STATUS_DEPOSIT_PERIODPROPOSAL_STATUS_VOTING_PERIODPROPOSAL_STATUS_PASSEDPROPOSAL_STATUS_REJECTED
voter
string

voter defines the voter address for the proposals.

depositor
string

depositor defines the deposit addresses from the proposals.

pagination.key
string

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.offset
string <uint64>

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.limit
string <uint64>

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_total
boolean

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.reverse
boolean

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

Responses

Proposal

GET/cosmos/gov/v1beta1/proposals/{proposal_id}

Proposal queries proposal details based on ProposalID.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Deposits

GET/cosmos/gov/v1beta1/proposals/{proposal_id}/deposits

Deposits queries all deposits of a single proposal.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Query Parameters

pagination.key
string

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.offset
string <uint64>

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.limit
string <uint64>

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_total
boolean

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.reverse
boolean

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

Responses

Deposit

GET/cosmos/gov/v1beta1/proposals/{proposal_id}/deposits/{depositor}

Deposit queries single deposit information based on proposalID, depositor address.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

depositorRequired
string

depositor defines the deposit addresses from the proposals.

Responses

TallyResult

GET/cosmos/gov/v1beta1/proposals/{proposal_id}/tally

TallyResult queries the tally of a proposal vote.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Responses

Votes

GET/cosmos/gov/v1beta1/proposals/{proposal_id}/votes

Votes queries votes of a given proposal.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

Query Parameters

pagination.key
string

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.offset
string <uint64>

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.limit
string <uint64>

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_total
boolean

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.reverse
boolean

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

Responses

Vote

GET/cosmos/gov/v1beta1/proposals/{proposal_id}/votes/{voter}

Vote queries voted information based on proposalID, voterAddr.

Path Parameters

proposal_idRequired
string <uint64>

proposal_id defines the unique id of the proposal.

voterRequired
string

voter defines the voter address for the proposals.

Responses