Documentation Powered by Redocly

Minter Node API v2 (1.7.0)

Download OpenAPI specification:Download

Minter gRPC-Gateway: sk@minter.org URL: https://github.com/MinterTeam/node-grpc-gateway License: MIT
More about Minter blockchain

ApiService

Balance

Address

Address returns coins list, balance and transaction count of an address.

path Parameters
address
required
string
query Parameters
height
integer <uint64>
delegated
boolean
Default: "false"

Responses

Response samples

Content type
application/json
{
  • "balance": [
    ],
  • "delegated": [
    ],
  • "total": [
    ],
  • "transaction_count": "string",
  • "bip_value": "string",
  • "locked_stake_until_block": "string",
  • "multisig": {
    }
}

Addresses

Addresses returns list of addresses.

query Parameters
addresses
required
Array of strings
height
integer <uint64>
delegated
boolean
Default: "false"

Responses

Response samples

Content type
application/json
{
  • "addresses": {
    }
}

Frozen

Frozen returns frozen balance. Deprecated: Use FrozenAll instead.

path Parameters
address
required
string
query Parameters
coin_id
integer <uint64>
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "frozen": [
    ]
}

FrozenAll

FrozenAll returns frozen balance.

query Parameters
start_height
integer <uint64>
end_height
integer <uint64>
height
integer <uint64>
addresses
Array of strings
coin_ids
Array of strings <uint64>

Responses

Response samples

Content type
application/json
{
  • "frozen": [
    ]
}

WaitList

WaitList returns the list of address stakes in waitlist.

path Parameters
address
required
string
query Parameters
public_key
string
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

WaitLists

WaitLists returns the list addresses and stakes in waitlist.

query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Price

BestTrade

BestTrade returns optimal exchange route.

path Parameters
sell_coin
required
string <uint64>
buy_coin
required
string <uint64>
type
required
string
Enum: "input" "output"
amount
required
string
query Parameters
height
integer <uint64>
max_depth
integer <int32>
Default: "4"

Responses

Response samples

Content type
application/json
{
  • "path": [
    ],
  • "result": "string"
}

EstimateCoinBuy

EstimateCoinBuy returns estimate of buy coin transaction.

query Parameters
coin_id_to_buy
integer <uint64>
coin_to_buy
string
coin_id_to_sell
integer <uint64>
coin_to_sell
string
value_to_buy
required
string
height
integer <uint64>
coin_id_commission
integer <uint64>
coin_commission
string
swap_from
string
Default: "optimal"
Enum: "optimal" "bancor" "pool"
route
Array of strings <uint64>

Responses

Response samples

Content type
application/json
{
  • "will_pay": "string",
  • "commission": "string",
  • "swap_from": "optimal"
}

EstimateCoinSell

EstimateCoinSell returns estimate of sell coin transaction.

query Parameters
coin_id_to_buy
integer <uint64>
coin_to_buy
string
coin_id_to_sell
integer <uint64>
coin_to_sell
string
value_to_sell
required
string
height
integer <uint64>
coin_id_commission
integer <uint64>
coin_commission
string
swap_from
string
Default: "optimal"
Enum: "optimal" "bancor" "pool"
route
Array of strings <uint64>

Responses

Response samples

Content type
application/json
{
  • "will_get": "string",
  • "commission": "string",
  • "swap_from": "optimal"
}

EstimateCoinSellAll

EstimateCoinSellAll returns estimate of sell all coin transaction.

query Parameters
coin_id_to_buy
integer <uint64>
coin_to_buy
string
coin_id_to_sell
integer <uint64>
coin_to_sell
string
value_to_sell
required
string
gas_price
integer <uint64>
Default: "1"
height
integer <uint64>
swap_from
string
Default: "optimal"
Enum: "optimal" "bancor" "pool"
route
Array of strings <uint64>

Responses

Response samples

Content type
application/json
{
  • "will_get": "string",
  • "swap_from": "optimal"
}

EstimateTxCommission

EstimateTxCommission returns estimate of transaction.

path Parameters
tx
required
string
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "commission": "string"
}

MaxGasPrice

