Skip to content

Commit e75014e

Browse files
morpheumsmorpheums
committed
Adding methods documentation and renaming some variables.
1 parent 6752c4e commit e75014e

File tree

9 files changed

+492
-22
lines changed

9 files changed

+492
-22
lines changed

‎Cobinhood.API.Csharp.Client.Test/CobinhoodChartTest.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using Microsoft.VisualStudio.TestTools.UnitTesting;
1+
using Cobinhood.API.Csharp.Client.Models.Enums;
2+
using Microsoft.VisualStudio.TestTools.UnitTesting;
23
using System.Configuration;
34

45
namespace Cobinhood.API.Csharp.Client.Test
@@ -13,7 +14,7 @@ public class CobinhoodChartTest
1314
[TestMethod]
1415
public void TestGetCandles()
1516
{
16-
var candles = cobinhoodClient.GetCandles("ETH","BTC", Models.Enums.Timeframe.TIMEFRAME_15_MINUTES).Result;
17+
var candles = cobinhoodClient.GetCandles("ETH","BTC", Timeframe.TIMEFRAME_15_MINUTES).Result;
1718
Assert.AreEqual(candles.Success, true);
1819
}
1920
}

‎Cobinhood.API.Csharp.Client.Test/CobinhoodTradingTest.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ public void TestCancelOrder()
7777
[TestMethod]
7878
public void TestGetOrderHistory()
7979
{
80-
var result = cobinhoodClient.GetOrderHistory("ETH", "BTC").Result;
81-
Assert.AreEqual(result.Success, true);
80+
var orderHistory = cobinhoodClient.GetOrderHistory("ETH", "BTC").Result;
81+
Assert.AreEqual(orderHistory.Success, true);
8282
}
8383

8484
[TestMethod]
@@ -91,8 +91,8 @@ public void TestGetTrade()
9191
[TestMethod]
9292
public void TestGetTradeHistory()
9393
{
94-
var result = cobinhoodClient.GetTradeHistory("ETH", "BTC").Result;
95-
Assert.AreEqual(result.Success, true);
94+
var tradeHistory = cobinhoodClient.GetTradeHistory("ETH", "BTC").Result;
95+
Assert.AreEqual(tradeHistory.Success, true);
9696
}
9797
}
9898
}

‎Cobinhood.API.Csharp.Client.Test/CobinhoodWalletTest.cs‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,57 +13,57 @@ public class CobinhoodWalletTest
1313
[TestMethod]
1414
public void TestGetWalletBalances()
1515
{
16-
var result = cobinhoodClient.GetWalletBalances().Result;
17-
Assert.AreEqual(result.Success, true);
16+
var walletBalances = cobinhoodClient.GetWalletBalances().Result;
17+
Assert.AreEqual(walletBalances.Success, true);
1818
}
1919

2020
[TestMethod]
2121
public void TestGetLedgerEntries()
2222
{
23-
var result = cobinhoodClient.GetLedgerEntries("ETH").Result;
24-
Assert.AreEqual(result.Success, true);
23+
var ledgerEntries = cobinhoodClient.GetLedgerEntries("ETH").Result;
24+
Assert.AreEqual(ledgerEntries.Success, true);
2525
}
2626

2727
[TestMethod]
2828
public void TestGetDepositAddresses()
2929
{
30-
var result = cobinhoodClient.GetDepositAddresses().Result;
31-
Assert.AreEqual(result.Success, true);
30+
var depositAddrresses = cobinhoodClient.GetDepositAddresses().Result;
31+
Assert.AreEqual(depositAddrresses.Success, true);
3232
}
3333

3434
[TestMethod]
3535
public void TestGetWithdrawalAddresses()
3636
{
37-
var result = cobinhoodClient.GetWithdrawalAddresses("ETH").Result;
38-
Assert.AreEqual(result.Success, true);
37+
var withdrawalAddresses = cobinhoodClient.GetWithdrawalAddresses("ETH").Result;
38+
Assert.AreEqual(withdrawalAddresses.Success, true);
3939
}
4040

4141
[TestMethod]
4242
public void TestGetWithdrawal()
4343
{
44-
var result = cobinhoodClient.GetWithdrawal("62056df2d4cf8fb9b15c7238b89a1438").Result;
45-
Assert.AreEqual(result.Success, true);
44+
var withdrawalInfo = cobinhoodClient.GetWithdrawal("62056df2d4cf8fb9b15c7238b89a1438").Result;
45+
Assert.AreEqual(withdrawalInfo.Success, true);
4646
}
4747

