2018-09-27 07:06:40 -07:00
---
2019-01-29 11:22:47 -08:00
swagger : "2.0"
2018-09-27 07:06:40 -07:00
info :
2018-12-13 10:42:55 -08:00
version : "3.0"
2018-10-24 06:19:48 -07:00
title : Gaia-Lite for Cosmos
2019-02-19 10:15:39 -08:00
description : A REST interface for state queries, transaction generation and broadcasting.
2018-09-27 07:06:40 -07:00
tags :
2019-01-29 11:22:47 -08:00
- name : ICS0
description : Tendermint APIs, such as query blocks, transactions and validatorset
- name : ICS20
2019-02-19 10:15:39 -08:00
description : Create and broadcast transactions
2019-01-29 11:22:47 -08:00
- name : ICS21
description : Stake module APIs
- name : ICS22
description : Governance module APIs
- name : ICS23
description : Slashing module APIs
- name : ICS24
2019-02-04 16:45:18 -08:00
description : Fee distribution module APIs
2019-01-29 11:22:47 -08:00
- name : version
description : Query app version
2018-09-29 20:42:12 -07:00
schemes :
2019-01-29 11:22:47 -08:00
- https
2019-01-08 08:13:04 -08:00
host : fabo.interblock.io:1317
2018-09-27 07:06:40 -07:00
securityDefinitions :
kms :
type : basic
paths :
/version :
get :
summary : Version of Gaia-lite
tags :
2019-01-29 11:22:47 -08:00
- version
2018-09-27 07:06:40 -07:00
description : Get the version of gaia-lite running locally to compare against expected
responses :
200 :
2018-10-24 06:19:48 -07:00
description : Plaintext version i.e. "v0.25.0"
2018-09-27 07:06:40 -07:00
/node_version :
get :
summary : Version of the connected node
tags :
2019-01-29 11:22:47 -08:00
- version
2018-09-27 07:06:40 -07:00
description : Get the version of the SDK running on the connected node to compare against expected
responses :
200 :
2018-10-24 06:19:48 -07:00
description : Plaintext version i.e. "v0.25.0"
500 :
description : failed to query node version
2018-09-27 07:06:40 -07:00
/node_info :
get :
description : Information about the connected node
summary : The properties of the connected node
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-27 07:06:40 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-27 07:06:40 -07:00
responses :
200 :
description : Node status
schema :
type : object
properties :
2018-09-29 20:42:12 -07:00
id :
type : string
2018-09-27 07:06:40 -07:00
moniker :
type : string
2018-09-29 20:42:12 -07:00
example : validator-name
2018-09-27 07:06:40 -07:00
network :
type : string
example : gaia-2
2018-09-29 20:42:12 -07:00
channels :
2018-09-27 07:06:40 -07:00
type : string
listen_addr :
type : string
example : 192.168 .56 .1 : 26656
version :
description : Tendermint version
type : string
example : 0.15 .0
other :
description : more information on versions
type : array
items :
type : string
2018-10-24 06:19:48 -07:00
500 :
description : Failed to query node status
2018-09-27 07:06:40 -07:00
/syncing :
get :
summary : Syncing state of node
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-27 07:06:40 -07:00
description : Get if the node is currently syning with other nodes
responses :
200 :
description : '"true" or "false"'
2018-10-24 06:19:48 -07:00
500 :
description : Server internal error
2018-09-27 07:06:40 -07:00
/blocks/latest :
get :
summary : Get the latest block
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-27 07:06:40 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-27 07:06:40 -07:00
responses :
200 :
description : The latest block
schema :
2018-10-24 06:19:48 -07:00
$ref : "#/definitions/BlockQuery"
500 :
description : Server internal error
2018-09-27 07:06:40 -07:00
/blocks/{height}:
get :
summary : Get a block at a certain height
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-27 07:06:40 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 20:42:12 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : height
description : Block height
required : true
type : number
2018-09-27 07:06:40 -07:00
responses :
200 :
description : The block at a specific height
schema :
2018-10-24 06:19:48 -07:00
$ref : "#/definitions/BlockQuery"
2018-09-27 07:06:40 -07:00
404 :
2018-10-24 06:19:48 -07:00
description : Request block height doesn't
400 :
description : Invalid height
500 :
description : Server internal error
2018-09-27 07:06:40 -07:00
/validatorsets/latest :
get :
summary : Get the latest validator set
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-27 07:06:40 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-27 07:06:40 -07:00
responses :
200 :
description : The validator set at the latest block height
schema :
type : object
properties :
block_height :
type : number
validators :
type : array
items :
2018-10-24 06:19:48 -07:00
$ref : "#/definitions/TendermintValidator"
500 :
description : Server internal error
2018-09-27 07:06:40 -07:00
/validatorsets/{height}:
get :
summary : Get a validator set a certain height
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-27 07:06:40 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 20:42:12 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : height
description : Block height
required : true
type : number
2018-09-27 07:06:40 -07:00
responses :
200 :
description : The validator set at a specific block height
schema :
type : object
properties :
block_height :
type : number
validators :
type : array
items :
2018-10-24 06:19:48 -07:00
$ref : "#/definitions/TendermintValidator"
2018-09-27 07:06:40 -07:00
404 :
description : Block at height not available
2018-10-24 06:19:48 -07:00
400 :
description : Invalid height
500 :
description : Server internal error
2018-09-27 07:06:40 -07:00
/txs/{hash}:
get :
summary : Get a Tx by hash
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-27 07:06:40 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 20:42:12 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : hash
description : Tx hash
required : true
type : string
2018-09-27 07:06:40 -07:00
responses :
200 :
description : Tx with the provided hash
schema :
2018-09-29 20:42:12 -07:00
$ref : "#/definitions/TxQuery"
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2018-09-29 21:35:06 -07:00
/txs :
2018-09-29 20:42:12 -07:00
get :
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2018-09-29 21:35:06 -07:00
summary : Search transactions
2018-11-16 07:18:05 -08:00
description : Search transactions by tag(s).
2018-09-29 22:26:44 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 20:42:12 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : query
name : tag
type : string
description : "transaction tags such as 'action=submit-proposal' and 'proposer=cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc' which results in the following endpoint: 'GET /txs?action=submit-proposal&proposer=cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc'"
required : true
- in : query
name : page
description : Pagination page
type : integer
- in : query
name : size
description : Pagination size
type : integer
2018-09-27 07:06:40 -07:00
responses :
200 :
2018-11-16 07:18:05 -08:00
description : All txs matching the provided tags
2018-09-29 20:42:12 -07:00
schema :
type : array
items :
$ref : "#/definitions/TxQuery"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid search tags
500 :
description : Internal Server Error
2018-09-27 07:06:40 -07:00
post :
tags :
2019-01-29 11:22:47 -08:00
- ICS0
2019-02-26 03:34:27 -08:00
summary : Broadcast a signed tx
description : Broadcast a signed tx to a full node
2018-09-29 22:26:44 -07:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 22:26:44 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 20:42:12 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : txBroadcast
2019-03-25 17:54:23 -07:00
description : The tx must be a signed StdTx. The supported broadcast modes include `"block"`(return after tx commit), `"sync"`(return afer CheckTx) and `"async"`(return right away).
2019-01-29 11:22:47 -08:00
required : true
schema :
type : object
properties :
tx :
2019-02-26 03:34:27 -08:00
$ref : "#/definitions/StdTx"
2019-03-25 17:54:23 -07:00
mode :
2019-01-29 11:22:47 -08:00
type : string
example : block
2018-09-27 07:06:40 -07:00
responses :
200 :
2019-02-26 03:34:27 -08:00
description : Tx broadcasting result
2018-09-29 22:26:44 -07:00
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2019-02-26 03:34:27 -08:00
/txs/encode :
2019-02-08 13:17:25 -08:00
post :
tags :
2019-02-26 03:34:27 -08:00
- ICS0
summary : Encode a transaction to the Amino wire format
2019-02-08 13:17:25 -08:00
description : Encode a transaction (signed or not) from JSON to base64-encoded Amino serialized bytes
consumes :
- application/json
produces :
- application/json
parameters :
- in : body
name : tx
2019-02-26 03:34:27 -08:00
description : The tx to encode
2019-02-08 13:17:25 -08:00
required : true
schema :
type : object
properties :
tx :
$ref : "#/definitions/StdTx"
responses :
200 :
2019-02-26 03:34:27 -08:00
description : The tx was successfully decoded and re-encoded
2019-02-08 13:17:25 -08:00
schema :
type : object
properties :
tx :
type : string
2019-02-26 03:34:27 -08:00
example : The base64-encoded Amino-serialized bytes for the tx
2019-02-08 13:17:25 -08:00
400 :
2019-02-26 03:34:27 -08:00
description : The tx was malformated
2019-02-08 13:17:25 -08:00
500 :
description : Server internal error
2018-09-27 07:06:40 -07:00
/bank/balances/{address}:
get :
summary : Get the account balances
tags :
2019-01-29 11:22:47 -08:00
- ICS20
2018-09-27 07:06:40 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 20:42:12 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : address
description : Account address in bech32 format
required : true
type : string
2018-09-27 07:06:40 -07:00
responses :
200 :
description : Account balances
schema :
2018-09-29 20:42:12 -07:00
type : array
items :
$ref : "#/definitions/Coin"
2018-09-27 07:06:40 -07:00
204 :
2018-10-24 06:19:48 -07:00
description : There is no data for the requested account
500 :
description : Server internal error
2018-09-27 07:06:40 -07:00
/bank/accounts/{address}/transfers:
post :
2019-02-19 10:15:39 -08:00
summary : Send coins from one account to another
2018-09-27 07:06:40 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS20
2018-09-27 07:06:40 -07:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-29 22:26:44 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-09-27 07:06:40 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : address
description : Account address in bech32 format
required : true
type : string
- in : body
name : account
2019-02-19 10:15:39 -08:00
description : The sender and tx information
2019-01-29 11:22:47 -08:00
required : true
schema :
type : object
properties :
base_req :
$ref : "#/definitions/BaseReq"
amount :
type : array
items :
$ref : "#/definitions/Coin"
2018-09-27 07:06:40 -07:00
responses :
202 :
2019-02-19 10:15:39 -08:00
description : Tx was succesfully generated
2019-01-29 11:22:47 -08:00
schema :
2019-02-19 10:15:39 -08:00
$ref : "#/definitions/StdTx"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid request
500 :
description : Server internal error
2018-10-04 05:27:43 -07:00
/auth/accounts/{address}:
get :
summary : Get the account information on blockchain
tags :
2019-01-29 11:22:47 -08:00
- ICS1
2018-10-04 05:27:43 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-04 05:27:43 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : address
description : Account address
required : true
type : string
2018-10-04 05:27:43 -07:00
responses :
200 :
description : Account information on the blockchain
schema :
2018-10-24 06:19:48 -07:00
type : object
properties :
type :
type : string
value :
type : object
properties :
account_number :
type : string
address :
type : string
coins :
type : array
items :
$ref : "#/definitions/Coin"
public_key :
type : string
sequence :
type : string
204 :
description : No content about this account address
500 :
description : Server internel error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/delegations:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
2018-12-11 06:02:26 -08:00
get :
summary : Get all delegations from a delegator
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-12-11 06:02:26 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-11 06:02:26 -08:00
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/Delegation"
400 :
description : Invalid delegator address
500 :
description : Internal Server Error
2018-10-24 06:19:48 -07:00
post :
summary : Submit delegation
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : delegation
description : The password of the account to remove from the KMS
schema :
type : object
properties :
base_req :
$ref : "#/definitions/BaseReq"
2019-02-25 07:16:52 -08:00
delegator_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/Address"
2019-02-25 07:16:52 -08:00
validator_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/ValidatorAddress"
delegation :
$ref : "#/definitions/Coin"
2018-09-29 22:26:44 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
400 :
2018-12-11 06:02:26 -08:00
description : Invalid delegator address or delegation request body
2018-10-24 06:19:48 -07:00
401 :
description : Key password is wrong
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/delegations/{validatorAddr}:
2018-12-11 06:02:26 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
2018-12-11 06:02:26 -08:00
summary : Query the current delegation between a delegator and a validator
2018-09-29 22:26:44 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Delegation"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid delegator address or validator address
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/unbonding_delegations:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
summary : Get all unbonding delegations from a delegator
2018-09-29 22:26:44 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/UnbondingDelegation"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid delegator address
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
post :
summary : Submit an unbonding delegation
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : delegation
description : The password of the account to remove from the KMS
schema :
type : object
properties :
base_req :
$ref : "#/definitions/BaseReq"
2019-02-25 07:16:52 -08:00
delegator_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/Address"
2019-02-25 07:16:52 -08:00
validator_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/ValidatorAddress"
shares :
type : string
example : "100"
tags :
- ICS21
2018-12-11 06:02:26 -08:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-11 06:02:26 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-11 06:02:26 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
400 :
description : Invalid delegator address or unbonding delegation request body
401 :
description : Key password is wrong
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
2018-12-11 06:02:26 -08:00
summary : Query all unbonding delegations between a delegator and a validator
2018-09-29 22:26:44 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/UnbondingDelegation"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid delegator address or validator address
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/redelegations :
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : query
name : delegator
description : Bech32 AccAddress of Delegator
required : false
type : string
- in : query
name : validator_from
description : Bech32 ValAddress of SrcValidator
required : false
type : string
- in : query
name : validator_to
description : Bech32 ValAddress of DstValidator
required : false
type : string
2018-10-24 06:19:48 -07:00
get :
2018-12-18 13:43:41 -08:00
summary : Get all redelegations (filter by query params)
2018-09-29 20:42:12 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Redelegation"
2018-10-24 06:19:48 -07:00
500 :
2018-12-19 16:26:33 -08:00
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/redelegations:
2018-12-18 13:43:41 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
2018-12-11 06:02:26 -08:00
post :
summary : Submit a redelegation
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : delegation
2019-02-19 10:15:39 -08:00
description : The sender and tx information
2019-01-29 11:22:47 -08:00
schema :
type : object
properties :
base_req :
$ref : "#/definitions/BaseReq"
2019-02-25 07:16:52 -08:00
delegator_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/Address"
2019-02-25 07:16:52 -08:00
validator_src_addressess :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/ValidatorAddress"
2019-02-25 07:16:52 -08:00
validator_dst_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/ValidatorAddress"
shares :
type : string
example : "100"
2018-10-24 06:19:48 -07:00
tags :
2018-12-11 06:02:26 -08:00
- ICS21
consumes :
- application/json
2018-10-24 06:19:48 -07:00
produces :
2018-12-11 06:02:26 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
2019-02-19 10:15:39 -08:00
description : Tx was succesfully generated
2018-10-24 06:19:48 -07:00
schema :
2019-02-19 10:15:39 -08:00
$ref : "#/definitions/StdTx"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid delegator address or redelegation request body
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/validators:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
2018-12-11 06:02:26 -08:00
summary : Query all validators that a delegator is bonded to
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Validator"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid delegator address
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/validators/{validatorAddr}:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
- in : path
name : validatorAddr
description : Bech32 ValAddress of Delegator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
2018-12-11 06:02:26 -08:00
summary : Query a validator that a delegator is bonded to
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Validator"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid delegator address or validator address
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/delegators/{delegatorAddr}/txs:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
2018-12-11 06:02:26 -08:00
summary : Get all staking txs (i.e msgs) from a delegator
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/TxQuery"
204 :
description : No staking transaction about this delegator address
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid delegator address
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/validators :
2018-10-24 06:19:48 -07:00
get :
summary : Get all validator candidates
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/Validator"
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/validators/{validatorAddr}:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
summary : Query the information from a single validator
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/Validator"
400 :
description : Invalid validator address
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/validators/{validatorAddr}/delegations:
2018-11-12 13:53:43 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
2018-11-12 13:53:43 -08:00
get :
summary : Get all delegations from a validator
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-11-12 13:53:43 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-11-12 13:53:43 -08:00
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/Delegation"
400 :
description : Invalid validator address
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/validators/{validatorAddr}/unbonding_delegations:
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
2018-10-24 06:19:48 -07:00
get :
summary : Get all unbonding delegations from a validator
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/UnbondingDelegation"
400 :
description : Invalid validator address
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/pool :
2018-10-24 06:19:48 -07:00
get :
summary : Get the current state of the staking pool
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : object
properties :
loose_tokens :
type : string
bonded_tokens :
type : string
inflation_last_time :
type : string
inflation :
type : string
date_last_commission_reset :
type : string
prev_bonded_shares :
type : string
500 :
description : Internal Server Error
2019-01-11 12:08:01 -08:00
/staking/parameters :
2018-10-24 06:19:48 -07:00
get :
summary : Get the current staking parameter values
tags :
2019-01-29 11:22:47 -08:00
- ICS21
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : object
properties :
inflation_rate_change :
type : string
inflation_max :
type : string
inflation_min :
type : string
goal_bonded :
type : string
unbonding_time :
type : string
max_validators :
type : integer
bond_denom :
type : string
500 :
description : Internal Server Error
/slashing/validators/{validatorPubKey}/signing_info:
get :
summary : Get sign info of given validator
description : Get sign info of given validator
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS23
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : Bech32 validator public key
name : validatorPubKey
required : true
in : path
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : object
properties :
start_height :
type : string
index_offset :
type : string
jailed_until :
type : string
missed_blocks_counter :
type : string
204 :
description : No sign info of this validator
400 :
description : Invalid validator public key
500 :
description : Internal Server Error
/slashing/validators/{validatorAddr}/unjail:
post :
summary : Unjail a jailed validator
description : Send transaction to unjail a jailed validator
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS23
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : Bech32 validator address
name : validatorAddr
required : true
in : path
- description : ""
name : UnjailBody
in : body
required : true
schema :
type : object
properties :
base_req :
2019-02-19 10:15:39 -08:00
$ref : "#/definitions/StdTx"
2018-10-24 06:19:48 -07:00
responses :
200 :
2019-02-19 10:15:39 -08:00
description : Tx was succesfully generated
2018-10-24 06:19:48 -07:00
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
400 :
description : Invalid validator address or base_req
500 :
description : Internal Server Error
2018-12-14 11:09:39 -08:00
/slashing/parameters :
get :
summary : Get the current slashing parameters
tags :
2019-01-29 11:22:47 -08:00
- ICS23
2018-12-14 11:09:39 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-14 11:09:39 -08:00
responses :
200 :
description : OK
schema :
type : object
properties :
max_evidence_age :
type : integer
signed_blocks_window :
type : integer
min_signed_per_window :
type : integer
double_sign_unbond_duration :
type : integer
downtime_unbond_duration :
type : integer
slash_fraction_double_sign :
type : integer
slash_fraction_downtime :
type : integer
500 :
description : Internal Server Error
2018-10-24 06:19:48 -07:00
/gov/proposals :
post :
summary : Submit a proposal
description : Send transaction to submit a proposal
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- description : valid value of `"proposal_type"` can be `"text"`, `"parameter_change"`, `"software_upgrade"`
name : post_proposal_body
in : body
required : true
schema :
type : object
properties :
base_req :
$ref : "#/definitions/BaseReq"
title :
type : string
description :
type : string
proposal_type :
type : string
example : "text"
proposer :
$ref : "#/definitions/Address"
initial_deposit :
type : array
items :
$ref : "#/definitions/Coin"
2018-10-24 06:19:48 -07:00
responses :
200 :
2019-02-19 10:15:39 -08:00
description : Tx was succesfully generated
2018-10-24 06:19:48 -07:00
schema :
2019-02-19 10:15:39 -08:00
$ref : "#/definitions/StdTx"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid proposal body
500 :
description : Internal Server Error
get :
summary : Query proposals
description : Query proposals information with parameters
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- in : query
name : voter
description : voter address
required : false
type : string
- in : query
name : depositor
description : depositor address
required : false
type : string
- in : query
name : status
description : proposal status, valid values can be `"deposit_period"`, `"voting_period"`, `"passed"`, `"rejected"`
required : false
type : string
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/TextProposal"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid query parameters
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
/gov/proposals/{proposalId}:
get :
summary : Query a proposal
description : Query a proposal by id
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
name : proposalId
required : true
in : path
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/TextProposal"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid proposal id
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2018-12-21 09:30:46 -08:00
/gov/proposals/{proposalId}/proposer:
get :
summary : Query proposer
description : Query for the proposer for a proposal
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-21 09:30:46 -08:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-12-21 09:30:46 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
name : proposalId
required : true
in : path
2018-12-21 09:30:46 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/Proposer"
400 :
description : Invalid proposal ID
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
/gov/proposals/{proposalId}/deposits:
2018-10-24 06:19:48 -07:00
get :
summary : Query deposits
description : Query deposits by proposalId
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
name : proposalId
required : true
in : path
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Deposit"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid proposal id
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
post :
summary : Deposit tokens to a proposal
description : Send transaction to deposit tokens to a proposal
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-11-21 01:54:51 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-11-21 01:54:51 -08:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-11-21 01:54:51 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : proposal id
name : proposalId
required : true
in : path
- description : ""
name : post_deposit_body
in : body
required : true
schema :
type : object
properties :
base_req :
$ref : "#/definitions/BaseReq"
depositor :
$ref : "#/definitions/Address"
amount :
type : array
items :
$ref : "#/definitions/Coin"
2018-11-21 01:54:51 -08:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/BroadcastTxCommitResult"
2018-11-21 01:54:51 -08:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid proposal id or deposit body
401 :
description : Key password is wrong
2018-11-21 01:54:51 -08:00
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
/gov/proposals/{proposalId}/deposits/{depositor}:
get :
summary : Query deposit
description : Query deposit by proposalId and depositor address
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : proposal id
name : proposalId
required : true
in : path
- type : string
description : Bech32 depositor address
name : depositor
required : true
in : path
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Deposit"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid proposal id or depositor address
404 :
description : Found no deposit
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
/gov/proposals/{proposalId}/votes:
2018-10-24 06:19:48 -07:00
get :
summary : Query voters
description : Query voters information by proposalId
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : proposal id
name : proposalId
required : true
in : path
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Vote"
2018-10-24 06:19:48 -07:00
400 :
description : Invalid proposal id
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
post :
summary : Vote a proposal
description : Send transaction to vote a proposal
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : proposal id
name : proposalId
required : true
in : path
- description : valid value of `"option"` field can be `"yes"`, `"no"`, `"no_with_veto"` and `"abstain"`
name : post_vote_body
in : body
required : true
schema :
type : object
properties :
base_req :
$ref : "#/definitions/BaseReq"
voter :
$ref : "#/definitions/Address"
option :
type : string
example : "yes"
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/BroadcastTxCommitResult"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid proposal id or vote body
401 :
description : Key password is wrong
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
/gov/proposals/{proposalId}/votes/{voter}:
2018-10-24 06:19:48 -07:00
get :
2018-12-11 06:02:26 -08:00
summary : Query vote
description : Query vote information by proposal Id and voter address
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : proposal id
name : proposalId
required : true
in : path
- type : string
description : Bech32 voter address
name : voter
required : true
in : path
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Vote"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid proposal id or voter address
2018-10-24 06:19:48 -07:00
404 :
2018-12-11 06:02:26 -08:00
description : Found no vote
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2018-12-11 06:02:26 -08:00
/gov/proposals/{proposalId}/tally:
2018-10-24 06:19:48 -07:00
get :
2018-12-11 06:02:26 -08:00
summary : Get a proposal's tally result at the current time
description : Gets a proposal's tally result at the current time. If the proposal is pending deposits (i.e status 'DepositPeriod') it returns an empty tally result.
2018-10-24 06:19:48 -07:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-10-24 06:19:48 -07:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-10-24 06:19:48 -07:00
parameters :
2019-01-29 11:22:47 -08:00
- type : string
description : proposal id
name : proposalId
required : true
in : path
2018-10-24 06:19:48 -07:00
responses :
200 :
description : OK
schema :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/TallyResult"
2018-10-24 06:19:48 -07:00
400 :
2018-12-11 06:02:26 -08:00
description : Invalid proposal id
2018-10-24 06:19:48 -07:00
500 :
description : Internal Server Error
2018-11-13 15:45:37 -08:00
/gov/parameters/deposit :
get :
summary : Query governance deposit parameters
description : Query governance deposit parameters. The max_deposit_period units are in nanoseconds.
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-11-13 15:45:37 -08:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-11-13 15:45:37 -08:00
responses :
200 :
description : OK
schema :
type : object
properties :
min_deposit :
type : array
items :
$ref : "#/definitions/Coin"
max_deposit_period :
type : string
example : "86400000000000"
400 :
description : <other_path> is not a valid query request path
404 :
description : Found no deposit parameters
500 :
description : Internal Server Error
/gov/parameters/tallying :
get :
summary : Query governance tally parameters
description : Query governance tally parameters
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-11-13 15:45:37 -08:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-11-13 15:45:37 -08:00
responses :
200 :
description : OK
schema :
properties :
threshold :
type : string
example : "0.5000000000"
veto :
type : string
example : "0.3340000000"
governance_penalty :
type : string
example : "0.0100000000"
400 :
description : <other_path> is not a valid query request path
404 :
description : Found no tally parameters
500 :
description : Internal Server Error
/gov/parameters/voting :
get :
summary : Query governance voting parameters
description : Query governance voting parameters. The voting_period units are in nanoseconds.
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-11-13 15:45:37 -08:00
tags :
2019-01-29 11:22:47 -08:00
- ICS22
2018-11-13 15:45:37 -08:00
responses :
200 :
description : OK
schema :
properties :
voting_period :
type : string
example : "86400000000000"
400 :
description : <other_path> is not a valid query request path
404 :
description : Found no voting parameters
500 :
description : Internal Server Error
2018-12-13 10:42:55 -08:00
/distribution/delegators/{delegatorAddr}/rewards:
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
2018-12-13 10:42:55 -08:00
get :
summary : Get the total rewards balance from all delegations
description : Get the sum of all the rewards earned by delegations by a single delegator
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/Coin"
400 :
description : Invalid delegator address
500 :
description : Internal Server Error
post :
summary : Withdraw all the delegator's delegation rewards
description : Withdraw all the delegator's delegation rewards
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : Withdraw request body
schema :
properties :
base_req :
$ref : "#/definitions/BaseReq"
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
400 :
description : Invalid delegator address
401 :
description : Key password is wrong
500 :
description : Internal Server Error
/distribution/delegators/{delegatorAddr}/rewards/{validatorAddr}:
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
2018-12-13 10:42:55 -08:00
get :
summary : Query a delegation reward
description : Query a single delegation reward by a delegator
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/Coin"
400 :
description : Invalid delegator address
500 :
description : Internal Server Error
post :
summary : Withdraw a delegation reward
description : Withdraw a delegator's delegation reward from a single validator
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : Withdraw request body
schema :
properties :
base_req :
$ref : "#/definitions/BaseReq"
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
400 :
description : Invalid delegator address or delegation body
401 :
description : Key password is wrong
500 :
description : Internal Server Error
/distribution/delegators/{delegatorAddr}/withdraw_address:
parameters :
2019-01-29 11:22:47 -08:00
- in : path
name : delegatorAddr
description : Bech32 AccAddress of Delegator
required : true
type : string
2018-12-13 10:42:55 -08:00
get :
summary : Get the rewards withdrawal address
description : Get the delegations' rewards withdrawal address. This is the address in which the user will receive the reward funds
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/Address"
400 :
description : Invalid delegator address
500 :
description : Internal Server Error
post :
summary : Replace the rewards withdrawal address
description : Replace the delegations' rewards withdrawal address for a new one.
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : Withdraw request body
schema :
properties :
base_req :
$ref : "#/definitions/BaseReq"
withdraw_address :
$ref : "#/definitions/Address"
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
400 :
description : Invalid delegator or withdraw address
401 :
description : Key password is wrong
500 :
description : Internal Server Error
/distribution/validators/{validatorAddr}:
parameters :
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
get :
summary : Validator distribution information
description : Query the distribution information of a single validator
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/ValidatorDistInfo"
400 :
description : Invalid validator address
500 :
description : Internal Server Error
2019-03-06 10:54:12 -08:00
/distribution/validators/{validatorAddr}/outstanding_rewards:
parameters :
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
get :
summary : Fee distribution outstanding rewards of a single validator
tags :
- ICS24
produces :
- application/json
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/Coin"
500 :
description : Internal Server Error
2018-12-13 10:42:55 -08:00
/distribution/validators/{validatorAddr}/rewards:
parameters :
- in : path
name : validatorAddr
description : Bech32 OperatorAddress of validator
required : true
type : string
get :
2019-03-06 10:54:12 -08:00
summary : Commission and self-delegation rewards of a single validator
description : Query the commission and self-delegation rewards of validator.
2018-12-13 10:42:55 -08:00
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
type : array
items :
$ref : "#/definitions/Coin"
400 :
description : Invalid validator address
500 :
description : Internal Server Error
post :
summary : Withdraw the validator's rewards
description : Withdraw the validator's self-delegation and commissions rewards
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
consumes :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
parameters :
2019-01-29 11:22:47 -08:00
- in : body
name : Withdraw request body
schema :
properties :
base_req :
$ref : "#/definitions/BaseReq"
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
$ref : "#/definitions/BroadcastTxCommitResult"
400 :
description : Invalid validator address
401 :
description : Key password is wrong
500 :
description : Internal Server Error
/distribution/parameters :
get :
summary : Fee distribution parameters
tags :
2019-01-29 11:22:47 -08:00
- ICS24
2018-12-13 10:42:55 -08:00
produces :
2019-01-29 11:22:47 -08:00
- application/json
2018-12-13 10:42:55 -08:00
responses :
200 :
description : OK
schema :
properties :
base_proposer_reward :
type : string
bonus_proposer_reward :
type : string
community_tax :
type : string
500 :
description : Internal Server Error
2018-10-24 06:19:48 -07:00
definitions :
CheckTxResult :
type : object
properties :
code :
type : integer
data :
2018-09-29 20:42:12 -07:00
type : string
2018-10-24 06:19:48 -07:00
gas_used :
type : integer
gas_wanted :
type : integer
info :
2018-09-27 07:06:40 -07:00
type : string
2018-10-24 06:19:48 -07:00
log :
2018-09-29 20:42:12 -07:00
type : string
2018-10-24 06:19:48 -07:00
tags :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/KVPair"
2018-10-24 06:19:48 -07:00
example :
code : 0
data : data
log : log
gas_used : 5000
gas_wanted : 10000
info : info
tags :
2019-01-29 11:22:47 -08:00
- ""
- ""
2018-10-24 06:19:48 -07:00
DeliverTxResult :
type : object
properties :
code :
type : integer
data :
2018-09-29 20:42:12 -07:00
type : string
2018-10-24 06:19:48 -07:00
gas_used :
type : integer
gas_wanted :
type : integer
info :
type : string
log :
type : string
tags :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/KVPair"
2018-10-24 06:19:48 -07:00
example :
code : 5
data : data
log : log
gas_used : 5000
gas_wanted : 10000
info : info
tags :
2019-01-29 11:22:47 -08:00
- ""
- ""
2018-10-24 06:19:48 -07:00
BroadcastTxCommitResult :
type : object
properties :
check_tx :
$ref : "#/definitions/CheckTxResult"
deliver_tx :
$ref : "#/definitions/DeliverTxResult"
hash :
$ref : "#/definitions/Hash"
height :
type : integer
KVPair :
type : object
properties :
key :
type : string
value :
type : string
Msg :
type : string
Address :
type : string
description : bech32 encoded address
example : cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
ValidatorAddress :
type : string
description : bech32 encoded address
example : cosmosvaloper1depk54cuajgkzea6zpgkq36tnjwdzv4avv9cxd
Coin :
type : object
properties :
denom :
type : string
2019-03-14 07:32:46 -07:00
example : stake
2018-10-24 06:19:48 -07:00
amount :
type : string
example : "50"
Hash :
type : string
example : EE5F3404034C524501629B56E0DDC38FAD651F04
TxQuery :
type : object
properties :
hash :
type : string
height :
type : number
tx :
$ref : "#/definitions/StdTx"
result :
type : object
properties :
log :
type : string
gas_wanted :
type : string
example : "0"
gas_used :
type : string
example : "0"
tags :
type : array
items :
$ref : "#/definitions/KVPair"
2018-09-29 20:42:12 -07:00
StdTx :
type : object
properties :
msg :
type : array
items :
$ref : "#/definitions/Msg"
fee :
2018-10-24 06:19:48 -07:00
type : object
properties :
gas :
type : string
amount :
type : array
items :
$ref : "#/definitions/Coin"
2018-09-29 20:42:12 -07:00
memo :
type : string
signature :
2018-09-27 07:06:40 -07:00
type : object
properties :
signature :
2018-09-29 20:42:12 -07:00
type : string
example : MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
pub_key :
2018-10-24 06:19:48 -07:00
type : object
properties :
type :
type : string
example : "tendermint/PubKeySecp256k1"
value :
type : string
example : "Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH"
2018-09-29 20:42:12 -07:00
account_number :
type : string
example : "0"
sequence :
type : string
example : "0"
2018-10-24 06:19:48 -07:00
KeyOutput :
2018-09-27 07:06:40 -07:00
type : object
properties :
name :
type : string
example : Main Account
address :
2018-10-24 06:19:48 -07:00
type : string
example : cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
2018-09-27 07:06:40 -07:00
pub_key :
2018-10-04 05:27:43 -07:00
type : string
2018-10-24 06:19:48 -07:00
example : "cosmospub1addwnpepqtqc88gfdxyzcdm2eqr3tnlnxnelyqehy8k95qzgwdz5zccdft9rq5q7wj2"
2018-10-04 05:27:43 -07:00
type :
type : string
example : local
seed :
type : string
2018-09-27 07:06:40 -07:00
BlockID :
type : object
properties :
hash :
$ref : "#/definitions/Hash"
parts :
type : object
properties :
total :
type : number
example : 0
hash :
$ref : "#/definitions/Hash"
2018-09-29 20:42:12 -07:00
BlockHeader :
type : object
properties :
chain_id :
type : string
example : gaia-2
height :
type : number
example : 1
time :
type : string
2019-01-29 11:22:47 -08:00
example : "2017-12-30T05:53:09.287+01:00"
2018-09-29 20:42:12 -07:00
num_txs :
type : number
example : 0
last_block_id :
$ref : "#/definitions/BlockID"
total_txs :
type : number
example : 35
last_commit_hash :
$ref : "#/definitions/Hash"
data_hash :
$ref : "#/definitions/Hash"
validators_hash :
$ref : "#/definitions/Hash"
2018-10-24 06:19:48 -07:00
next_validators_hash :
$ref : "#/definitions/Hash"
2018-09-29 20:42:12 -07:00
consensus_hash :
$ref : "#/definitions/Hash"
app_hash :
$ref : "#/definitions/Hash"
last_results_hash :
$ref : "#/definitions/Hash"
evidence_hash :
$ref : "#/definitions/Hash"
2018-10-24 06:19:48 -07:00
proposer_address :
$ref : "#/definitions/Address"
2018-09-27 07:06:40 -07:00
Block :
type : object
properties :
header :
2018-09-29 20:42:12 -07:00
$ref : "#/definitions/BlockHeader"
2018-09-27 07:06:40 -07:00
txs :
type : array
items :
2018-09-29 20:42:12 -07:00
type : string
2018-09-27 07:06:40 -07:00
evidence :
type : array
items :
2018-09-29 20:42:12 -07:00
type : string
2018-09-27 07:06:40 -07:00
last_commit :
type : object
properties :
2018-09-29 20:42:12 -07:00
block_id :
2018-09-27 07:06:40 -07:00
$ref : "#/definitions/BlockID"
precommits :
type : array
items :
type : object
2018-09-29 20:42:12 -07:00
properties :
validator_address :
type : string
validator_index :
type : string
example : "0"
height :
type : string
example : "0"
round :
type : string
example : "0"
timestamp :
type : string
2019-01-29 11:22:47 -08:00
example : "2017-12-30T05:53:09.287+01:00"
2018-09-29 20:42:12 -07:00
type :
type : number
example : 2
block_id :
$ref : "#/definitions/BlockID"
signature :
type : string
2019-01-29 11:22:47 -08:00
example : "7uTC74QlknqYWEwg7Vn6M8Om7FuZ0EO4bjvuj6rwH1mTUJrRuMMZvAAqT9VjNgP0RA/TDp6u/92AqrZfXJSpBQ=="
2018-10-24 06:19:48 -07:00
BlockQuery :
2018-09-29 20:42:12 -07:00
type : object
properties :
block_meta :
2018-10-24 06:19:48 -07:00
type : object
properties :
header :
$ref : "#/definitions/BlockHeader"
block_id :
$ref : "#/definitions/BlockID"
2018-09-29 20:42:12 -07:00
block :
$ref : "#/definitions/Block"
2018-09-29 22:26:44 -07:00
BaseReq :
type : object
properties :
2019-01-29 11:22:47 -08:00
from :
2018-09-29 22:26:44 -07:00
type : string
2019-01-29 11:22:47 -08:00
example : "cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc"
description : Sender address or Keybase name to generate a transaction
2018-12-19 16:26:33 -08:00
memo :
type : string
example : "Sent via Cosmos Voyager 🚀"
2018-09-29 22:26:44 -07:00
chain_id :
type : string
2018-12-19 16:26:33 -08:00
example : "Cosmos-Hub"
2018-09-29 22:26:44 -07:00
account_number :
type : string
example : "0"
sequence :
type : string
2018-12-19 16:26:33 -08:00
example : "1"
2018-09-29 22:26:44 -07:00
gas :
type : string
example : "200000"
gas_adjustment :
type : string
example : "1.2"
2018-12-19 16:26:33 -08:00
fees :
type : array
items :
$ref : "#/definitions/Coin"
2018-12-10 08:00:38 -08:00
simulate :
type : boolean
2019-01-29 11:22:47 -08:00
example : false
description : Estimate gas for a transaction (cannot be used in conjunction with generate_only)
2018-10-24 06:19:48 -07:00
TendermintValidator :
2018-09-27 07:06:40 -07:00
type : object
properties :
address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/ValidatorAddress"
2018-09-27 07:06:40 -07:00
pub_key :
2018-10-24 06:19:48 -07:00
type : string
example : cosmosvalconspub1zcjduepq7sjfglw7ra4mjxpw4ph7dtdhdheh7nz8dfgl6t8u2n5szuuql9mqsrwquu
2018-09-27 07:06:40 -07:00
power :
2018-10-24 06:19:48 -07:00
type : string
example : "1000"
2019-02-04 16:45:18 -08:00
proposer_priority :
2018-10-24 06:19:48 -07:00
type : string
example : "1000"
TextProposal :
type : object
properties :
proposal_id :
type : integer
title :
type : string
description :
type : string
proposal_type :
type : string
proposal_status :
type : string
2019-01-10 07:02:55 -08:00
final_tally_result :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/TallyResult"
2018-10-24 06:19:48 -07:00
submit_time :
type : string
total_deposit :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Coin"
2018-10-24 06:19:48 -07:00
voting_start_time :
type : string
2018-12-21 09:30:46 -08:00
Proposer :
type : object
properties :
proposal_id :
type : integer
proposer :
type : string
2018-10-24 06:19:48 -07:00
Deposit :
type : object
properties :
amount :
type : array
items :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Coin"
2018-10-24 06:19:48 -07:00
proposal_id :
type : integer
2018-11-21 15:53:33 -08:00
depositor :
2018-12-11 06:02:26 -08:00
$ref : "#/definitions/Address"
2018-11-21 01:54:51 -08:00
TallyResult :
type : object
properties :
yes :
type : string
example : "0.0000000000"
abstain :
type : string
example : "0.0000000000"
no :
type : string
example : "0.0000000000"
no_with_veto :
type : string
example : "0.0000000000"
2018-10-24 06:19:48 -07:00
Vote :
type : object
properties :
voter :
type : string
proposal_id :
type : integer
option :
type : string
Validator :
type : object
properties :
operator_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/ValidatorAddress"
2018-10-24 06:19:48 -07:00
consensus_pubkey :
type : string
example : cosmosvalconspub1zcjduepq7sjfglw7ra4mjxpw4ph7dtdhdheh7nz8dfgl6t8u2n5szuuql9mqsrwquu
jailed :
type : boolean
status :
type : integer
tokens :
type : string
delegator_shares :
type : string
description :
type : object
properties :
moniker :
type : string
identity :
type : string
website :
type : string
details :
type : string
bond_height :
type : string
2019-01-29 11:22:47 -08:00
example : "0"
2018-10-24 06:19:48 -07:00
bond_intra_tx_counter :
type : integer
example : 0
unbonding_height :
type : string
2019-01-29 11:22:47 -08:00
example : "0"
2018-10-24 06:19:48 -07:00
unbonding_time :
type : string
2019-01-29 11:22:47 -08:00
example : "1970-01-01T00:00:00Z"
2018-10-24 06:19:48 -07:00
commission :
type : object
properties :
rate :
type : string
2019-01-29 11:22:47 -08:00
example : "0"
2018-10-24 06:19:48 -07:00
max_rate :
type : string
2019-01-29 11:22:47 -08:00
example : "0"
2018-10-24 06:19:48 -07:00
max_change_rate :
type : string
2019-01-29 11:22:47 -08:00
example : "0"
2018-10-24 06:19:48 -07:00
update_time :
type : string
2019-01-29 11:22:47 -08:00
example : "1970-01-01T00:00:00Z"
2018-10-24 06:19:48 -07:00
Delegation :
type : object
properties :
2019-02-25 07:16:52 -08:00
delegator_address :
2018-10-24 06:19:48 -07:00
type : string
2019-02-25 07:16:52 -08:00
validator_address :
2018-10-24 06:19:48 -07:00
type : string
shares :
type : string
height :
type : integer
UnbondingDelegation :
type : object
properties :
2019-02-25 07:16:52 -08:00
delegator_address :
2018-10-24 06:19:48 -07:00
type : string
2019-02-25 07:16:52 -08:00
validator_address :
2018-10-24 06:19:48 -07:00
type : string
initial_balance :
type : string
balance :
type : string
creation_height :
type : integer
min_time :
type : integer
Redelegation :
type : object
properties :
2019-02-25 07:16:52 -08:00
delegator_address :
2018-10-24 06:19:48 -07:00
type : string
2019-02-25 07:16:52 -08:00
validator_src_address :
2018-10-24 06:19:48 -07:00
type : string
2019-02-25 07:16:52 -08:00
validator_dst_address :
2018-10-24 06:19:48 -07:00
type : string
creation_height :
type : integer
min_time :
type : integer
initial_balance :
type : string
balance :
type : string
shares_src :
type : string
shares_dst :
type : string
2018-12-13 10:42:55 -08:00
ValidatorDistInfo :
type : object
properties :
2019-02-25 07:16:52 -08:00
operator_address :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/ValidatorAddress"
2019-02-04 16:45:18 -08:00
self_bond_rewards :
2018-12-13 10:42:55 -08:00
type : array
items :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/Coin"
2018-12-13 10:42:55 -08:00
val_commission :
type : array
items :
2019-01-29 11:22:47 -08:00
$ref : "#/definitions/Coin"