MaxGasPrice returns current max gas.

query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "max_gas_price": "string"
}

MinGasPrice

MinGasPrice returns current min gas price.

Responses

Response samples

Content type
application/json
{
  • "min_gas_price": "string"
}

PriceCommission

PriceCommission returns commissions.

query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "coin": {
    },
  • "payload_byte": "string",
  • "send": "string",
  • "buy_bancor": "string",
  • "sell_bancor": "string",
  • "sell_all_bancor": "string",
  • "buy_pool_base": "string",
  • "buy_pool_delta": "string",
  • "sell_pool_base": "string",
  • "sell_pool_delta": "string",
  • "sell_all_pool_base": "string",
  • "sell_all_pool_delta": "string",
  • "create_ticker3": "string",
  • "create_ticker4": "string",
  • "create_ticker5": "string",
  • "create_ticker6": "string",
  • "create_ticker7_10": "string",
  • "create_coin": "string",
  • "create_token": "string",
  • "recreate_coin": "string",
  • "recreate_token": "string",
  • "declare_candidacy": "string",
  • "delegate": "string",
  • "unbond": "string",
  • "redeem_check": "string",
  • "set_candidate_on": "string",
  • "set_candidate_off": "string",
  • "create_multisig": "string",
  • "multisend_base": "string",
  • "multisend_delta": "string",
  • "edit_candidate": "string",
  • "set_halt_block": "string",
  • "edit_ticker_owner": "string",
  • "edit_multisig": "string",
  • "edit_candidate_public_key": "string",
  • "create_swap_pool": "string",
  • "add_liquidity": "string",
  • "remove_liquidity": "string",
  • "edit_candidate_commission": "string",
  • "mint_token": "string",
  • "burn_token": "string",
  • "vote_commission": "string",
  • "vote_update": "string",
  • "failed_tx": "string",
  • "add_limit_order": "string",
  • "remove_limit_order": "string",
  • "move_stake": "string",
  • "lock_stake": "string",
  • "lock": "string"
}

Blockchain

Block

Block returns block data at given height.

path Parameters
height
required
string <uint64>
query Parameters
fields
Array of strings
Items Enum: "transactions" "missed" "block_reward" "size" "proposer" "validators" "evidence"
failed_txs
boolean
Default: "false"
events
boolean
Default: "false"

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "height": "string",
  • "time": "string",
  • "transaction_count": "string",
  • "transactions": [
    ],
  • "block_reward": "string",
  • "locked_stake_rewards": "string",
  • "size": "string",
  • "proposer": "string",
  • "validators": [
    ],
  • "evidence": {
    },
  • "missed": [
    ],
  • "events": [
    ]
}

Blocks

Blocks returns blocks at given interval.

query Parameters
from_height
required
integer <uint64>
to_height
required
integer <uint64>
fields
Array of strings
Items Enum: "transactions" "missed" "block_reward" "size" "proposer" "validators" "evidence"
failed_txs
boolean
Default: "false"
events
boolean
Default: "false"

Responses

Response samples

Content type
application/json
{
  • "blocks": [
    ]
}

Genesis

Genesis returns genesis file.

Responses

Response samples

Content type
application/json
{
  • "genesis_time": "string",
  • "chain_id": "string",
  • "initial_height": "string",
  • "consensus_params": {
    },
  • "app_hash": "string",
  • "app_state": {
    }
}

NetInfo

NetInfo returns network info

Responses

Response samples

Content type
application/json
{
  • "listening": true,
  • "listeners": [
    ],
  • "count_peers": "string",
  • "peers": [
    ]
}

SendTransaction

SendTransaction returns the result of sending signed tx. To ensure that transaction was successfully committed to the blockchain, you need to find the transaction by the hash and ensure that the status code equals to 0.

More about Minter transactions
Request Body schema: application/json
tx
string

Responses

Request samples

Content type
application/json
{
  • "tx": "string"
}

Response samples

Content type
application/json
{
  • "code": "0",
  • "log": "",
  • "hash": "Mt6019f740983dc43b53ea9c37891af0c9ce7251399ebaafc4ea56d68d665adfcb"
}