4848
[TestMethod]
4949
public void TestGetAllWithdrawals()
5050
{
51-
var result = cobinhoodClient.GetAllWithdrawals("ETH").Result;
52-
Assert.AreEqual(result.Success, true);
51+
var withdrawalsInfo = cobinhoodClient.GetAllWithdrawals("ETH").Result;
52+
Assert.AreEqual(withdrawalsInfo.Success, true);
5353
}
5454

5555
[TestMethod]
5656
public void TestGetDeposit()
5757
{
58-
var result = cobinhoodClient.GetDeposit("00227f3d-02d7-47cb-8cbc-7768ee04815f").Result;
59-
Assert.AreEqual(result.Success, true);
58+
var depositInfo = cobinhoodClient.GetDeposit("00227f3d-02d7-47cb-8cbc-7768ee04815f").Result;
59+
Assert.AreEqual(depositInfo.Success, true);
6060
}
6161

6262
[TestMethod]
6363
public void TestGetAllDeposits()
6464
{
65-
var result = cobinhoodClient.GetAllDeposits().Result;
66-
Assert.AreEqual(result.Success, true);
65+
var depositsInfo = cobinhoodClient.GetAllDeposits().Result;
66+
Assert.AreEqual(depositsInfo.Success, true);
6767
}
6868
}
6969
}

‎Documentation/ChartMethods.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Chart Methods
2+
## Get Candles
3+
Get charting candles.
4+
### Example:
5+
6+
```c#
7+
var candles = cobinhoodClient.GetCandles("ETH","BTC", Timeframe.TIMEFRAME_15_MINUTES).Result;
8+
```
9+
### Method Signature:
10+
11+
```c#
12+
public async Task<CandlesInfo> GetCandles(string quoteSymbol, string baseSymbol, Timeframe timeframe, DateTime? startTime = null, DateTime? endTime = null)
13+
```

‎Documentation/MarketMethods.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Market Methods
2+
## Get All Currencies
3+
Returns info for all currencies available for trade.
4+
### Example:
5+
6+
```c#
7+
var currencies = cobinhoodClient.GetAllCurrencies().Result;
8+
```
9+
### Method Signature:
10+
11+
```c#
12+
public async Task<CurrenciesInfo> GetAllCurrencies()
13+
```
14+
15+
## Get All Trading Pairs
16+
Get info for all trading pairs.
17+
### Example:
18+
19+
```c#
20+
var trandingPairs = cobinhoodClient.GetAllTradingPairs().Result;
21+
```
22+
### Method Signature:
23+
24+
```c#
25+
public async Task<TradingPairsInfo> GetAllTradingPairs()
26+
```
27+
28+
## Get Order Book
29+
Get order book for the trading pair containing all asks/bids.
30+
### Example:
31+
32+
```c#
33+
var orderBook = cobinhoodClient.GetOrderBook("ETH", "BTC").Result;
34+
```
35+
### Method Signature:
36+
37+
```c#
38+
public async Task<OrderBookInfo> GetOrderBook(string quoteSymbol, string baseSymbol)
39+
```
40+
41+
## Get Trading Statistics
42+
Gets Trading Statistics.
43+
### Example:
44+
45+
```c#
46+
var tradingStatics = cobinhoodClient.GetTradingStatics().Result;
47+
```
48+
### Method Signature:
49+
50+
```c#
51+
public async Task<TradingStaticsInfo> GetTradingStatics()
52+
```
53+
54+
## Get Ticker
55+
Returns ticker for specified trading pair.
56+
### Example:
57+
58+
```c#
59+
var ticker = cobinhoodClient.GetTicker("ETH", "BTC").Result;
60+
```
61+
### Method Signature:
62+
63+
```c#
64+
public async Task<TickerInfo> GetTicker(string quoteSymbol, string baseSymbol)
65+
```
66+
67+
## Get Recent Trades
68+
Returns most recent trades for the specified trading pair.
69+
### Example:
70+
71+
```c#
72+
var recentTrades = cobinhoodClient.GetRecentTrades("ETH", "BTC").Result;
73+
```
74+
### Method Signature:
75+
76+
```c#
77+
public async Task<RecentTradesInfo> GetRecentTrades(string quoteSymbol, string baseSymbol)
78+
```

‎Documentation/SystemMethods.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# System Methods
2+
## Get System Time
3+
Get the reference system time as Unix timestamp.
4+
### Example:
5+
6+
```c#
7+
var systemTime = cobinhoodClient.GetSystemTime().Result;
8+
```
9+
### Method Signature:
10+
11+
```c#
12+
public async Task<SystemTime> GetSystemTime()
13+
```
14+
15+
## Get System Information
16+
Gets system information.
17+
### Example:
18+
19+
```c#
20+
var systemInfo = cobinhoodClient.GetSystemInformation().Result;
21+
```
22+
### Method Signature:
23+
24+
```c#
25+
public async Task<SystemInformation> GetSystemInformation()
26+
```

