/dex-api-java

CoinEx DEX API for Java

Primary LanguageJavaBSD 2-Clause "Simplified" LicenseBSD-2-Clause

dex-api-java

CET-Lite for CoinEx Chain

  • API version: 3.0
    • Build date: 2020-04-27T01:19:45.029Z

A REST interface for state queries, transaction generation and broadcasting.

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.coinex</groupId>
  <artifactId>dex-api-java</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.coinex:dex-api-java:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/dex-api-java-1.0.0.jar
  • target/lib/*.jar

Modification Manually

After using swagger-codegen:

  • org.coinex.dex.client.model.BaseReq: Add some fields
  • org.coinex.dex.client.model.Msg: Modify value
  • org.coinex.dex.client.model.MsgValue: Wrap from address and to address for Msg class
  • org.coinex.dex.client.JSON: Add function serializeWithNull
  • org.coinex.dex.client.context.*: Wrap ApiClient and Use "polarbear" (The wallet of coinex chain) dynamic library

Note That

  • org.coinex.dex.client.api.MarketApi: There are some bugs in MarketApi!

Getting Started

Please follow the installation instruction and execute the following Java code:

import org.coinex.dex.client.ApiException;import org.coinex.dex.client.model.InlineResponse20048;
import org.coinex.dex.client.api.AliasApi;

public class AliasApiExample {

    public static void main(String[] args) {
        
        AliasApi apiInstance = new AliasApi();
        String alias = "alias_example"; // String | The alias to be queried
        try {
            InlineResponse20048 result = apiInstance.getAddressFromAlias(alias);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AliasApi#getAddressFromAlias");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://dex-api.coinex.org

Class Method HTTP request Description
AliasApi getAddressFromAlias GET /alias/address-of-alias/{alias} Given an alias, query the corresponding address
AliasApi getAliasParams GET /alias/parameters Get the current alias parameters
AliasApi getAliasesFromAddress GET /alias/aliases-of-address/{address} Given an account's address, query all the corresponding aliases
AliasApi updateAlias POST /alias/update Add or remove alias for an address
AssetApi addWhitelist POST /asset/tokens/{symbol}/forbidden/whitelist Add forbid whitelist
AssetApi burnToken POST /asset/tokens/{symbol}/burns Burn token
AssetApi forbidAddr POST /asset/tokens/{symbol}/forbidden/addresses Forbid address
AssetApi forbidToken POST /asset/tokens/{symbol}/forbids Forbid token
AssetApi getAssetParams GET /asset/parameters Get the current asset parameters
AssetApi getForbiddenAddresses GET /asset/tokens/{symbol}/forbidden/addresses query forbidden addresses
AssetApi getReservedSymbols GET /asset/tokens/reserved/symbols List reserved symbols
AssetApi getToken GET /asset/tokens/{symbol} queryToken
AssetApi getTokenList GET /asset/tokens List tokens
AssetApi getWhitelist GET /asset/tokens/{symbol}/forbidden/whitelist queryWhitelist
AssetApi issueToken POST /asset/tokens Issue token
AssetApi mintToken POST /asset/tokens/{symbol}/mints Mint token
AssetApi modifyTokenInfo POST /asset/tokens/{symbol}/infos Modify token info
AssetApi removeWhitelist POST /asset/tokens/{symbol}/unforbidden/whitelist Remove forbid whitelist
AssetApi transferOwnership POST /asset/tokens/{symbol}/ownerships Transfer ownership
AssetApi unForbidAddr POST /asset/tokens/{symbol}/unforbidden/addresses UnForbid address
AssetApi unFrobidToken POST /asset/tokens/{symbol}/unforbids UnForbid token
AuthApi getAccount GET /auth/accounts/{address} Get the account information on blockchain
AuthApi getAuthParams GET /auth/parameters Get the current auth parameters
AuthApi setReferee POST /auth/accounts/{address}/referee Set referee for account
BancorliteApi bancorCancel POST /bancorlite/bancor-cancel cancel bancor
BancorliteApi bancorInit POST /bancorlite/bancor-init create bancor
BancorliteApi bancorTrade POST /bancorlite/bancor-trade trade with bancor
BancorliteApi getBancorInfo GET /bancorlite/pools/{symbol} get the bancor pool info
BancorliteApi getBancorInfos GET /bancorlite/infos get all bancor infos
BancorliteApi getBancorliteParams GET /bancorlite/parameters Get the current bancorlite parameters
BankApi getAddressBalances GET /bank/balances/{address} Get the account balances
BankApi getBankParams GET /bank/parameters Get the current bankx parameters
BankApi sendCoins POST /bank/accounts/{address}/transfers Send coins from one account to another
BankApi setMemoRequired POST /bank/accounts/memo Mark if memo is required to receive coins
BankApi transferSupervisedCoins POST /bank/accounts/{address}/supervised_transfers Operate a supervised transfer
CommentApi followupComment POST /comment/followup-comment Post a follow-up comment under some thread
CommentApi newThread POST /comment/new-thread Post a new comment to open a new thread
CommentApi rewardComments POST /comment/reward-comments reward some comments with coins
DistributionApi donateToCommunityPool POST /distribution/{accAddress}/donates Donate to the community pool
DistributionApi getAllRewards GET /distribution/delegators/{delegatorAddr}/rewards Get the total rewards balance from all delegations
DistributionApi getCommunityPool GET /distribution/community_pool Community pool parameters
DistributionApi getDistributionInfo GET /distribution/validators/{validatorAddr} Validator distribution information
DistributionApi getDistributionParams GET /distribution/parameters Fee distribution parameters
DistributionApi getOutstandingRewards GET /distribution/validators/{validatorAddr}/outstanding_rewards Fee distribution outstanding rewards of a single validator
DistributionApi getRewardByValidator GET /distribution/delegators/{delegatorAddr}/rewards/{validatorAddr} Query a delegation reward
DistributionApi getValidatorRewards GET /distribution/validators/{validatorAddr}/rewards Commission and self-delegation rewards of a single validator
DistributionApi getWithdrawAddress GET /distribution/delegators/{delegatorAddr}/withdraw_address Get the rewards withdrawal address
DistributionApi setWithdrawAddress POST /distribution/delegators/{delegatorAddr}/withdraw_address Replace the rewards withdrawal address
DistributionApi withdrawAllRewards POST /distribution/delegators/{delegatorAddr}/rewards Withdraw all the delegator's delegation rewards
DistributionApi withdrawAllValidatorRewards POST /distribution/validators/{validatorAddr}/rewards Withdraw the validator's rewards
DistributionApi withdrawRewardsByValidator POST /distribution/delegators/{delegatorAddr}/rewards/{validatorAddr} Withdraw a delegation reward
GovernanceApi depositToProposal POST /gov/proposals/{proposalId}/deposits Deposit tokens to a proposal
GovernanceApi getDepositByAddr GET /gov/proposals/{proposalId}/deposits/{depositor} Query deposit
GovernanceApi getDepositParameters GET /gov/parameters/deposit Query governance deposit parameters
GovernanceApi getDeposits GET /gov/proposals/{proposalId}/deposits Query deposits
GovernanceApi getProposalByID GET /gov/proposals/{proposalId} Query a proposal
GovernanceApi getProposals GET /gov/proposals Query proposals
GovernanceApi getProposer GET /gov/proposals/{proposalId}/proposer Query proposer
GovernanceApi getTally GET /gov/proposals/{proposalId}/tally Get a proposal's tally result at the current time
GovernanceApi getTallyingParameters GET /gov/parameters/tallying Query governance tally parameters
GovernanceApi getVoterByAddr GET /gov/proposals/{proposalId}/votes/{voter} Query vote
GovernanceApi getVoters GET /gov/proposals/{proposalId}/votes Query voters
GovernanceApi getVotingParameters GET /gov/parameters/voting Query governance voting parameters
GovernanceApi submitCommunityPoolSpendProposal POST /gov/proposals/community_pool_spend Generate a community pool spend proposal transaction
GovernanceApi submitParameterChangeProposal POST /gov/proposals/param_change Generate a parameter change proposal transaction
GovernanceApi submitProposal POST /gov/proposals Submit a proposal
GovernanceApi voteProposal POST /gov/proposals/{proposalId}/votes Vote a proposal
IncentiveApi getIncentiveParams GET /incentive/parameters Get the current incentive parameters
MarketApi cancelOrder POST /market/cancel-order Cancel the order
MarketApi cancelTradingPair POST /market/cancel-trading-pair Cancel the trading-pair
MarketApi createGteOrder POST /market/gte-orders Create GTE order in blockchain
MarketApi createIocOrder POST /market/ioc-orders Create IOC order in blockchain
MarketApi createTradingPair POST /market/trading-pairs Create trading-pair in blockchain
MarketApi getMarketParams GET /market/parameters Get the current market parameters
MarketApi getOrder GET /market/orders/{order-id} Query order info
MarketApi getOrders GET /market/orders/account/{address} Query user order-id list
MarketApi getOrdersInMarket GET /market/orderbook/{stock}/{money} Query trading-pair's orderbook
MarketApi getTradingPair GET /market/trading-pairs/{stock}/{money} Query trading-pair info
MarketApi modifyPricePrecision POST /market/price-precision Modify the price precision of the trading pair in the dex
MarketApi queryTradingPairs GET /market/exist-trading-pairs Query all trading-pair infos in blockchain
SlashingApi getSigningInfo GET /slashing/validators/{validatorPubKey}/signing_info Get sign info of given validator
SlashingApi getSigningInfos GET /slashing/signing_infos Get sign info of given all validators
SlashingApi getSlashingParams GET /slashing/parameters Get the current slashing parameters
SlashingApi unjailValidator POST /slashing/validators/{validatorAddr}/unjail Unjail a jailed validator
StakingApi getDelegations GET /staking/delegators/{delegatorAddr}/delegations Get all delegations from a delegator
StakingApi getDelegationsOfValidator GET /staking/validators/{validatorAddr}/delegations Get all delegations from a validator
StakingApi getDelegationsToValidator GET /staking/delegators/{delegatorAddr}/delegations/{validatorAddr} Query the current delegation between a delegator and a validator
StakingApi getDelegatorTxs GET /staking/delegators/{delegatorAddr}/txs Get all staking txs (i.e msgs) from a delegator
StakingApi getRedelegations GET /staking/redelegations Get all redelegations (filter by query params)
StakingApi getStakingParameters GET /staking/parameters Get the current staking parameter values
StakingApi getStakingPool GET /staking/pool Get the current state of the staking pool
StakingApi getUndelegationsBetween GET /staking/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr} Query all unbonding delegations between a delegator and a validator
StakingApi getUndelegationsOfDelegator GET /staking/delegators/{delegatorAddr}/unbonding_delegations Get all unbonding delegations from a delegator
StakingApi getUndelegationsOfValidator GET /staking/validators/{validatorAddr}/unbonding_delegations Get all unbonding delegations from a validator
StakingApi getValidator GET /staking/validators/{validatorAddr} Query the information from a single validator
StakingApi getValidatorOfDelegator GET /staking/delegators/{delegatorAddr}/validators/{validatorAddr} Query a validator that a delegator is bonded to
StakingApi getValidators GET /staking/validators Get all validator candidates. By default it returns only the bonded validators.
StakingApi getValidatorsOfDelegator GET /staking/delegators/{delegatorAddr}/validators Query all validators that a delegator is bonded to
StakingApi submitDelegation POST /staking/delegators/{delegatorAddr}/delegations Submit delegation
StakingApi submitRedelegation POST /staking/delegators/{delegatorAddr}/redelegations Submit a redelegation
StakingApi undelegate POST /staking/delegators/{delegatorAddr}/unbonding_delegations Submit an unbonding delegation
TendermintApi getBlock GET /blocks/{height} Get a block at a certain height
TendermintApi getLatestBlock GET /blocks/latest Get the latest block
TendermintApi getLatestValidatorSet GET /validatorsets/latest Get the latest validator set
TendermintApi getNodeInfo GET /node_info The properties of the connected node
TendermintApi getSyncing GET /syncing Syncing state of node
TendermintApi getValidatorSet GET /validatorsets/{height} Get a validator set a certain height
TransactionsApi broadcastTx POST /txs Broadcast a signed tx
TransactionsApi encodeTx POST /txs/encode Encode a transaction to the Amino wire format
TransactionsApi getTxByHash GET /txs/{hash} Get a Tx by hash
TransactionsApi searchTx GET /txs Search transactions

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

kms

  • Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author