0.2.3 • Published 5 months ago

node-api-coinbase v0.2.3

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

node-api-coinbase

WARNING: This package is still early beta! Expect breaking changes until this sees a major release.

Non-official implementation of Coinbase's Advanced Trade 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

APIDESCRIPTION
getServerTimehttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getservertime
getProductBookhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getpublicproductbook
listProductshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getpublicproducts
getProducthttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getpublicproduct
getProductCandleshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getpubliccandles
getMarketTradeshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getpublicmarkettrades

PRIVATE API

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

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

  const privateAPI=new coinbase.privateApi(auth);

Accounts

APIDESCRIPTION
listAccountshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getaccounts
getAccounthttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getaccount

Products

APIDESCRIPTION
getBesthttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getbestbidask
getOrderBookhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getproductbook
listProductshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getproducts
getProducthttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getproduct
getCandleshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getcandles
getTradeshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getmarkettrades

Orders

APIDESCRIPTION
createOrderhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_postorder
cancelOrdershttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_cancelorders
editOrderhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_editorder
editOrderPreviewhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_previeweditorder
listOrdershttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_gethistoricalorders
listFillshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getfills
getOrderhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_gethistoricalorder
previewOrderhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_previeworder
closePositionhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_closeposition

Portfolios

APIDESCRIPTION
listPortfolioshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getportfolios
createPortfoliohttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_createportfolio
movePortfolioFundshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_moveportfoliofunds
getPortfolioBreakdownhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getportfoliobreakdown
deletePortfoliohttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_deleteportfolio
editPortfoliohttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_editportfolio

Futures

APIDESCRIPTION
getFururesBalanceSummaryhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getfcmbalancesummary
getIntradayMarginSettingshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getintradaymarginsetting
setIntradayMarginSettingshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_setintradaymarginsetting
getCurrentMarginWindowhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getcurrentmarginwindow
listFuturesPositionshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getfcmpositions
getFuturesPositionshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getfcmposition
scheduleFuturesSweephttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_schedulefcmsweep
listFuturesSweepshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getfcmsweeps
cancelPendingFuturesSweephttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_cancelfcmsweep

Perpetuals

APIDESCRIPTION
allocatePortfoliohttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_allocateportfolio
getPerpetualsPortfolioSummaryhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getintxportfoliosummary
listPerpetualsPositionshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getintxpositions
getPerpetualsPositionhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getintxposition
getPortfoliosBalanceshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getintxbalances
optMultiAssetCollateralhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_intxmultiassetcollateral

Fees

APIDESCRIPTION
getTransactionSummaryhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_gettransactionsummary

Convert

APIDESCRIPTION
createConvertQuotehttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_createconvertquote
getConvertTradehttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getconverttrade
commitConvertTradehttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_commitconverttrade

Payment Methods

APIDESCRIPTION
listPaymentMethodshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getpaymentmethods
getPaymentMethodhttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getpaymentmethod

API

APIDESCRIPTION
getAPIPermissionshttps://docs.cdp.coinbase.com/advanced-trade/reference/retailbrokerageapi_getapikeypermissions

WEBSOCKET API

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

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

  const
    userAPI=new coinbase.sockets.userApi(auth);
    marketAPI=new coinbase.sockets.marketApi();

  userAPI.setHandler('user.snapshot', (method,data,symbol,option) => { updateOrder(method,data.orders,user,api,handler); });
  userAPI.setHandler('user.update', (method,data,symbol,option) => { updateOrder(method,data.orders,user,api,handler); });

  userAPI.socket._ws.on('authenticated', async () => {
    await tradingAPI.subscribeUser(['ETH-BTC','BTC-USDT']);

  });

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

  function updateOrder(symbol,method,data) {
    // do something
  };
APIHANDLERDESCRIPTION
subscribe unsubscribesubscriptions
subscribeHeartbeats unsubscribeHeartbeatsheartbeatshttps://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#heartbeats-channel
subscribeCandles unsubscribeCandlescandles.snapshot candles.updatehttps://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#candles-channel
subscribeStatus unsubscribeStatusstatus.snapshot status.update(?)https://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#status-channel
subscribeTicker unsubscribeTickerticker.snapshot ticker.updatehttps://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#ticker-channel
subscribeTickerBatch unsubscribeTickerBatchticker_batch.snapshot ticker_batch.updatehttps://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#ticker-batch-channel
subscribeOrderbook unsubscribeOrderbookl2_data.snapshot l2_data.updatehttps://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#level2-channel
subscribeUser unsubscribeUseruser.snapshot user.update(?)https://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#user-channel
subscribeTrades unsubscribeTradesmarket_trades.snapshot market_trades.updatehttps://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#market-trades-channel
subscribeFutures unsubscribeFuturesmarket_trades.snapshot market_trades.updatehttps://docs.cdp.coinbase.com/advanced-trade/docs/ws-channels#futures-balance-summary-channel
0.2.1

5 months ago

0.2.0

5 months ago

0.2.3

5 months ago

0.2.2

5 months ago

0.1.13

2 years ago

0.1.14

2 years ago

0.1.10

2 years ago

0.1.11

2 years ago

0.1.12

2 years ago

0.1.8

2 years ago

0.1.7

2 years ago

0.1.9

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago

0.0.1

2 years ago