API 3Commas

3Commas

 

APIs supported

 

WebSockets API

The websocket feed provides real-time market data updates for Trades and Deals

 

You can subscribe to the following Public channels:

 

Method Arguments Description
SubscribeSmartTrades    
SubscribeDeals    

 

These channels requires Authenticate against 3Commas servers. So first request your API keys in your 3Commas Account and then set the values in the property ThreeComas of the component:

 

 

If the subscription is successful, the event OnThreeCommasConfirmSubscription will be called. If not, the event OnThreeCommasRejectSubscription it's called, you can get the reason of the rejection using the aRawMessage parameter.

 

REST API

Test Connectivity

Method Arguments Description
GetPing    
GetServerTime   Returns the server time

 

Account

Method Arguments Description
GetAccounts   User connected exchanges list
GetMarketList   Supported Market List
GetMarketPairs aMarketCode: code of the market All market pairs
GetCurrencyRatesWithLeverageData aMarketCode: code of the market aPair: pair name Currency rates and limits with leverage data
GetCurrencyRates aMarketCode: code of the market aPair: pair name Currency rates and limits
GetBalances aAccountId: if of the account Load balances for specified exchange
GetAccountTableData aAccountId: if of the accoun Information about all user balances on specified exchange
GetAccountLeverage aAccountId: if of the accoun aPair: pair name Information about account leverage
GetAccountInfo aAccountId: if of the accoun Single Account Info

 

 

Smart Trades

Method Arguments Description
GetSmartTradeHistory   Get the Trade History
PlaceMarketOrder aAccountId: id of the account aOrderSide: buy or sell aPair: pair name aQuantity: amount Places a Market Order
PlaceLimitOrder aAccountId: id of the account aOrderSide: buy or sell aPair: pair name aQuantity: amount aPrice: limit price Places a Limit ORder
GetSmartTrade aId: id of the trade Get a Smart Trade by the Id of the Trade
CancelSmartTrade aId: id of the trade Cancel a Smart Trade by the Id of the Trade
CloseByMarketSmartTrade aId: id of the trade  

 

Events

OnConnect

 

When a new WebSocket connection is open

 

OnDisconnect

 

When a WebSocket connection is closed

 

OnThreeCommasConnect

 

When the client receives a Welcome message from 3Commas server, means the connection is ready.

 

OnThreeCommasConfirmSubscription

 

Confirms a previously subscription sent by the client.

 

OnThreeCommasRejectSubscription

 

There is any error trying to subscribe to a 3Commas channel

 

OnThreeCommasMessage

 

Here the client receives the data sent by server related to the channels subscribed

 

OnThreeCommasPing

 

Ping sent by server to the client.

 

OnThreeCommasHTTPException

 

If there is any error while calling HTTP REST methods, this event will be called.