‎Documentation/TradingMethods.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Trading Methods
2+
## Get Order
3+
Get information for a single order.
4+
### Example:
5+
6+
```c#
7+
var order = cobinhoodClient.GetOrder("6142677c-c211-40e2-bf44-ca96884120eb").Result;
8+
```
9+
### Method Signature:
10+
11+
```c#
12+
public async Task<OrderInfo> GetOrder(string orderId)
13+
```
14+
15+
## Get Trades of An Order
16+
Get all trades originating from the specific order.
17+
### Example:
18+
19+
```c#
20+
var orderTrades = cobinhoodClient.GetOrderTrades("6142677c-c211-40e2-bf44-ca96884120eb").Result;
21+
```
22+
### Method Signature:
23+
24+
```c#
25+
public async Task<OrderTradesInfo> GetOrderTrades(string orderId)
26+
```
27+
28+
## Get All Orders
29+
List all current orders for user.
30+
### Example:
31+
32+
```c#
33+
var orders = cobinhoodClient.GetAllOrders().Result;
34+
```
35+
### Method Signature:
36+
37+
```c#
38+
public async Task<AllOrdersInfo> GetAllOrders(string quoteSymbol = "", string baseSymbol = "", int? limit = null, int? page = null)
39+
```
40+
41+
## Place Order
42+
Place orders to ask or bid.
43+
### Example:
44+
45+
Post new order (LIMIT)
46+
```c#
47+
var buyOrder = cobinhoodClient.PlaceOrder("COB", "BTC", OrderSide.Bid, OrderType.Limit, "200", "0.000022").Result;
48+
var sellOrder = cobinhoodClient.PlaceOrder("COB", "BTC", OrderSide.Ask, OrderType.Limit, "200", "0.000030").Result;
49+
```
50+
Post new order (MARKET)
51+
```c#
52+
var buyOrder = cobinhoodClient.PlaceOrder("COB", "ETH", OrderSide.Bid, OrderType.Market, "1000").Result;
53+
var sellOrder = cobinhoodClient.PlaceOrder("ETH", "BTC", OrderSide.Ask, OrderType.Market, "0.048").Result;
54+
```
55+
### Method Signature:
56+
57+
```c#
58+
public async Task<PlacedOrderInfo> PlaceOrder(string quoteSymbol, string baseSymbol, OrderSide orderSide, OrderType orderType, string size, string price = "")
59+
```
60+
61+
## Modify Order
62+
Modify a single order.
63+
### Example:
64+
65+
```c#
66+
var result = cobinhoodClient.ModifyOrder("1d193afc-0c81-4e1e-b338-37be7f2270d6", "0.0000600", "200").Result;
67+
```
68+
### Method Signature:
69+
70+
```c#
71+
public async Task<Result> ModifyOrder(string orderId, string price, string size)
72+
```
73+
74+
## Cancel Order
75+
Cancel a single order.
76+
### Example:
77+
78+
```c#
79+
var result = cobinhoodClient.CancelOrder("f29922c5-918d-4bcd-9d0a-5d646078bd27").Result;
80+
```
81+
### Method Signature:
82+
83+
```c#
84+
public async Task<Result> CancelOrder(string orderId)
85+
```
86+
87+
## Get Order History
88+
Returns order history for the current user.
89+
### Example:
90+
91+
```c#
92+
var orderHistory = cobinhoodClient.GetOrderHistory("ETH", "BTC").Result;
93+
```
94+
### Method Signature:
95+
96+
```c#
97+
public async Task<OrderHistoryInfo> GetOrderHistory(string quoteSymbol = "", string baseSymbol = "", int? limit = null, int? page = null)
98+
```
99+
100+
## Get Trade
101+
Get trade information. A user only can get their own trade.
102+
### Example:
103+
104+
```c#
105+
var trade = cobinhoodClient.GetTrade("2051e763-3d16-4aa3-831d-af6a0f92b84a").Result;
106+
```
107+
### Method Signature:
108+
109+
```c#
110+
public async Task<TradeInfo> GetTrade(string tradeId)
111+
```
112+
113+
## Get Trade History
114+
Returns trade history for the current user.
115+
### Example:
116+
117+
```c#
118+
var tradeHistory = cobinhoodClient.GetTradeHistory("ETH", "BTC").Result;
119+
```
120+
### Method Signature:
121+
122+
```c#
123+
public async Task<TradeHistoryInfo> GetTradeHistory(string quoteSymbol, string baseSymbol, int? limit = null, int? page = null)
124+
```

0 commit comments

Comments
 (0)