@coinex-org/coinex

@coinex-org/coinex

A lightweight, type-safe TypeScript client for the official CoinEx API v2.

Features

• Type-Safe: Fully typed requests and responses for better developer experience and fewer runtime errors.
• Comprehensive: Covers all major V2 API modules including Spot, Futures, Account, and Assets.
• Modern: Built with modern tools and libraries, including ky for HTTP requests.
• Clear Documentation: All methods and types are documented with JSDoc, linking back to the official CoinEx API documentation.

Installation

npm install @coinex-org/coinex

Install using your favorite package manager

pnpm

pnpm install @coinex-org/coinex

yarn

yarn add @coinex-org/coinex

Usage

First, you need to import and initialize the CoinExClient with your API Key and Secret Key.

import { CoinExClient } from '@coinex-org/coinex';

const client = new CoinExClient({
  apiKey: 'YOUR_API_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

// Example: Get server time (public endpoint)
const serverTime = await client.getSystemTime();
console.log('Server Time:', serverTime);

// Example: Get account information (private endpoint)
const accountInfo = await client.account.getAccountInfo();
console.log('Account Info:', accountInfo);

// Example: Get spot market list
const spotMarkets = await client.spot.market.listMarket();
console.log('Spot Markets:', spotMarkets.slice(0, 5)); // Log first 5 for brevity

Documentation

For all configuration options, please see the API docs.

API Modules

The client is organized into modules that mirror the official CoinEx API structure.

Common

• client.ping(): Ping the server.
• client.getSystemTime(): Get the server time.

Account (client.account)

• Subaccount: createSubAccount, getSubAccountList, disableSubAccount, enableSubAccount, createSubAccountApiKey, getSubAccountApiKeyDetail, getSubAccountInfo, subAccountTransfer, getSubAccountTransferHistory, getSubAccountApiKeyList, getSubAccountSpotBalance, editSubAccountApiKey, deleteSubAccountApiKey
• Fees: getAccountTradeFees
• Settings: getFuturesMarketSettings, modifyAccountSettings, modifyFuturesMarketSettings
• getAccountInfo(): Get main account information.

Assets (client.assets)

• AMM: addAMMLiquidity, getAMMIncomeHistory, getAMMLiquidityPool, removeAMMLiquidity
• Balance: getAMMLiquidity, getCreditBalance, getCreditInfo, getFinancialBalance, getFuturesBalance, getMarginBalance, getSpotBalance, getSpotTransactionHistory
• Borrow & Repay: getMarginBorrowHistory, getMarginInterestLimit, marginBorrow, marginRepay
• Deposit & Withdrawal: cancelWithdrawal, getDepositAddress, getDepositWithdrawalConfig, getAllDepositWithdrawalConfig, getAssetInfo, getDepositHistory, getWithdrawalHistory, updateDepositAddress, withdrawal
• Transfer: getAssetTransferHistory, transfer

Spot (client.spot)

• Market: listMarket, listMarketTicker, listMarketDepth, listMarketKline, listMarketDeals, listMarketIndex
• Order: putOrder, putStopOrder, getOrderStatus, getMultiOrderStatus, listPendingOrder, listFinishedOrder, listPendingStopOrder, listFinishedStopOrder, editOrder, editStopOrder, cancelOrder, cancelOrderByClientId, cancelStopOrder, cancelStopOrderByClientId, cancelAllOrder, cancelBatchOrder, cancelBatchStopOrder, putMultiOrder, putMultiStopOrder
• Deal: listUserDeals, listUserOrderDeals

Futures (client.futures)

• Market: listMarketBasisHistory, listMarketDeals, listMarketDepth, listMarketFundingRateHistory, listMarketFundingRate, listMarketIndex, listMarketKline, listMarketLiquidationHistory, listMarketPositionLevel, listMarketPremiumHistory, listMarketTicker, listMarket
• Order: putOrder, putStopOrder, getOrderStatus, getMultiOrderStatus, listPendingOrder, listFinishedOrder, listPendingStopOrder, listFinishedStopOrder, editOrder, editStopOrder, cancelOrder, cancelOrderByClientId, cancelStopOrder, cancelStopOrderByClientId, cancelAllOrder, cancelBatchOrder, cancelBatchStopOrder, putMultiOrder, putMultiStopOrder
• Position: adjustPositionLeverage, adjustPositionMargin, closePosition, listFinishedPosition, listPendingPosition, listPositionAdlHistory, listPositionFundingHistory, listPositionMarginHistory, listPositionSettleHistory, setPositionStopLoss, setPositionTakeProfit
• Deal: listUserDeals, listUserOrderDeals

Maintain (client.maintain)

• getMaintenanceInfo(): Get system maintenance information.

License

MIT © Shahrad Elahi and contributors.