0.1.2 • Published 6 months ago

node-api-cryptocom v0.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

node-api-cryptocom

Non-official implementation of Crypto.com's Exchange API's. Developed for personal use.

For support on using the API's or development issues, please refer to the official API documentation. For questions regarding this package, please consult the code first.

PUBLIC API

  const cryptocom=require('node-api-cryptocom');

  const publicAPI=new cryptocom.publicApi();

Market Data

APIDESCRIPTION
getSymbolshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-instruments
getOrderBookhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-book
getCandleshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-candlestick
getTradeshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-trades
getTickerhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-tickers
getValuationshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-valuations
getSettlementPricehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-expired-settlement-price
getInsurancehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-insurance

PRIVATE API

  const cryptocom=require('node-api-cryptocom');

  const auth = {
    apikey: 'MY_API_KEY',
    secret: 'MY_API_SECRET'
  };

  const privateAPI=new cryptocom.privateApi(auth);

Account Balance and Position API

APIDESCRIPTION
getSpotBalancehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-user-balance
getSpotBalanceHistoryhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-user-balance-history
getAccountshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-accounts
createSubaccountTransferhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-subaccount-transfer
getSubaccountBalancehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-subaccount-balances
getPositionshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-positions

Trading API

APIDESCRIPTION
createSpotOrderhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order
cancelSpotOrderhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order
cancelSpotOrdershttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-all-orders
closePositionshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-close-position
getSpotOrdershttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-open-orders
getSpotOrderhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-order-detail
setLeveragehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-change-account-leverage

Advanced Order Management API

APIDESCRIPTION
createOrderListhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order-list-list https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order-list-oco
cancelOrderListhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order-list-list https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order-list-oco
getOrderListhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-order-list-oco

Order, Trade, Transaction History API

APIDESCRIPTION
getOrderHistoryhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-order-history
getTradeshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-trades
getTransactionshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-transactions

Wallet API

APIDESCRIPTION
createWithdrawalhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-withdrawal
getCurrencyNetworkshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-currency-networks
getDepositAddresshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-deposit-address
getDepositHistoryhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-deposit-history
getWithdrawalHistoryhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-withdrawal-history

WEBSOCKET API

  const cryptocom=require('node-api-cryptocom');

  const auth = {
    apikey: 'MY_API_KEY',
    secret: 'MY_API_SECRET'
  };

  const marketAPI=new cryptocom.sockets.marketApi();
  marketAPI.socket._ws.on('initialized', async () => {
    // do your own initialization
  });

  const privateAPI=new cryptocom.sockets.privateApi(auth);
  privateAPI.setHandler('user.order', (method,data,symbol,option) => { updateOrders(method,data,user,api,handler); });

  privateAPI.socket._ws.on('authenticated', async () => {
    const res=await privateAPI.subscribeOrders();
  });

  privateAPI.socket._ws.on('closed', async () => {
    // do something, like clean-up and reconnect
  });

  function updateOrders(method,orders,user,api,handler) {
    // do something
  };

Websocket Market API

APIHANDLERDESCRIPTION
subscribeOrderbook unsubscribeOrderbookbookhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name-depth
subscribeTicker unsubscribeTickertickerhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#ticker-instrument_name
subscribeTrades unsubscribeTradestradehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#trade-instrument_name
subscribeCandles unsubscribeCandlescandlestickhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#candlestick-time_frame-instrument_name
subscribeIndex unsubscribeIndexindexhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#index-instrument_name
subscribeMarkPrices unsubscribeMarkPricesmarkhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#mark-instrument_name
subscribeSettlementPrices unsubscribeSettlementPricessettlementhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#settlement-instrument_name
subscribeFunding unsubscribeFundingfundinghttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#funding-instrument_name
subscribeEstimatedFunding unsubscribeEstimatedFundingestimatedfundinghttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#estimatedfunding-instrument_name

Socket Authentication

APIDESCRIPTION
loginhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-auth
setHandler
setCancelOnDisconnecthttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-set-cancel-on-disconnect
getCancelOnDisconnecthttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-cancel-on-disconnect

Websocket User API

APIHANDLERDESCRIPTION
subscribeOrders unsubscribeOrdersuser.orderhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-order-instrument_name
subscribeMyTrades unsubscribeMyTradesuser.tradehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-trade-instrument_name
subscribeSpotBalances unsubscribeSpotBalancesuser.balancehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-balance
subscribePositions unsubscribePositionsuser.positionshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-positions
subscribeRiskStatus unsubscribeRiskStatususer.account_riskhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-account_risk
subscribePositionBalances unsubscribePositionBalancesuser.position_balancehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-position_balance

Socket Account Balance and Position API

APIDESCRIPTION
getSpotBalancehttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-user-balance
getPositionshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-positions

Trading API

APIDESCRIPTION
createSpotOrderhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order
cancelSpotOrderhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order
cancelSpotOrdershttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-all-orders
closePositionshttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-close-position
getSpotOrdershttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-open-orders

Advanced Order Management API

APIDESCRIPTION
createOrderListhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order-list-list https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order-list-oco
cancelOrderListhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order-list-list https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order-list-oco

Wallet API

APIDESCRIPTION
createWithdrawalhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-withdrawal
getWithdrawalHistoryhttps://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-withdrawal-history
0.1.2

6 months ago

0.1.1

6 months ago

0.1.0

6 months ago

0.0.1

6 months ago