hexate / 3commas.net

A .Net wrapper of the official 3Commas API

3Commas.Net

A feature complete and easy to use .Net wrapper of the official 3Commas API.

Don't forget to visit the official API docs or 3Commas support for further reference.

🐧 This API wrapper is not an official release from the 3Commas team. It is however made with love, by a penguin!

Getting started

XCommas.Net is available as a nuget package for .Net Core, .Net Standard, and various .Net Framework versions.

Install XCommas.net as a nuget package from the package manager console:

PM> Install-Package XCommas.Net

You can also clone this repository and add the XCommas.Net project directly to your solution.

Instantiating the client

All you need to instantiate the all-powerful client is to new up an instance of XCommasApi. You need to generate an API key and secret before you can use the API.

var apiKey = "YOUR_API_KEY";
var secret = "YOUR_SECRET";

var client = new XCommas.Net.XCommasApi(apiKey, secret);

Methods

The entire API is supported, and each method exists in a synchronous and asynchronous version for your integration pleasure. Most methods return an instance of XCommasResponse<T> where T is a strongly typed representation of the data returned from 3commas, which can be either a single object or a collection of objects.

You are encouraged to check the IsSuccess property before accessing the Data property. If an error has occured, the Error property will contain the error message. For troubleshooting purposes, the original json reponse from 3commas is included in the RawData string property.

Account

This section covers the methods described in the official documentation here.

GetAccounts

var response = await client.GetAccountsAsync();

foreach(var account in response.Data)
{
    //Do something with account
    accountId = account.Id;
}

GetMarkets

var response = await client.GetMarketsAsync();

foreach(var market in response.Data)
{
    //Do something with market
    Console.WriteLine(market.Name);
}

GetMarketPairs

var response = await client.GetMarketPairsAsync(marketCode);

foreach(var marketPair in response.Data)
{
    //Do something with marketPair
    Console.WriteLine(marketPair);
}

CreateAccount

var account = new AccountCreateData
{
    Name = "My Binance",
    MarketName = "Binance", //Get from markets list
    ApiKey = "MyBinanceApiKey",
};

var response = await client.CreateAccountAsync(account);

CreateAccount

var account = new AccountCreateData
{
    Name = "My Binance",
    MarketName = "Binance", //Get from markets list
    ApiKey = "MyBinanceApiKey",
};

var response = await client.CreateAccountAsync(account);

GetCurrencyRate

var response = await client.GetCurrencyRateAsync("MCO_BTC");

var mcoAsk = response.Data.Ask;

SellAllToUsd

var response = await client.SellAllToUsdAsync(accountId);

SellAllToBtc

var response = await client.SellAllToBtcAsync(accountId);

LoadBalances

var response = await client.LoadBalancesAsync(accountId);

var totalBtcProfit = response.Data.TotalBtcProfit;

RenameAccount

var response = await client.RenameAccountAsync(accountId, "My new shiny account name");

GetPieChartData

var response = await client.GetPieChartDataAsync(accountId);

GetAccountTableData

var response = await client.GetAccountTableDataAsync(accountId);

RemoveAccount

var response = await client.RemoveAccountAsync(accountId);

Smart Trades

This section covers the methods described in the official documentation here.

GetSmartTrade

var response = await client.GetSmartTradeAsync(smartTradeId);

GetSmartTrades

var response = await client.GetSmartTradesAsync();

foreach(var smartTrade in response.Data)
{
    //Do something with smart trade
    Console.WriteLine(smartTrade.Note);
}

CreateSmartTrade

var data = new SmartTradeCreateRequest
{
    Id = 123,
    AccountId = accountId,
    Pair = "BTC_ETH",
    Position = ...,
    TakeProfit = ...,
    StopLoss = ...
};

var response = await client.CreateSmartTradeAsync(data);

UpdateSmartTrade

var data = new SmartTradeCreateRequest
{
    Id = 123,
    Position = ...,
    TakeProfit = ...,
    StopLoss = ...
};

var response = await client.UpdateSmartTradeAsync(smartTradeId, data);

CancelSmartTrade

var response = await client.CancelSmartTradeAsync(smartTradeId);

CloseSmartTradeByMarket

var response = await client.CloseSmartTradeByMarketAsync(smartTradeId);

AddFundsToSmartTrade

var data = new AddFundsToSmartTradeParams
{
    Id = 123,
    OrderType = ...,
    Units = ...,
    Price = ...,
};

var response = await client.AddFundsToSmartTradeAsync(smartTradeId);

Bots

This section covers the methods described in the official documentation here.

GetBotPairsBlackList

var response = await client.GetBotPairsBlackListAsync(smartTradeId);

SetBotPairsBlackList

var data = new BotPairsBlackListData
{
    Pairs = new[] { "BTC_NPXS", "BTC_XRP" }
};

var response = await client.SetBotPairsBlackListAsync(data);

CreateBot

