gdax-csharp

GDAX API C# Client Library - https://docs.gdax.com/

How to Install

PM> Install-Package GDAX.Api.ClientLibrary

How to Use

Generate your key at https://www.gdax.com/settings/api

//create an authenticator with your apiKey, apiSecret and passphrase
var authenticator = new Authenticator("<apiKey>", "<apiSecret>", "<passphrase>");

//create the GDAX client
var gdaxClient = new GDAXSharp.GDAXClient(authenticator);

//use one of the services 
var allAccounts = await gdaxClient.AccountsService.GetAllAccountsAsync();

What services are provided?

Accounts

• GetAllAccountsAsync() - get all accounts
• GetAccountByIdAsync(id) - get account by id
• GetAccountHistoryAsync(id, limit, numberOfPages) - get account history (paged response)
• GetAccountHoldsAsync(id, limit, numberOfPages) - get all holds placed on an account (paged response)

CoinbaseAccounts

• GetAllAccountsAsync() - get all coinbase accounts

Orders

• PlaceMarketOrderAsync(orderSide, productPair, size, clientOId) - place market order
• PlaceLimitOrderAsync(orderSide, productPair, size, price, timeInForce, postOnly, clientOId) - place limit order with time in force
• PlaceLimitOrderAsync(orderSide, productPair, size, price, cancelAfter, postOnly, clientOId) - place limit order with cancel after date
• PlaceStopOrderAsync(orderSide, productPair, size, stopPrice, clientOId) - place stop order with stop price
• CancelAllOrdersAsync() - cancel all orders
• CancelOrderByIdAsync(id) - cancel order by id
• GetAllOrdersAsync(orderStatus, limit, numberOfPages) - get all, active or pending orders (paged response)
• GetOrderByIdAsync(id) - get order by id

Payments

• GetAllPaymentMethodsAsync() - get all payment methods

Withdrawals

• WithdrawFundsAsync(paymentMethodId, amount, currency) - withdraw funds to a payment method
• WithdrawToCoinbaseAsync(coinbaseAccountId, amount, currency) - withdraw funds to a coinbase account
• WithdrawToCryptoAsync(cryptoAddress, amount, currency) - withdraw funds to a crypto address

Deposits

• DepositFundsAsync(paymentMethodId, amount, currency) - deposits funds from a payment method
• DepositCoinbaseFundsAsync(coinbaseAccountId, amount, currency) - deposits funds from a coinbase account

Products

• GetAllProductsAsync() - get a list of available currency pairs for trading
• GetProductOrderBookAsync(productType, productLevel) - get a list of open orders for a product (specify level 1, 2, or 3)
• GetProductTickerAsync(productType) - get information about the last trade (tick), best bid/ask and 24h volume
• GetTradesAsync(productType, limit, numberOfPages) - get latest trades for a product (paged response)
• GetProductStatsAsync(productType) - get 24 hour stats for a product
• GetHistoricRatesAsync(productPair, start, end, granularity) - get historic rates for a product, auto batches requests to pull complete date range

Currencies

• GetAllCurrenciesAsync() - gets a list of known currencies

Fills

• GetAllFillsAsync(limit, numberOfPages) - gets a list of all recent fills (paged response)
• GetFillsByOrderIdAsync(orderId, limit, numberOfPages) - gets a list of all recent fills by order id (paged response)
• GetFillsByProductIdAsync(productType, limit, numberOfPages) - gets a list of all recent fills by product type (paged response)

Fundings

• GetAllFundingsAsync(limit, fundingStatus, numberOfPages) - gets a list of all orders placed with a margin profile that draws funding (paged response)

Reports

• CreateNewAccountReportAsync(startDate, endDate, accountId, productType, email, fileFormat) - generate new account report
• CreateNewFillsReportAsync(startDate, endDate, productType, accountId, email, fileFormat) - generate new fills report

User Account

• GetTrailingVolumeAsync() - get 30-day trailing volume for all products

WebSocket Feed

How to use

//create an authenticator with your apiKey, apiSecret and passphrase
var authenticator = new Authenticator("<apiKey>", "<apiSecret>", "<passphrase>");

//create the GDAX client
var gdaxClient = new GDAXSharp.GDAXClient(authenticator);

//use the websocket feed
var productTypes = new List<ProductType>() { ProductType.BtcEur, ProductType.BtcUsd };
var channels = new List<ChannelType>() {ChannelType.Full, ChannelType.User} // When not providing any channels, the socket will subscribe to all channels

