AccountAPI (kucoin-java-sdk 1.0.9 API)

所有已知实现类:

AccountAPIAdapter
```
public interface AccountAPI
```
Created by chenshiwei on 2019/1/9.

方法概要

所有方法实例方法抽象方法已过时的方法
限定符和类型	方法和说明
`Map<String,String>`	`createAccount(String currency, String type)` 已过时。
`SubApiKeyResponse`	`createSubApiKey(String subName, String passphrase, String remark, String permission, String ipWhitelist, String expire)` This endpoint can be used to create Spot APIs for sub-accounts.
`SubUserCreateResponse`	`createSubUser(String subName, String password, String access, String remarks)` This endpoint can be used to create sub-accounts.
`SubApiKeyResponse`	`deleteSubApiKey(String subName, String apiKey, String passphrase)` This endpoint can be used to delete sub-account Spot APIs.
`AccountBalanceResponse`	`getAccount(String accountId)` Information for a single account.
`Pagination<AccountDetailResponse>`	`getAccountLedgers(String currency, String direction, String bizType, long startAt, long endAt, int currentPage, int pageSize)` List account activity.
`List<AccountDetailResponse>`	`getHFAccountLedgers(String currency, String direction, String bizType, Long lastId, Integer limit, Long startAt, Long endAt)` This API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries.
`SubAccountBalanceResponse`	`getSubAccount(String subUserId)` Get info for a single sub-account.
`Pagination<SubAccountBalanceResponse>`	`getSubAccountPageList(int currentPage, int pageSize)` This endpoint can be used to get paginated sub-account information.
`List<SubApiKeyResponse>`	`getSubApiKey(String subName, String apiKey)` This endpoint can be used to obtain a list of Spot APIs pertaining to a sub-account.
`UserSummaryInfoResponse`	`getUserSummaryInfo()` This endpoint can be used to obtain account summary information.
`Map<String,String>`	`innerTransfer2(AccountTransferV2Request request)` The inner transfer interface is used for assets transfer among the accounts of a user and is free of charges on the platform.
`List<AccountBalancesResponse>`	`listAccounts(String currency, String type)` Get a list of accounts.
`List<SubAccountBalanceResponse>`	`listSubAccounts()` Get a list of sub-accounts.
`TransferableBalanceResponse`	`transferable(String currency, String type, String tag)` This endpoint returns the transferable balance of a specified account.
`Map<String,String>`	`transferBetweenSubAndMasterV2(String clientOid, String currency, BigDecimal amount, String direction, String subUserId, String subAccountType, String accountType)` Transfer the assets between the master user and the sub-user and only supports main account.
`List<AccountBalancesResponse>`	`transferToHFAccount(String clientOid, String currency, String from, BigDecimal amount)` transfer to the high-frequency account
`SubApiKeyResponse`	`updateSubApiKey(String subName, String apiKey, String passphrase, String permission, String ipWhitelist, String expire)` This endpoint can be used to modify sub-account Spot APIs.

- 方法详细资料
  - listAccounts
```
List<AccountBalancesResponse> listAccounts(String currency,
                                           String type)
                                    throws IOException
```
    Get a list of accounts.
    Your accounts are separate from your KuCoin accounts. See the Deposits section for documentation on how to deposit funds to begin trading.
    
    参数:
    
    currency - The code of the currency
    
    type - Account type:，"main" or "trade" or "trade_hf"
    
    返回:
    
    The accounts.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - getAccount
```
AccountBalanceResponse getAccount(String accountId)
                           throws IOException
```
    Information for a single account. Use this endpoint when you know the accountId.
    
    参数:
    
    accountId - id of the account
    
    返回:
    
    The account balance.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - createAccount
```
@Deprecated
Map<String,String> createAccount(String currency,
                                             String type)
                                      throws IOException
```
    已过时。
    
    Create an account.
    
    参数:
    
    currency - the code of the currency
    
    type - Account type ，"main" or "trade"
    
    返回:
    
    The account id.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - getAccountLedgers