//These settings are for demonstration purposes ONLY!
var data = new BotData
{
    Pairs = new[] { "BTC_ETH", "BTC_KMD", "BTC_ENG" },
    ActiveSafetyOrdersCount = 1,
    BaseOrderVolume = 0.007m,
    SafetyOrderVolume = 0.014m,
    MartingaleStepCoefficient = 1.2m,
    MartingaleVolumeCoefficient = 1.1m,
    MinVolumeBtc24h = 75m,
    MaxActiveDeals = 6,
    ProfitCurrency = ProfitCurrency.QuoteCurrency,
    SafetyOrderStepPercentage = 2.5m,
    MaxSafetyOrders = 2,
    TakeProfitType = TakeProfitType.Total,
    TakeProfit = 3.5m,
    Name = "My new bot",
    TrailingEnabled = true,
    TrailingDeviation = 1.0m,
    StartOrderType = StartOrderType.Limit,
    Strategies = new BotStrategy[]
    {
        new QflBotStrategy
        {
            Options = new QflOptions{ Percent = 3, Type = QflType.Original },
        },
        new TradingViewBotStrategy
        {
            Options = new TradingViewOptions { Time = TradingViewTime.OneHour, Type = TradingViewIndicatorType.StrongBuy }
        },
        new RsiBotStrategy
        {
            Options = new RsiOptions { Time = IndicatorTime.FiveMinutes, Points = 17 }
        },
        new CqsTelegramBotStrategy
        {
            
        },
        new TaPresetsBotStrategy
        {
            Options = new TaPresetsOptions { Time = IndicatorTime.ThirtyMinutes, Type = TaPresetsType.MFI_14_20 }
        },
        new UltBotStrategy
        {
            Options = new UltOptions { Time = IndicatorTime.TwoHours, Points = 60 }
        }
    }.ToList(),
    StopLossPercentage = 10m,
};

var response = await client.CreateBotAsync(accountId, Strategy.Long, data);

GetBots

var response = await client.GetBotsAsync(limit: 10, botScope: BotScope.Enabled, strategy: Strategy.Short);

GetBotStats

var response = await client.GetBotStatsAsync();

UpdateBot

//These settings look a lot like what José recommends for CQS scalping!
var data = new BotData
{
    Pairs = new[] { "BTC_ETH", "BTC_KMD", "BTC_ENG" },
    ActiveSafetyOrdersCount = 2,
    BaseOrderVolume = 0.007m,
    SafetyOrderVolume = 0.014m,
    MartingaleStepCoefficient = 1m,
    MartingaleVolumeCoefficient = 1m,
    MinVolumeBtc24h = 100m,
    MaxActiveDeals = 1,
    ProfitCurrency = ProfitCurrency.QuoteCurrency,
    SafetyOrderStepPercentage = 2.5m,
    StartOrderType = StartOrderType.Limit,
    MaxSafetyOrders = 2,
    TakeProfitType = TakeProfitType.Total,
    TakeProfit = 1.5m,
    Name = "Updated",
    TrailingEnabled = false,
    Strategies = new BotStrategy[]
    {
        new CqsTelegramBotStrategy
        {
            
        },
    }.ToList(),
};

var response = await client.UpdateBot(botId, data);

DisableBot

var response = await client.DisableBotAsync(botId);

EnableBot

var response = await client.EnableBotAsync(botId);

StartNewDeal

var response = await client.StartNewDealAsync(botId);

DeleteBot

var response = await client.DeleteBotAsync(botId);

PanicSellAllBotDeals

var response = await client.PanicSellAllBotDealsAsync(botId);

CancelAllBotDeals

var response = await client.CancelAllBotDealsAsync(botId);

ShowBot

var response = await client.ShowBotAsync(botId);
var bot = response.Data;

Deals

This section covers the methods described in the official documentation here.

GetDeals

var response = await client.GetDealsAsync(limit: 60, dealScope: DealScope.Active, dealOrder: DealOrder.CreatedAt);

foreach (var deal in response.Data)
{
    //Do something with deal
    Console.WriteLine(deal.CurrentActiveSafetyOrdersCount);
}

UpdateMaxSafetyOrders

var response = await client.UpdateMaxSafetyOrdersAsync(dealId, 60);
var deal = response.Data;

AddFundsToDeal

var data = new DealAddFundsParameters
{
    Quantity = 1,
    IsMarket = false,
    Rate = 10000,
    DealId = 12345678
};

var response = await client.AddFundsToDealAsync(data);

PanicSellDeal

var response = await client.PanicSellDealAsync(dealId);

CancelDeal

var response = await client.CancelDealAsync(dealId);

ShowDeal

var response = await client.ShowDealAsync(dealId, 60);
var deal = response.Data;

Let's talk about crypto automation

If you have questions or comments, or just want to chat about all things related to automation and crypto, please join me here on telegram: https://t.me/cryptobotdevs