var webSocket = gdaxClient.WebSocket;
webSocket.Start(productTypes, channels);

// EventHandler for the heartbeat response type
webSocket.OnHeartbeatReceived += WebSocket_OnHeartbeatReceived;

private static void WebSocket_OnHeartbeatReceived(object sender, WebfeedEventArgs<Heartbeat> e)
{
  throw new NotImplementedException();
}

Available functions

These are the starting and stopping methods:

• Start(productTypes, channelTypes) - Starts the websocket feed based on product(s) and channel(s)
• Stop() - Stops the websocket feed

The following methods are EventHandlers:

• OnTickerReceived - EventHandler for data with response type ticker
• OnSnapShotReceived - EventHandler for data with response type snapshot
• OnLevel2UpdateReceived - EventHandler for data with response type level2
• OnHeartbeatReceived - EventHandler for data with response type heartbeat
• OnReceivedReceived - EventHandler for data with response type received
• OnOpenReceived - EventHandler for data with response type open
• OnDoneReceived - EventHandler for data with response type done
• OnMatchReceived - EventHandler for data with response type match
• OnLastMatchReceived - EventHandler for data with response type last match
• OnErrorReceived - EventHandler for data with response type error

Sandbox Support

Generate your key at https://public.sandbox.gdax.com/settings/api

//create an authenticator with your apiKey, signature and passphrase
var authenticator = new Authenticator("<apiKey>", "<signature>", "<passphrase>");

//create the GDAX client and set the sandbox flag to true
var gdaxClient = new GDAXClient(authenticator, true);

//use one of the services 
var response = await gdaxClient.OrdersService.PlaceMarketOrderAsync(OrderSide.Buy, ProductType.BtcUsd, 1);

Examples

Place a market order

var response = await gdaxClient.OrdersService.PlaceMarketOrderAsync(OrderSide.Buy, ProductType.BtcUsd, 1);

Place a limit order

var response = await gdaxClient.OrdersService.PlaceLimitOrderAsync(OrderSide.Sell, ProductType.EthUsd, 1, 400.0M);

Cancel all open or un-settled orders

var response = await gdaxClient.OrdersService.CancelAllOrdersAsync();

Getting account history (paged response)

//the limit is the amount of items per page - in this case it would be 2 items (default is 100)
//you can also specify the number of pages to request - in this case it would be the first 5 pages (default is 0 which will request all pages)
//some routes may require the number of pages to be specified as there are rate limits
var accountHistoryResponse = await gdaxClient.AccountsService.GetAccountHistoryAsync("ef56a389", 2, 5);

//retrieve by page number - this would return the first page of the response (latest first)
var firstPage = accountHistoryResponse.ToList()[0];

//get the first item on the page
var firstAccountHistoryOnFirstPage = firstPage.ToList()[0];

//get the second item on the page
var secondAccountHistoryOnFirstPage = firstPage.ToList()[1];

Generate and email a report

var reportDateFrom = new DateTime(2017, 1, 1);
var reportDateTo = new DateTime(2018, 1, 1);
var accountId = "29318029382";

//generate and email accounts report csv
var accountResponse = gdaxClient.ReportsService.CreateNewAccountReportAsync(reportDateFrom, reportDateTo, accountId, ProductType.BtcUsd, "[email protected]", FileFormat.Csv);

//generate and email fills report pdf
var fillsResponse = gdaxClient.ReportsService.CreateNewFillsReportAsync(reportDateFrom, reportDateTo, ProductType.BtcUsd, accountId, "[email protected]", FileFormat.Pdf);

Overriding the HttpClient behavior

You can gain greater control of the http requests by implementing GDAXSharp.HttpClient.IHttpClient and passing that into the GDAXClient constructor.

var myWay = new MyNamespace.MyHttpClient();

//create an authenticator with your apiKey, signature and passphrase
var authenticator = new Authenticator("<apiKey>", "<signature>", "<passphrase>");

//create the GDAX client and set the httpClient to my way of behaving
var gdaxClient = new GDAXClient(authenticator, myWay);

Contributors

Thanks for contributing!

• @dgelineau
• @quin810
• @DontFretBrett
• @chrisw000
• @confessore
• @sotam
• @BradForsythe

Bugs or questions?

Please open an issue for any bugs or questions