# README
GoCryptoTrader package Kucoin
This kucoin package is part of the GoCryptoTrader codebase.
This is still in active development
You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Kucoin Exchange
Current Features
- REST Support
- Websocket Support
Subscriptions
Default Public Subscriptions:
- Ticker for spot, margin and futures
- Orderbook for spot, margin and futures
- All trades for spot and margin
Default Authenticated Subscriptions:
- All trades for futures
- Stop Order Lifecycle events for futures
- Account Balance events for spot, margin and futures
- Margin Position updates
- Margin Loan updates
Subscriptions are subject to enabled assets and pairs.
Margin subscriptions for ticker, orderbook and All trades are merged into Spot subscriptions because duplicates are not allowed, unless Spot subscription does not exist, i.e. Spot asset not enabled, or subscription configured only for Margin
Limitations:
- 100 symbols per subscription
- 300 symbols per connection
Due to these limitations, if more than 10 symbols are enabled, ticker will subscribe to ticker:all.
Unimplemented subscriptions:
- Candles for Futures
- Market snapshot for currency
Please click GoDocs chevron above to view current GoDoc information for this package
Contribution
Please feel free to submit any pull requests or suggest any desired features to be added.
When submitting a PR, please abide by our coding guidelines:
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- Code must be documented adhering to the official Go commentary guidelines.
- Code must adhere to our coding style.
- Pull requests need to be based on and opened against the
masterbranch.
Donations
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc
# Functions
FillParams fills request parameters for orders and order fills.
GetRateLimit returns a RateLimit instance, which implements the request.Limiter interface.
IntervalToString returns a string from kline.Interval input.
MarginModeToString returns a string representation of a MarginMode.
OrderTypeToString returns an order type instance from string.
# Constants
Trade type values for Spot, Isolated Margin, and Cross Margin accounts.
Trade type values for Spot, Isolated Margin, and Cross Margin accounts.
Trade type values for Spot, Isolated Margin, and Cross Margin accounts.
# Structs
AccountBalance represents an account balance detail.
AccountCurrencyInfo represents main account detailed information.
AccountInfo represents account information.
AccountLedgerResponse represents the account ledger response detailed information.
AccountSummaryInformation represents account summary information detail.
APIKeyDetail represents the API key detail.
AssetInfo holds asset information for an instrument.
AutoCancelHFOrderResponse represents an auto cancel HF order response.
BorrowAndRepaymentOrderResp stores borrow order response.
BorrowOrder stores borrow order.
BorrowOrderMatchItem represents a borrow order match item detail.
BorrowRepayDetailItem represents a borrow and repay order detail.
BorrowRepayDetailResponse a full response of borrow and repay order.
CancelAllHFOrdersResponse represents a response for cancelling all high-frequency orders.
CancelOrderByNumberResponse represents response for canceling an order by number.
CancelOrderResponse represents cancel order response model.
Chain stores blockchain data.
CompletedHFOrder represents a completed HF orders list.
CompletedRepaymentRecord represents repayment records of isolated margin positions.
ConnectionMessage represents a connection and subscription status message.
Contract store contract details.
CrossMarginAccountDetail represents a cross-margin account details.
CrossMarginRiskLimitCurrencyConfig currency configuration of cross margin accounts.
CrossMarginStatusAndAssets represents a cross-margin status and assets with similar status.
Currency stores currency data.
CurrencyBase represents currency code response details.
CurrencyDetail stores currency details.
Decomposition stores decomposition data.
DeleteSubAccountResponse represents delete sub-account response.
Deposit represents deposit address and detail and timestamp information.
DepositAddress represents deposit address information for Spot and Margin trading.
DepositAddressParams represents a deposit address creation parameters.
DepositResponse represents a detailed response for list of deposit.
EarnProduct represents a time-limited earn limited product item.
EarnRedeem represents an earn redeem by holding id.
EarnRedemptionPreview represents a redemption information of a holding.
EarnSavingProduct represents a saving product instance.
Error defines all error information for each request.
ExchangeFundingAndLoanMargin represents an exchange funding and loan margin.
FailedHFOrderCancellationInfo represents a failed order cancellation information.
Fees represents taker and maker fee information a symbol.
Fill represents order fills for margin and spot orders.
FilledMarginHFOrdersResponse represents a filled HF margin orders.
FixedIncomeEarnHoldings represents a fixed income earn holdings.
FixedIncomeHolding represents a fixed income earn holding detail.
FundingHistoryItem represents funding history item.
FundingInterestRateResponse represents a funding interest rate list response information.
FundTransferFuturesParam holds parameter values for internal transfer.
FundTransferInfo represents a fund transfer instance information.
FundTransferToFuturesParam holds request parameters to transfer funds to futures account.
FundTransferToFuturesResponse response struct after transferring fund to Futures account.
FutureFillsResponse represents a future fills list response detail.
FutureOrdersResponse represents a future order response list detail.
FuturesAccount holds futures account detail information.
FuturesAccountOverview represents a futures account detail.
FuturesDepositDetail represents futures deposit detail information.
FuturesDepositDetailsResponse represents a futures deposits list detail response.
FuturesFill represents list of recent fills for futures orders.
FuturesFundingHistory represents futures funding information.
FuturesFundingHistoryResponse represents funding history response for futures account.
FuturesFundingRate stores funding rate data.
FuturesIndex stores index data.
FuturesIndexResponse represents a response data for futures indexes.
FuturesInterestRate stores interest rate data.
FuturesInterestRateResponse represents a futures interest rate list response.
FuturesKline stores kline data.
FuturesLedgerInfo represents account ledger information for futures trading.
FuturesLedgerInfoDataItem represents a futures ledger info data item.
FuturesMarkPrice stores mark price data.
FuturesMaxOpenPositionSize represents maximum buy/sell open positions an account could have.
FuturesOpenOrderStats represents futures open order summary stats information.
FuturesOrder represents futures order information.
FuturesOrderParam represents a query parameter for placing future oorder.
FuturesOrderRespItem represents a single futures order placing response in placing multiple orders.
FuturesPosition represents futures position detailed information.
FuturesPositionDetail represents a futures position detail.
FuturesPositionHistory represents a position history of futures asset.
FuturesRiskLimitLevel represents futures risk limit level information.
FuturesServiceStatus represents service status.
FuturesSubAccountBalance represents a subaccount balances for futures trading.
FuturesSubAccountBalanceDetail represents a futures sub-account balance detail.
FuturesTicker stores ticker data.
FuturesTrade stores trade data.
FuturesTransactionHistory represents a transaction history.
FuturesTransactionHistoryResponse represents a futures transaction history response.
FuturesTransferOutResponse represents a list of transfer out instance.
FuturesWithdrawalHistory represents a list of Futures withdrawal history.
FuturesWithdrawalLimit represents withdrawal limit information.
FuturesWithdrawalsListResponse represents a list of futures Withdrawal history instance.
HFMarginOrderTrade represents a HF margin order trade item.
HFMarginOrderTransaction represents a HF margin order transaction detail.
HFOrderFills represents an HF order list.
HistoricalDepositWithdrawal represents deposit and withdrawal funding item.
HistoricalDepositWithdrawalResponse represents deposit and withdrawal funding items details.
InnerTransferToMainAndTradeResponse represents a detailed response after transferring fund to main and trade accounts.
InstanceServer represents a single websocket instance server information.
InterestRate represents a currency interest rate.
IsolatedMarginAccountDetail represents an isolated-margin account detail.
IsolatedMarginAccountInfo holds isolated margin accounts of the current user.
IsolatedMarginAssetDetail represents an isolated margin asset detail.
IsolatedMarginBorrowing represents response data for initiating isolated margin borrowing.
IsolatedMarginPairConfig current isolated margin trading pair configuration.
IsolatedMarginRiskLimitCurrencyConfig represents a currency configuration of isolated margin account.
Kline stores kline data.
Kucoin is the overarching type across this package.
LedgerInfo represents account ledger information.
LendingCurrencyInfo represents a lending currency information.
LendOrder stores lend order.
Level2Depth5Or20 stores the orderbook data for the level 5 or level 20 orderbook.
LeveragedTokenInfo represents a leveraged token information.
ListFills represents fills response list detail.
MarginAccount stores margin account data.
MarginAccounts stores margin accounts data.
MarginActiveSymbolDetail represents an active high frequency margin symbols information.
MarginAssetDetail represents an asset detailed information.
MarginBorrowParam represents a margin borrow parameter.
MarginConfiguration stores margin configuration.
MarginHFOrderResponse represents a margin HF order creation response.
MarginInterestInfo represents a margin account currency interest information.
MarginInterestRecords represents a cross/isolated margin interest records.
MarginOrderParam represents the margin place order request parameters.
MarginPairConfig represents a margin pair configuration detail.
MarginPairConfigs querying the configuration of cross margin trading pairs.
MarginRemovingResponse represents a response data for margin response.
MarginRiskLimit stores margin risk limit.
MarkPrice stores mark price data.
ModifyHFOrderParam represents a modify high frequency order parameter.
ModifySubscriptionOrderResponse represents a modify subscription order response.
OCOOrderCancellationResponse represents an order cancellation response.
OCOOrderDetail represents an oco order detail via the order ID.
OCOOrderInfo represents an order info.
OCOOrderItem represents an OCO order item.
OCOOrderParams represents a an OCO order creation parameter.
OCOOrders represents an OCO orders list.
OffExchangeFundingAndLoan represents information of off-exchange funding and loan.
OffExchangeFundingAndLoanOrder represents an exchange funding and loan order detail.
Orderbook stores the orderbook data.
OrderbookChanges represents orderbook ask and bid changes.
OrderDetail represents order detail.
OrderNumberResponse represents a response for margin trading lending and redemption.
OrderRequest represents place order request parameters.
OrdersListResponse represents an order list response.
PlaceHFParam represents a place HF order parameters.
PlaceMarginHFOrderParam represents a margin HF order parameters.
PlaceOrderParams represents a batch place order parameters.
PlaceOrderResp represents a place order response.
PostBulkOrderResp response data for submitting a bulk order.
PostMarginOrderResp represents response data for placing margin orders.
PurchaseSubscriptionOrdersResponse represents list of purchase subscription orders response.
PurchaseSubscriptionResponseItem represents a purchase order subscription response single item.
RedemptionOrder represents a single redemption order instance.
RedemptionOrdersResponse represents a response for querying list of redemption orders.
RepaidRecord stores repaid record.
RepaidRecordsResponse stores list of repaid record details.
RepayParam represents a repayment parameter for cross and isolated margin orders.
Response represents response model and implements UnmarshalTo interface.
ServiceStatus represents a service status message.
SpotAPISubAccount represents a Spot APIs for sub-accounts.
SpotAPISubAccountParams parameters for Spot APIs for sub-accounts.
SpotOrderParam represents the spot place order request parameters.
Stats24hrs stores 24 hrs statistics.
StopOrder holds a stop order detail.
StopOrderListResponse represents a list of spot orders details.
SubAccount represents sub-user.
SubAccountBalanceDetail represents a sub-account balance detail.
SubAccountCreatedResponse represents the sub-account response.
SubAccountCurrencyBalanceDetail represents a sub-account currency balance detail.
SubAccountInfo holds subaccount data for main, spot(trade), and margin accounts.
SubAccountResponse represents the sub-user detail.
SubAccounts represents subacounts detail and balances.
SubAccountsBalanceV2 represents a sub-account balance detail through the V2 API.
SubAccountsResponse represents a sub-accounts items response instance.
SubAccountV2Response represents a sub-account detailed response of V2.
SusbcribeEarn represents a subscription to earn.
SymbolInfo stores symbol information.
SyncCancelHFOrderResp represents a cancel sync high frequency order.
SyncPlaceHFOrderResp represents a request parameter for high frequency sync orders.
Ticker stores ticker data.
TickerInfo stores ticker information.
TickerInfoBase represents base price ticker details.
TickersResponse represents list of tickers and update timestamp information.
Trade stores trade data.
TradingPairFee represents actual fee information of a trading fee.
TransactionVolume represents a 24 hour transaction volume.
Transfer represents a transfer detail.
TransferableBalanceInfo represents transferable balance information.
TransferBase represents transfer base information.
TransferListsResponse represents a transfer lists detail.
TransferRes represents a transfer response.
UniversalTransferParam represents a universal transfer parameter.
UserRebateInfo represents a user rebate information.
VIPLendingAccounts represents VIP accounts involved in off-exchange loans.
Withdrawal represents withdrawal funding information.
WithdrawalQuota represents withdrawal quota detail information.
WithdrawalsResponse represents a withdrawals list of items details.
WithdrawMarginResponse represents a response data after withdrawing a margin.
WsAccountBalance represents a Account Balance push data.
WsCandlestick represents candlestick information push data for a symbol.
WsCandlestickData represents candlestick information push data for a symbol.
WSConnMessages represents response messages ping, pong, and welcome message structures.
WsDebtRatioChange represents a push data.
WsFundingRate represents the funding rate push data information through the websocket channel.
WsFuturesAvailableBalance represents an available balance push data for futures account.
WsFuturesExecutionData represents execution data for symbol.
WsFuturesFundingBegin represents the Start Funding Fee Settlement.
WsFuturesKline represents a futures kline data.
WsFuturesMarkPriceAndIndexPrice represents mark price and index price information.
WsFuturesMarkPricePositionChanges represents futures account position change caused by mark price.
WsFuturesOrderbookInfo represents Level 2 order book information.
WsFuturesOrderMarginEvent represents an order margin account balance event.
WsFuturesPosition represents futures account position change event.
WsFuturesPositionFundingSettlement represents futures account position funding settlement push data.
WsFuturesTicker represents a futures ticker push data.
WsFuturesTradeOrder represents trade order information according to the market.
WsFuturesTransactionStatisticsTimeEvent represents transaction statistics data.
WsFuturesWithdrawalAmountAndTransferOutAmountEvent represents Withdrawal Amount & Transfer-Out Amount Event push data.
WSInstanceServers response connection token and websocket instance server information.
WsMarginTradeOrderDoneEvent represents a push message to the lenders when the order is completed.
WsMarginTradeOrderEntersEvent represents a push data to the lenders when the order enters the order book or when the order is executed.
WsOrderbook represents orderbook information.
WsOrderbookLevel5 represents an orderbook push data with depth level 5.
WsOrderbookLevel5Response represents a response data for an orderbook push data with depth level 5.
WsPositionStatus represents a position status push data.
WsPriceIndicator represents index price or mark price indicator push data.
WsPushData represents a push data from a server.
WsSnapshot represents a spot ticker push data.
WsSnapshotDetail represents the detail of a spot ticker data This represents all websocket ticker information pushed as a result of subscription to /market/snapshot:{symbol}, and /market/snapshot:{currency,market}.
WsStopOrder represents a stop order When a stop order is received by the system, you will receive a message with "open" type It means that this order entered the system and waited to be triggered.
WsStopOrderLifecycleEvent represents futures stop order lifecycle event.
WsSubscriptionInput represents a subscription information structure.
WsTicker represents a ticker push data from server.
WsTrade represents a trade push data.
WsTradeOrder represents a private trade order push data.
# Interfaces
UnmarshalTo acts as interface to exchange API response.