SendTransaction

SendTransaction returns the result of sending signed tx. To ensure that transaction was successfully committed to the blockchain, you need to find the transaction by the hash and ensure that the status code equals to 0.

More about Minter transactions
path Parameters
tx
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "0",
  • "log": "",
  • "hash": "Mt6019f740983dc43b53ea9c37891af0c9ce7251399ebaafc4ea56d68d665adfcb"
}

Status

Status returns node status including pubkey, latest block.

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "network": "string",
  • "initial_height": "string",
  • "latest_block_hash": "string",
  • "latest_app_hash": "string",
  • "latest_block_height": "string",
  • "latest_block_time": "string",
  • "keep_last_states": "string",
  • "total_slashed": "string",
  • "current_emission": "string",
  • "catching_up": true,
  • "public_key": "string",
  • "node_id": "string",
  • "moniker": "string"
}

Transaction

Transaction returns transaction info.

path Parameters
hash
required
string

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "raw_tx": "string",
  • "height": "string",
  • "index": "string",
  • "from": "string",
  • "nonce": "string",
  • "gas": "string",
  • "gas_price": "string",
  • "gas_coin": {
    },
  • "type_hex": "string",
  • "type": "string",
  • "data": {
    },
  • "payload": "string",
  • "service_data": "string",
  • "tags": {
    },
  • "code": "string",
  • "log": "string"
}

Transactions

Transactions returns transactions by query.

query Parameters
query
required
string
page
integer <int32>
Default: "1"
per_page
integer <int32>
Default: "30"

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

UnconfirmedTxs

UnconfirmedTxs returns unconfirmed transactions.

query Parameters
limit
integer <int32>
Default: "30"

Responses

Response samples

Content type
application/json
{
  • "transaction_count": "string",
  • "total_transactions": "string",
  • "total_bytes": "string",
  • "transactions": [
    ]
}

VersionNetwork

VersionNetwork returns versions network.

Responses

Response samples

Content type
application/json
{
  • "current": "string",
  • "versions": [
    ]
}

Validator

Candidate

Candidate returns candidate’s info by provided public key.

Fields of response

Name Description
id
reward_address Address where validator’s rewards go to.
owner_address Address that allows one to start the candidate by sending the SetCandidateOnline transaction or stop it by sending the SetCandidateOffline transaction. It also enables the owner to edit the node by sending EditCandidate.
control_address Address that allows one to start the candidate by sending the SetCandidateOnline transaction or stop it by sending the SetCandidateOffline transaction.
total_stake Total stake of a candidate
public_key Public key of a candidate
commission Commission (from 0 to 100) from rewards which delegators will pay to validator
used_slots Number of occupied steak slots. Note: filled in when request includes_stakes
uniq_users Number of unique wallets in steaks. Note: filled in when request includes_stakes
min_stake Smallest steak size. Note: filled in when request includes_stakes
stakes List of stakes. Note: filled in when request includes_stakes
status Candidate status. Available values: offline = 1, online = 2
validator Is a validator at the current height
jailed_until
path Parameters
public_key
required
string

Public key of a candidate

query Parameters
height
integer <uint64>

Blockchain state height for the current request. Optional, the last default state of the node is used

not_show_stakes
boolean
Default: "false"

Do not display a list of steaks. Note: used_slots, uniq_users, min_stake will be filled

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "reward_address": "string",
  • "owner_address": "string",
  • "control_address": "string",
  • "total_stake": "string",
  • "public_key": "string",
  • "commission": "string",
  • "used_slots": "string",
  • "uniq_users": "string",
  • "min_stake": "string",
  • "stakes": [
    ],
  • "status": "string",
  • "validator": true,
  • "jailed_until": "string"
}

Candidates

Candidates returns list of candidates.

query Parameters
height
integer <uint64>

Blockchain state height for the current request. Optional, the last default state of the node is used

include_stakes
boolean
Default: "false"

Calculate field values used_slots, uniq_users, min_stake

not_show_stakes
boolean
Default: "false"