```
Pagination<AccountDetailResponse> getAccountLedgers(String currency,
                                                    String direction,
                                                    String bizType,
                                                    long startAt,
                                                    long endAt,
                                                    int currentPage,
                                                    int pageSize)
                                             throws IOException
```
    List account activity. Account activity either increases or decreases your account balance. Items are paginated and sorted latest first. See the Pagination section for retrieving additional entries after the first page.
    
    参数:
    
    currency - Id of the account
    
    direction - [Optional] Side: in - Receive, out - Send
    
    bizType - [Optional] Business type: DEPOSIT, WITHDRAW, TRANSFER, SUB_TRANSFER,TRADE_EXCHANGE, MARGIN_EXCHANGE, KUCOIN_BONUS.
    
    startAt - Start time. unix timestamp calculated in seconds, the creation time queried shall posterior to the start time
    
    endAt - End time. unix timestamp calculated in seconds, the creation time queried shall prior to the end time.
    
    currentPage - The page to fetch
    
    pageSize - The page size.
    
    返回:
    
    The account activity.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - innerTransfer2
```
Map<String,String> innerTransfer2(AccountTransferV2Request request)
                           throws IOException
```
    The inner transfer interface is used for assets transfer among the accounts of a user and is free of charges on the platform. For example, a user could transfer assets for free form the main account to the trading account on the platform.
    
    参数:
    
    request -
    
    返回:
    
    抛出:
    
    IOException
  - listSubAccounts
```
List<SubAccountBalanceResponse> listSubAccounts()
                                         throws IOException
```
    Get a list of sub-accounts.
    You need to create the account by using the API-KEY of sub user firstly if the account of sub user is not exist. Attention only trade account can be used for trading
    
    返回:
    
    The sub-accounts.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - getSubAccount
```
SubAccountBalanceResponse getSubAccount(String subUserId)
                                 throws IOException
```
    Get info for a single sub-account. Use this endpoint when you know the subUserId.
    
    参数:
    
    subUserId - id of the sub user
    
    返回:
    
    The sub-account.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - transferBetweenSubAndMasterV2
```
Map<String,String> transferBetweenSubAndMasterV2(String clientOid,
                                                 String currency,
                                                 BigDecimal amount,
                                                 String direction,
                                                 String subUserId,
                                                 String subAccountType,
                                                 String accountType)
                                          throws IOException
```
    Transfer the assets between the master user and the sub-user and only supports main account.
    
    参数:
    
    clientOid - Request id
    
    currency - currency code
    
    amount - Transfer amount, a multiple and positive number of the amount precision.
    
    direction - OUT — the master user to sub user;IN — the sub user to the master user.
    
    subUserId - id of the sub user
    
    subAccountType - The account type of the sub user: MAIN or TRADE
    
    accountType - The account type of the user: MAIN or TRADE
    
    返回:
    
    The order id.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - transferable
```
TransferableBalanceResponse transferable(String currency,
                                         String type,
                                         String tag)
                                  throws IOException
```
    This endpoint returns the transferable balance of a specified account.
    
    参数:
    
    currency -
    
    type - The account type: MAIN, TRADE, TRADE_HF, MARGIN or POOL
    
    tag - [Optional] Trading pair, required when the account type is ISOLATED; other types are not passed, e.g.: BTC-USDT
    
    返回:
    
    抛出:
    
    IOException
  - getUserSummaryInfo
