Public Node API
Get Account Balances
Retrieves the balance for a specific wallet address across all currency denominations within the account. See the definition.
Method Declaration
async def get_account_balances(
self,
address: str,
) -> bank_query.QueryAllBalancesResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
address | query | Address | true | The wallet address that owns the account. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | Coin ⛁ | The response containing all account balances. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API | Guide - Get Account Balances
Get Account Balance
Retrieves the balance of a specified account address for a particular denomination/token. See the definition.
Method Declaration
async def get_account_balance(
self,
address: str,
denom: str,
) -> bank_query.QueryBalanceResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
address | query | Address | true | The wallet address that owns the account. |
denom | query | Denom | true | Denomination of the token associated with the request. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | Coin | The account balance. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | Rust | API | Guide - Get Account Balance
Get Account
Retrieves an account using its unique wallet address, returning detailed account information encapsulated in the BaseAccount structure. See the definition.
Method Declaration
async def get_account(self, address: str) -> BaseAccountParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
address | query | Address | true | The wallet address that owns the account. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | BaseAccount | The account information. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API | Guide - Get Account
Get Latest Block
Retrieves the most recent block from the blockchain network. This is useful for obtaining the latest state or data committed on the chain, ensuring the application operates with up-to-date information.
Method Declaration
async def latest_block(self) -> tendermint_query.GetLatestBlockResponseParameters
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | Block | The latest block. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | Rust | API| Guide - Get Latest Block
Get Latest Block Height
Retrieves the most recent block height from a blockchain network.
Internally it uses the Get Latest Block API call.
Method Declaration
async def latest_block_height(self) -> intParameters
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | Height | The latest block height. |
400 | Bad Request | The request was malformed or invalid. |
Get User Stats
Retrieves statistical data for a user's Maker and Taker positions associated with a specified wallet address.
Method Declaration
async def get_user_stats(
self,
address: str,
) -> stats_query.QueryUserStatsResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
user | query | Address | true | The wallet address that owns the account. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | UserStats | The response containing the user stats. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get All Validators
Fetches a list of all validators, optionally filtering them by a specified status. See the definition.
Method Declaration
async def get_all_validators(
self,
status: str = "",
) -> staking_query.QueryValidatorsResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
status | query | string | false | Status to filter out the matched result. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | Validator ⛁ | The response containing all validators. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get Subaccounts
Retrieves a comprehensive list of all subaccounts, returning structured information encapsulated in a response object.
Method Declaration
async def get_subaccounts(self) -> QuerySubaccountAllResponseParameters
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | SubaccountInfo ⛁ |
Examples: Python | TypeScript | Rust | API | Guide - Get Subaccounts
Get Subaccount
Fetches details of a specific subaccount based on its owner's address and the subaccount's unique number.
Method Declaration
async def get_subaccount(
self,
address: str,
account_number: int,
) -> Optional[subaccount_type.Subaccount]Unification Plan
- Rust uses
Subaccount- a wrapper that combinesAddresswithSubaccountNumber, it's safer to create the same type for Python and TypeScript
Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
owner | query | Address | true | The wallet address that owns the account. |
number | query | SubaccountNumber | true | The identifier for the specific subaccount withing the wallet address. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | SubaccountInfo | The response containing the subaccount. |
400 | Bad Request | The request was malformed or invalid. | |
404 | Not Found | The subaccount was not found. |
Examples: Python | TypeScript | Rust | API | Guide - Get Subaccount
Get Clob Pair
Fetches the order book pair identified by a given ID, allowing users to retrieve detailed information about a specific trading pair within a Central Limit Order Book (CLOB) system.
The response includes data structured within the ClobPair schema.
Method Declaration
async def get_clob_pair(self, pair_id: int) -> clob_pair_type.ClobPairParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
id | query | u32 | true | Clob pair ID |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | ClobPair | The clob pair information. |
400 | Bad Request | The request was malformed or invalid. | |
404 | Not Found | The clob pair was not found. |
Get Clob Pairs
Obtain a comprehensive list of all available order book trading pairs.
Method Declaration
async def get_clob_pairs(self) -> QueryClobPairAllResponseUnification Plan
- Python and TypeScript don't contain options
Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
pagination | query | PageRequest | false | Parameters of pagination. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | ClobPair ⛁ | The response containing all clob pairs. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get Price
Retrieve the current market price for a specified market, identified by its market ID.
Method Declaration
async def get_price(self, market_id: int) -> market_price_type.MarketPriceParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
market_id | query | u32 | true | ID of the market to fetch price of |
Response
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | MarketPrice | |
400 | Bad Request | The request was malformed or invalid. | |
404 | Not Found | The market was not found. |
Get Prices
Query all market prices from the system, providing an overview of current market values.
Method Declaration
async def get_prices(self) -> QueryAllMarketPricesResponseUnification Plan
- Python and TypeScript don't contain options
Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
pagination | query | PageRequest | false | Parameters of pagination. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | MarketPrice ⛁ | The response containing all market prices. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get Perpetual
Queries a specific perpetual contract by its unique perpetual ID, returning details about the contract.
Method Declaration
async def get_perpetual(self, perpetual_id: int) -> QueryPerpetualResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
id | query | u32 | true | Perpetual ID |
Response
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | Perpetual | |
400 | Bad Request | The request was malformed or invalid. | |
404 | Not Found | The perpetual was not found. |
Get Perpetuals
Retrieve a list of all perpetuals currently available in the system.
Method Declaration
async def get_perpetuals(self) -> QueryAllPerpetualsResponseUnification Plan
- Python and TypeScript don't contain options
- Options in protocol are not optional
Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
pagination | query | PageRequest | false | Parameters of pagination. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | Perpetual ⛁ | The response containing all perpetuals. |
400 | Bad Request | The request was malformed or invalid. |
Get Equity Tier Limit Config
Fetch the configuration details that outline the limits set for different tiers of equity.
Method Declaration
async def get_equity_tier_limit_config(
self,
) -> equity_tier_limit_config_type.EquityTierLimitConfiguration:Parameters
Response
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | EquityTierLimitConfiguration | |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get Delegator Delegations
Retrieves all delegations associated with a specific delegator address. See the definition.
Method Declaration
async def get_delegator_delegations(
self, delegator_addr: str
) -> staking_query.QueryDelegatorDelegationsResponseUnification Plan
- Python and TypeScript don't contain options
- Options in protocol are not optional
- Two types of options (v4 and cosmos, are the same, please use cosmos)
Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
delegator_addr | query | Address | true | The wallet address that owns the account. |
pagination | query | PageRequest | false | Parameters of pagination. |
Response
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | DelegationResponse ⛁ | |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get Delegator Unbonding Delegations
Query all unbonding delegations associated with a specific delegator address. See the definition.
Method Declaration
async def get_delegator_unbonding_delegations(
self, delegator_addr: str
) -> staking_query.QueryDelegatorUnbondingDelegationsResponseUnification Plan
- Python and TypeScript don't contain options
- Options in protocol are not optional
- Two types of options (v4 and cosmos, are the same, please use cosmos)
Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
delegator_addr | query | Address | true | The wallet address that owns the account. |
pagination | query | PageRequest | false | Parameters of pagination. |
Response
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | UnbondingDelegation ⛁ | |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get Delayed Complete Bridge Messages
Retrieve delayed bridge messages associated with a specified wallet address, focusing on messages that have not yet reached completion.
It requires the address of the wallet to access its related subaccount messages and returns a structured response detailing the delayed messages.
Method Declaration
async def get_delayed_complete_bridge_messages(
self,
address: str = "",
) -> bridge_query.QueryDelayedCompleteBridgeMessagesResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
address | query | Address | true | The wallet address that owns the account. |
Response
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | DelayedCompleteBridgeMessage ⛁ | |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get Fee Tiers
Retrieves current fee tiers associated with perpetual trading, helping to understand the fees applied based on trading volume or other criteria.
Method Declaration
async def get_fee_tiers(self) -> fee_tier_query.QueryPerpetualFeeParamsResponseResponse
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | PerpetualFeeTier ⛁ | |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API
Get User Fee Tier
Retrieves the perpetual fee tier associated with a specific wallet address, providing information on the user's current fee structure.
Method Declaration
async def get_user_fee_tier(
self, address: str
) -> fee_tier_query.QueryUserFeeTierResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
user | query | Address | true | The wallet address that owns the account. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | PerpetualFeeTier | The response containing the user fee tier. |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python | TypeScript | Rust | API| Guide - Get User Fee Tier
Get Rewards Params
Retrieves the parameters for the rewards system, providing insight into the set configurations for earning and distributing rewards.
Method Declaration
async def get_rewards_params(self) -> rewards_query.QueryParamsResponseUnification Plan
- Rename
ParamstoRewardsParamsin Rust
Parameters
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | RewardsParams |
Examples: Python | TypeScript | Rust | API | Guide - Get Rewards Params
Get Affiliate Info
Get affiliate info by address.
Method Declaration
async def get_affiliate_info(
self, address: str
) -> affiliate_query.AffiliateInfoResponseParameters
| Parameter | Location | Type | Mandatory | Description |
|---|---|---|---|---|
address | Query | Address | true | Address to get affiliate info |
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | AffiliateModule.AffiliateInfoResponse |
Examples: API
Get Affiliate White List
Get affiliate white list.
Method Declaration
async def get_affiliate_whitelist(
self,
) -> affiliate_query.AffiliateWhitelistResponseParameters
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | AffiliateModule.AffiliateWhitelistResponse |
Examples: API
Get All Affiliate Tiers
Get all affiliate tiers.
Method Declaration
async def get_all_affiliate_tiers(
self,
) -> affiliate_query.AllAffiliateTiersResponseParameters
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | AffiliateModule.AllAffiliateTiersResponse |
Examples: API
Get All Gov Proposals
Get all gov proposals.
Method Declaration
async def get_all_gov_proposals(
self,
proposal_status: Optional[str] = None,
voter: Optional[str] = None,
depositor: Optional[str] = None,
key: Optional[bytes] = None,
offset: Optional[int] = None,
limit: Optional[int] = None,
count_total: Optional[bool] = False,
reverse: Optional[bool] = False,
) -> gov_query.QueryProposalsResponseParameters
| Parameter | Location | Type | Mandatory | Description |
|---|---|---|---|---|
| proposalStatus | Query | ProposalStatus | true | Status of the proposal to filter by. |
| voter | Query | string | false | Voter to filter by |
| depositor | Query | string | false | Depositor to filter by. |
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | GovV1Module.QueryProposalsResponse |
Examples: API
GetDelegationTotalRewards
Get all unbonding delegations from a delegator.
Method Declaration
async def get_delegation_total_rewards(
self, address: str
) -> distribution_query.QueryDelegationTotalRewardsResponseImplement Python and Rust method
Parameters
| Parameter | Location | Type | Mandatory | Description |
|---|---|---|---|---|
| delegatorAddress | Query | string | true | Address of the delegator |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | DistributionModule.QueryDelegationTotalRewardsResponse | All unbonding delegations from a delegator. |
400 | Bad Request | The request was malformed or invalid. |
Examples: API
Get Node Info
Query for node info.
Method Declaration
async def get_node_info(self) -> tendermint_query.GetNodeInfoResponseParameters
Response
| Status | Meaning | Schema | |
|---|---|---|---|
200 | OK | GetNodeInfoResponse | |
400 | Bad Request | The request was malformed or invalid. |
Get Referred By
Get referred by.
Method Declaration
async def get_referred_by(self, address: str) -> affiliate_query.ReferredByResponseParameters
| Parameter | Location | Type | Mandatory | Description |
|---|---|---|---|---|
address | Query | Address | true | Address to get referred by |
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | AffiliateModule.ReferredByResponse |
Examples: API
Get Withdrawal and Transfer Gating Status
Get withdrawal and transfer gating status.
Method Declaration
async def get_withdrawal_and_transfer_gating_status(
self, perpetual_id: int
) -> subaccount_query.QueryGetWithdrawalAndTransfersBlockedInfoResponseParameters
| Parameter | Location | Type | Mandatory | Description |
|---|---|---|---|---|
| perpetualId | Query | int | true | Perpetual id |
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse |
Examples: API
Get Withdrawal Capacity By Denom
Get withdrawal capacity by denom.
Method Declaration
async def get_withdrawal_capacity_by_denom(
self, denom: str
) -> rate_query.QueryCapacityByDenomResponseParameters
| Parameter | Location | Type | Mandatory | Description |
|---|---|---|---|---|
| denom | Query | string | true | Denomination value |
Response
| Status | Meaning | Schema |
|---|---|---|
200 | OK | RateLimitModule.QueryCapacityByDenomResponse |
Examples: API
Query Address
Fetch account’s number and sequence number from the network.
Method Declaration
async def query_address(self, address: str) -> (int, int)Parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
address | query | Address | The wallet address that owns the account. |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | Pair of (u64, u64) | The response containing the account. |
400 | Bad Request | The request was malformed or invalid. |
Get Order Router Revenue share
Retrieves order router revenue share
Method Declaration
async def get_order_router_revenue_share(self, address: str) -> QueryOrderRouterRevShareResponseParameters
| Parameter | Location | Type | Mandatory | Description |
|---|---|---|---|---|
| address | Query | string | true | Address of the revenue share recipient |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | QueryOrderRouterRevShareResponse | Order router revenue share |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python
Get Market Mapper Revenue Share Details
Retrieves market mapper revenue share details
Method Declaration
async def get_market_mapper_revenue_share_details(self, market_id: int) -> QueryMarketMapperRevShareDetailsResponseParameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
market_id | query | int | true | Market id |
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | QueryMarketMapperRevShareDetailsResponse | Market mapper revenue share details |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python
Get Market Mapper Revenue Share Parmas
Retrieves market mapper revenue share params
Method Declaration
async def get_market_mapper_revenue_share_param(self) -> QueryMarketMapperRevenueShareParamsResponseParameters
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | QueryMarketMapperRevenueShareParamsResponse | Market mapper revenue share params |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python
Get Unconditional Revenue Sharing Config
Retrieves unconditional revenue share config
Method Declaration
async def get_unconditional_revenue_sharing_config(self) -> QueryUnconditionalRevShareConfigResponseParameters
Response
| Status | Meaning | Schema | Description |
|---|---|---|---|
200 | OK | QueryUnconditionalRevShareConfigResponse | Unconditional revenue share config |
400 | Bad Request | The request was malformed or invalid. |
Examples: Python