Do not display the list of stakes, the include_stakes flag is also required to display. Note: used_slots, uniq_users, min_stake will still be filled if include_stakes flag is used

status
string
Default: "all"
Enum: "all" "off" "on" "validator" "deleted"

Responses

Response samples

Content type
application/json
{
  • "candidates": [
    ],
  • "deleted": [
    ]
}

MissedBlocks

MissedBlocks returns missed blocks by validator public key.

path Parameters
public_key
required
string
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "missed_blocks": "string",
  • "missed_blocks_count": "string"
}

Validators

Validators returns list of active validators.

query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "validators": [
    ]
}

Coin

CoinInfo

CoinInfo returns information about coin symbol.

path Parameters
symbol
required
string
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "id": "0",
  • "name": "",
  • "symbol": "BIP",
  • "volume": "0",
  • "crr": "0",
  • "reserve_balance": "0",
  • "max_supply": "10000000000000000000000000000",
  • "owner_address": null
}

CoinInfoById

CoinInfoById returns information about coin ID.

path Parameters
id
required
string <uint64>
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "id": "0",
  • "name": "",
  • "symbol": "BIP",
  • "volume": "0",
  • "crr": "0",
  • "reserve_balance": "0",
  • "max_supply": "10000000000000000000000000000",
  • "owner_address": null
}

LimitOrder

LimitOrder returns order by ID.

path Parameters
order_id
required
string <uint64>
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "coin_sell": {
    },
  • "coin_buy": {
    },
  • "want_sell": "string",
  • "want_buy": "string",
  • "price": "string",
  • "owner": "string",
  • "height": "string"
}

LimitOrders

LimitOrders returns orders by IDs.

query Parameters
ids
Array of strings <uint64>
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

LimitOrdersOfPool

LimitOrdersOfPool returns sell orders for a pair of coins.

path Parameters
sell_coin
required
string <uint64>
buy_coin
required
string <uint64>
query Parameters
limit
integer <int32>
Default: "3"
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "pool_price": "string",
  • "orders": [
    ]
}

SwapPool

SwapPool returns total supply and reserves.

path Parameters
coin0
required
string <uint64>
coin1
required
string <uint64>
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "price": "string",
  • "amount0": "string",
  • "amount1": "string",
  • "liquidity": "string"
}

SwapPoolProvider

SwapPoolProvider returns reserves and liquidity balance of provider.

path Parameters
coin0
required
string <uint64>
coin1
required
string <uint64>
provider
required
string
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "price": "string",
  • "amount0": "string",
  • "amount1": "string",
  • "liquidity": "string"
}

SwapPools

SwapPools returns list of all pools.

query Parameters
height
integer <uint64>
orders
boolean
Default: "false"

Responses

Response samples

Content type
application/json
{
  • "pools": [
    ]
}

Vote

CommissionVotes

CommissionVotes returns votes for update commissions.

path Parameters
target_version
required
string <uint64>
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "votes": [
    ]
}

Halts

Halts returns the candidate votes for stopping the network at block.

path Parameters
height
required
string <uint64>

Responses

Response samples

Content type
application/json
{
  • "public_keys": [
    ]
}

UpdateVotes

UpdateVotes returns votes for update network.

path Parameters
target_version
required
string <uint64>
query Parameters
height
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "votes": [
    ]
}

Event

Events

Events returns events at given height.

path Parameters
height
required
string <uint64>
query Parameters
search
Array of strings

Array of public keys of validators and wallet addresses of delegators for filtering

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

WebSockets

Subscribe

Subscribe returns a subscription for events by query. Only supported in WS and gRPC methods.

query Parameters
query
required
string

tm.event = 'NewBlock' or tm.event = 'Tx'

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": null
}

Test

TestBlock

TestBlock returns the list of example transactions in block. Available only testnet mode.

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "height": "string",
  • "time": "string",
  • "transaction_count": "string",
  • "transactions": [
    ],
  • "block_reward": "string",
  • "locked_stake_rewards": "string",
  • "size": "string",
  • "proposer": "string",
  • "validators": [
    ],
  • "evidence": {
    },
  • "missed": [
    ],
  • "events": [
    ]
}