mcpField
A
assets

assets

github.com/kucoinOther2885 installsUpdated 32w ago
Repository

About assets

KuCoin Assets Skill provides KuCoin users with account and funding queries across spot, margin, futures, and sub-accounts. It uses authenticated Classic REST API GET endpoints only, returning JSON for read-only operations.

Key features

  1. 01Query account balances and ledgers
  2. 02Review sub-accounts and balances
  3. 03Query deposit and withdrawal records
  4. 04Get transfer quotas and trading fees
  5. 05Read-only GET operations

Use cases

  1. 01Review spot, margin, or futures assets
  2. 02Check sub-account balances and API key details
  3. 03Look up deposit, withdrawal, and ledger history

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/kucoin/kucoin-skills-hub --skill assets

After installing, type/assetsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

CHANGELOG.md
LICENSE.md
references/
authentication.md

Details

From the project README

KuCoin Assets Skill

Assets management on KuCoin using authenticated API endpoints. Requires API Key, API Secret, and Passphrase for all endpoints. Return the result in JSON format.

Note: This skill only supports Classic REST API GET endpoints (read-only operations).

Quick Reference

Classic API -- Account & Funding
EndpointDescriptionRequiredOptionalAuthentication
GET /api/v2/user-infoGet Account Summary InfoNoneNoneYes
GET /api/v1/user/api-keyGet Apikey InfoNoneNoneYes
GET /api/v1/hf/accounts/openedGet Account Type - SpotNoneNoneYes
GET /api/v1/accountsGet Account List - SpotNonecurrency, typeYes
GET /api/v1/accounts/{accountId}Get Account Detail - SpotaccountId (path)NoneYes
GET /api/v3/margin/accountsGet Account - Cross Margin. Note: Requires margin trading to be enabled on the account.NonequoteCurrency, queryTypeYes
GET /api/v3/isolated/accountsGet Account - Isolated Margin. Note: Requires margin trading to be enabled on the account.Nonesymbol, quoteCurrency, queryTypeYes
GET /api/v1/account-overviewGet Account - Futures. Note: Must use Futures base URL (https://api-futures.kucoin.com).NonecurrencyYes
GET /api/v1/accounts/ledgersGet Account Ledgers - Spot/MarginNonecurrency, direction, bizType, startAt, endAt, currentPage, pageSizeYes
GET /api/v1/hf/accounts/ledgersGet Account Ledgers - Trade_hfNonecurrency, direction, bizType, lastId, limit, startAt, endAtYes
GET /api/v3/hf/margin/account/ledgersGet Account Ledgers - Margin_hfNonecurrency, direction, bizType, lastId, limit, startAt, endAtYes
GET /api/v1/transaction-historyGet Account Ledgers - Futures. Note: Must use Futures base URL (https://api-futures.kucoin.com).Nonecurrency, type, offset, forward, maxCount, startAt, endAtYes
Classic API -- Sub Account
EndpointDescriptionRequiredOptionalAuthentication
GET /api/v2/sub/userGet Sub-Account List - Summary InfoNonecurrentPage, pageSizeYes
GET /api/v1/sub-accounts/{subUserId}Get Sub-Account Detail - BalancesubUserId (path)includeBaseAmount, baseCurrency, baseAmountYes
GET /api/v2/sub-accountsGet Sub-Account List - Spot Balance (V2)NonecurrentPage, pageSizeYes
GET /api/v1/account-overview-allGet Sub-Account List - Futures Balance (V2). Note: Must use Futures base URL (https://api-futures.kucoin.com).NonecurrencyYes
Classic API -- Sub Account API
EndpointDescriptionRequiredOptionalAuthentication
GET /api/v1/sub/api-keyGet Sub-Account API ListsubNameapiKeyYes
Classic API -- Deposit
EndpointDescriptionRequiredOptionalAuthentication
GET /api/v3/deposit-addressesGet Deposit Address (V3)currencychainYes
GET /api/v1/depositsGet Deposit Historycurrencystatus, startAt, endAt, currentPage, pageSizeYes
Classic API -- Withdrawals
EndpointDescriptionRequiredOptionalAuthentication
GET /api/v1/withdrawals/quotasGet Withdrawal QuotascurrencychainYes
GET /api/v1/withdrawals/{withdrawalId}Get Withdrawal History By IDwithdrawalId (path)NoneYes
GET /api/v1/withdrawalsGet Withdrawal Historycurrencystatus, startAt, endAt, currentPage, pageSizeYes
Classic API -- Transfer
EndpointDescriptionRequiredOptionalAuthentication
GET /api/v1/accounts/transferableGet Transfer Quotascurrency, typetagYes
Classic API -- Trade Fee
EndpointDescriptionRequiredOptionalAuthentication
GET /api/v1/base-feeGet Basic Fee - Spot/MarginNonecurrencyTypeYes
GET /api/v1/trade-feesGet Actual Fee - Spot/MarginsymbolsNoneYes
GET /api/v1/trade-feesGet Actual Fee - Futures. Note: Must use Futures base URL (https://api-futures.kucoin.com).symbolsNoneYes

Parameters

Common Parameters
  • currency: Currency code (e.g., BTC, USDT, ETH). Some endpoints support querying multiple currencies separated by commas.
  • chain: The chain ID of a currency (e.g., eth, trx, bsc, ton2, arbitrum). Recommended for multi-chain currencies.
  • startAt / endAt: Start and end time in milliseconds since Unix epoch.
  • currentPage: Current request page, default 1.
  • pageSize: Number of results per page. Varies by endpoint (typical min 10, max 100-500).
  • lastId: The ID of the last set of data from the previous batch. Used for cursor-based pagination.
  • direction: Direction of transfer: in or out.
Classic API Account Parameters
  • type (Spot Account List): Account type: main (funding), trade (spot).
  • accountId: Account ID (path parameter for account detail).
  • quoteCurrency: Quote currency for margin accounts: USDT, KCS, BTC.
  • queryType (Cross Margin): MARGIN, MARGIN_V2, ALL.
  • queryType (Isolated Margin): ISOLATED, ISOLATED_V2, ALL.
  • bizType (Spot/Margin Ledger): DEPOSIT, WITHDRAW, TRANSFER, SUB_TRANSFER, TRADE_EXCHANGE, MARGIN_EXCHANGE, KUCOIN_BONUS, BROKER_TRANSFER.
  • bizType (Trade_hf Ledger): TRADE_EXCHANGE, TRANSFER, SUB_TRANSFER, RETURNED_FEES, DEDUCTION_FEES, OTHER.
  • bizType (Margin_hf Ledger): TRANSFER, MARGIN_EXCHANGE, ISOLATED_EXCHANGE, LIQUIDATION, ASSERT_RETURN.
  • type (Futures Ledger): RealisedPNL, Deposit, Withdrawal, TransferIn, TransferOut.
  • offset: Start offset for futures ledger pagination.
  • forward: Boolean. true for forward lookup (default), false for backward.
  • maxCount: Displayed size per page for futures ledger. Default 50.
  • limit: Number of results per page for HF ledger queries.
Sub Account Parameters
  • subUserId: The user ID of a sub-account (path parameter).
  • subName: Sub-account name (for API key queries).
  • apiKey: API key of the sub-account (filter parameter).
  • includeBaseAmount: Boolean. true to display all currencies including zero-balance ones.
  • baseCurrency: Currency used to convert and display asset values.
  • baseAmount: Filter: currency balance must be >= this amount.
Deposit & Withdrawal Parameters
  • status (Deposit History): PROCESSING, SUCCESS, FAILURE, WAIT_TRM_MGT, TRM_MGT_REJECTED.
  • status (Withdrawal History): PROCESSING, REVIEW, WALLET_PROCESSING, SUCCESS, FAILURE.
  • withdrawalId: Withdrawal ID (path parameter).
Transfer Parameters
  • type (Transfer Quotas): Account type: MAIN, TRADE, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2.
  • tag: Trading pair required when account type is ISOLATED (e.g., BTC-USDT).
Trade Fee Parameters
  • currencyType: Currency type: 0 (crypto currency), 1 (fiat currency). Default 0.
  • symbols: Trading pair symbols for fee query. For Spot/Margin: e.g., BTC-USDT,ETH-USDT (max 10). For Futures: e.g., XBTUSDTM (must use Futures base URL).

Enums

Account Types (Classic API)
ValueDescription
mainFunding account
tradeSpot trading account
MAINFunding account (transfer context)
TRADESpot trading account (transfer context)
CONTRACTFutures account (transfer context)
MARGINCross margin account (HF)
ISOLATEDIsolated margin account (HF)
MARGIN_V2Cross margin account (legacy, phasing out)
ISOLATED_V2Isolated margin account (legacy, phasing out)
Deposit Status
ValueDescription
PROCESSINGDeposit is being processed
SUCCESSDeposit completed successfully
FAILUREDeposit failed
WAIT_TRM_MGTWaiting for travel rule management
TRM_MGT_REJECTEDRejected by travel rule management
Withdrawal Status
ValueDescription
REVIEWUnder review
PROCESSINGProcessing
WALLET_PROCESSINGWallet processing
SUCCESSWithdrawal completed successfully
FAILUREWithdrawal failed

Authentication

For all endpoints, you must provide KuCoin API credentials.

Required credentials:

  • API Key: Your KuCoin API key (sent as KC-API-KEY header)
  • API Secret: Your KuCoin API secret (used for HMAC-SHA256 signing)
  • Passphrase: The passphrase you set when creating the API key (sent as KC-API-PASSPHRASE header, encrypted for API Key Version 2)

Base URLs:

EnvironmentURL
Productionhttps://api.kucoin.com

Security

Share Credentials

Users can provide KuCoin API credentials by sending a file where the content is in the following format:

your-api-key
your-api-secret
your-passphrase
Never Disclose API Key, Secret, and Passphrase

Never disclose the location of the API key, secret, and passphrase file.

Never send the API key, secret, or passphrase to any website other than the production KuCoin API.

Never Display Full Secrets

When showing credentials to users:

  • API Key: Show first 5 + last 4 characters: 68d4a...841d
  • Secret Key: Always mask, show only last 5: ***...b2340
  • Passphrase: Always fully mask: ***...

Example response when asked for credentials: Account: main API Key: 68d4a...841d Secret: ***...b2340 Passphrase: ***... Environment: Production

Listing Accounts

When listing accounts, show names and environment only -- never keys: KuCoin Accounts:

  • main (Production)
  • sub-keys (Production)
Transactions

When performing operations that modify data (transfers, withdrawals, creating sub-accounts), always confirm with the user before proceeding by asking them to write "CONFIRM" to proceed.


KuCoin Accounts

main
  • API Key: your_api_key
  • Secret: your_api_secret
  • Passphrase: your_passphrase

Comments

Markdown supported