```
UserSummaryInfoResponse getUserSummaryInfo()
                                    throws IOException
```
    This endpoint can be used to obtain account summary information.
    
    返回:
    
    account summary information
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - createSubUser
```
SubUserCreateResponse createSubUser(String subName,
                                    String password,
                                    String access,
                                    String remarks)
                             throws IOException
```
    This endpoint can be used to create sub-accounts.
    
    参数:
    
    subName - Sub-account name(must contain 7-32 characters, at least one number and one letter. Cannot contain any spaces)
    
    password - Password(7-24 characters, must contain letters and numbers, cannot only contain numbers or include special characters)
    
    access - Permission (types include Spot, Futures, Margin permissions, which can be used alone or in combination)
    
    remarks - [Optional] Remarks(1~24 characters)
    
    返回:
    
    sub-user create info
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - getSubApiKey
```
List<SubApiKeyResponse> getSubApiKey(String subName,
                                     String apiKey)
                              throws IOException
```
    This endpoint can be used to obtain a list of Spot APIs pertaining to a sub-account.
    
    参数:
    
    subName - Sub-account name
    
    apiKey - [Optional] API-Key.
    
    返回:
    
    a list of Spot APIs pertaining to a sub-account
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - createSubApiKey
```
SubApiKeyResponse createSubApiKey(String subName,
                                  String passphrase,
                                  String remark,
                                  String permission,
                                  String ipWhitelist,
                                  String expire)
                           throws IOException
```
    This endpoint can be used to create Spot APIs for sub-accounts.
    
    参数:
    
    subName - Sub-account name, create sub account name of API Key
    
    passphrase - Password(Must contain 7-32 characters. Cannot contain any spaces.)
    
    remark - Remarks(1~24 characters)
    
    permission - [Optional] Permissions(Only "General" and "Trade" permissions can be set, such as "General, Trade". The default is "General")
    
    ipWhitelist - [Optional] IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP)
    
    expire - [Optional] API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360
    
    返回:
    
    sub-api-key info
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - updateSubApiKey
```
SubApiKeyResponse updateSubApiKey(String subName,
                                  String apiKey,
                                  String passphrase,
                                  String permission,
                                  String ipWhitelist,
                                  String expire)
                           throws IOException
```
    This endpoint can be used to modify sub-account Spot APIs.
    
    参数:
    
    subName - Sub-account name, create sub account name of API Key
    
    passphrase - Password(Must contain 7-32 characters. Cannot contain any spaces.)
    
    apiKey - API-Key(Sub-account APIKey)
    
    permission - [Optional] Permissions(Only "General" and "Trade" permissions can be set, such as "General, Trade". The default is "General")
    
    ipWhitelist - [Optional] IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP)
    
    expire - [Optional] API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360
    
    返回:
    
    sub-api-key info
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - deleteSubApiKey
```
SubApiKeyResponse deleteSubApiKey(String subName,
                                  String apiKey,
                                  String passphrase)
                           throws IOException
```
    This endpoint can be used to delete sub-account Spot APIs.
    
    参数:
    
    subName - Sub-account name, create sub account name of API Key
    
    passphrase - Password(Must contain 7-32 characters. Cannot contain any spaces.)
    
    apiKey - API-Key(Sub-account APIKey)
    
    返回:
    
    sub-api-key info
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - getSubAccountPageList
```
Pagination<SubAccountBalanceResponse> getSubAccountPageList(int currentPage,
                                                            int pageSize)
                                                     throws IOException
```
    This endpoint can be used to get paginated sub-account information. Pagination is required.
    
    参数:
    
    currentPage - Sub-account name, create sub account name of API Key
    
    pageSize - Password(Must contain 7-32 characters. Cannot contain any spaces)
    
    返回:
    
    The sub-accounts
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.
  - transferToHFAccount
```
List<AccountBalancesResponse> transferToHFAccount(String clientOid,
                                                  String currency,
                                                  String from,
                                                  BigDecimal amount)
                                           throws IOException
```
    transfer to the high-frequency account
    
    参数:
    
    clientOid - Client Order Id，a unique identifier created by the user, using UUID is recommended
    
    currency - currency
    
    from - Payment account type: main(main account), trade(trading account), trade_hf(high-frequency trading account)
    
    amount - Transfer amount, the precision is the precision of the currency multiplied by a positive integer
    
    返回:
    
    抛出:
    
    IOException
  - getHFAccountLedgers
```
List<AccountDetailResponse> getHFAccountLedgers(String currency,
                                                String direction,
                                                String bizType,
                                                Long lastId,
                                                Integer limit,
                                                Long startAt,
                                                Long endAt)
                                         throws IOException
```
    This API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.
    
    参数:
    
    currency - [Optional] Id of the account
    
    direction - [Optional] Side: in - Receive, out - Send
    
    bizType - [Optional] Business type: DEPOSIT, WITHDRAW, TRANSFER, SUB_TRANSFER,TRADE_EXCHANGE, MARGIN_EXCHANGE, KUCOIN_BONUS.
    
    startAt - [Optional] Start time. unix timestamp calculated in seconds, the creation time queried shall posterior to the start time
    
    endAt - [Optional] End time. unix timestamp calculated in seconds, the creation time queried shall prior to the end time.
    
    lastId - [Optional] The id of the last set of data from the previous batch of data. By default, the latest information is given.
    
    limit - [Optional] Default100，Max200
    
    返回:
    
    The hf account activity.
    
    抛出:
    
    IOException - on socket errors.
    
    KucoinApiException - when errors are returned from the exchange.

接口 AccountAPI

方法概要

方法详细资料

listAccounts

getAccount

createAccount

getAccountLedgers

innerTransfer2

listSubAccounts

getSubAccount

transferBetweenSubAndMasterV2

transferable

getUserSummaryInfo

createSubUser

getSubApiKey

createSubApiKey

updateSubApiKey

deleteSubApiKey

getSubAccountPageList

transferToHFAccount

getHFAccountLedgers