Skip to content

Commit f793a01

Browse files
JKorfJKorf
committed
Xml docs
1 parent 67d110d commit f793a01

4 files changed

Lines changed: 498 additions & 83 deletions

File tree

‎BitMEX.Net/Interfaces/Clients/ExchangeApi/IBitMEXRestClientExchangeApiAccount.cs‎

Lines changed: 126 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@ public interface IBitMEXRestClientExchangeApiAccount
1414
{
1515
/// <summary>
1616
/// Get user events
17-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/UserEvent/UserEvent_get" /></para>
17+
/// <para>
18+
/// Docs:<br />
19+
/// <a href="https://www.bitmex.com/api/explorer/#!/UserEvent/UserEvent_get" /><br />
20+
/// Endpoint:<br />
21+
/// GET /api/v1/userEvent
22+
/// </para>
1823
/// </summary>
1924
/// <param name="fromId">From id</param>
2025
/// <param name="limit">Max number of results</param>
@@ -24,23 +29,38 @@ public interface IBitMEXRestClientExchangeApiAccount
2429

2530
/// <summary>
2631
/// Get account info
27-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_get" /></para>
32+
/// <para>
33+
/// Docs:<br />
34+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_get" /><br />
35+
/// Endpoint:<br />
36+
/// GET /api/v1/user
37+
/// </para>
2838
/// </summary>
2939
/// <param name="ct">Cancellation token</param>
3040
/// <returns></returns>
3141
Task<WebCallResult<BitMEXAccountInfo>> GetAccountInfoAsync(CancellationToken ct = default);
3242

3343
/// <summary>
3444
/// Get user trading fees
35-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getCommission" /></para>
45+
/// <para>
46+
/// Docs:<br />
47+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getCommission" /><br />
48+
/// Endpoint:<br />
49+
/// GET /api/v1/user/commission
50+
/// </para>
3651
/// </summary>
3752
/// <param name="ct">Cancellation token</param>
3853
/// <returns></returns>
3954
Task<WebCallResult<Dictionary<string, BitMEXTradeFee>>> GetFeesAsync(CancellationToken ct = default);
4055

4156
/// <summary>
4257
/// Get deposit address
43-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getDepositAddress" /></para>
58+
/// <para>
59+
/// Docs:<br />
60+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getDepositAddress" /><br />
61+
/// Endpoint:<br />
62+
/// GET /api/v1/user/depositAddress
63+
/// </para>
4464
/// </summary>
4565
/// <param name="asset">Asset name</param>
4666
/// <param name="network">Network</param>
@@ -50,7 +70,12 @@ public interface IBitMEXRestClientExchangeApiAccount
5070

5171
/// <summary>
5272
/// Get user margin status
53-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getMargin" /></para>
73+
/// <para>
74+
/// Docs:<br />
75+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getMargin" /><br />
76+
/// Endpoint:<br />
77+
/// GET /api/v1/user/margin
78+
/// </para>
5479
/// </summary>
5580
/// <param name="symbol">Filter by symbol</param>
5681
/// <param name="ct">Cancellation token</param>
@@ -59,7 +84,12 @@ public interface IBitMEXRestClientExchangeApiAccount
5984

6085
/// <summary>
6186
/// Get user order quote fill ratio
62-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getQuoteFillRatio" /></para>
87+
/// <para>
88+
/// Docs:<br />
89+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getQuoteFillRatio" /><br />
90+
/// Endpoint:<br />
91+
/// GET /api/v1/user/quoteFillRatio
92+
/// </para>
6393
/// </summary>
6494
/// <param name="accountId">Account id</param>
6595
/// <param name="ct">Cancellation token</param>
@@ -68,7 +98,12 @@ public interface IBitMEXRestClientExchangeApiAccount
6898

6999
/// <summary>
70100
/// Get user order quote value ratio
71-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getQuoteValueRatio" /></para>
101+
/// <para>
102+
/// Docs:<br />
103+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getQuoteValueRatio" /><br />
104+
/// Endpoint:<br />
105+
/// GET /api/v1/user/quoteValueRatio
106+
/// </para>
72107
/// </summary>
73108
/// <param name="accountId">Account id</param>
74109
/// <param name="ct">Cancellation token</param>
@@ -77,15 +112,25 @@ public interface IBitMEXRestClientExchangeApiAccount
77112

78113
/// <summary>
79114
/// Get user 30 days average USD trading volume
80-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getTradingVolume" /></para>
115+
/// <para>
116+
/// Docs:<br />
117+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getTradingVolume" /><br />
118+
/// Endpoint:<br />
119+
/// GET /api/v1/user/tradingVolume
120+
/// </para>
81121
/// </summary>
82122
/// <param name="ct">Cancellation token</param>
83123
/// <returns></returns>
84124
Task<WebCallResult<BitMEXUsdVolume[]>> GetTradingVolumeAsync(CancellationToken ct = default);
85125

86126
/// <summary>
87127
/// Get user balances
88-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getWallet" /></para>
128+
/// <para>
129+
/// Docs:<br />
130+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getWallet" /><br />
131+
/// Endpoint:<br />
132+
/// GET /api/v1/user/wallet
133+
/// </para>
89134
/// </summary>
90135
/// <param name="asset">Filter by asset</param>
91136
/// <param name="ct">Cancellation token</param>
@@ -94,7 +139,12 @@ public interface IBitMEXRestClientExchangeApiAccount
94139

95140
/// <summary>
96141
/// Get balance history
97-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getWalletHistory" /></para>
142+
/// <para>
143+
/// Docs:<br />
144+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getWalletHistory" /><br />
145+
/// Endpoint:<br />
146+
/// GET /api/v1/user/walletHistory
147+
/// </para>
98148
/// </summary>
99149
/// <param name="asset">Filter by asset</param>
100150
/// <param name="targetAccountId">Filter by account id</param>
@@ -112,7 +162,12 @@ Task<WebCallResult<BitMEXTransaction[]>> GetBalanceHistoryAsync(string? asset =
112162

113163
/// <summary>
114164
/// Get wallet summary
115-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_getWalletSummary" /></para>
165+
/// <para>
166+
/// Docs:<br />
167+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_getWalletSummary" /><br />
168+
/// Endpoint:<br />
169+
/// GET /api/v1/user/walletSummary
170+
/// </para>
116171
/// </summary>
117172
/// <param name="asset">Filter by asset</param>
118173
/// <param name="startTime">Filter by start time</param>
@@ -122,7 +177,12 @@ Task<WebCallResult<BitMEXTransaction[]>> GetBalanceHistoryAsync(string? asset =
122177

123178
/// <summary>
124179
/// Transfer funds between accounts
125-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_walletTransfer" /></para>
180+
/// <para>
181+
/// Docs:<br />
182+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_walletTransfer" /><br />
183+
/// Endpoint:<br />
184+
/// POST /api/v1/user/walletSummary
185+
/// </para>
126186
/// </summary>
127187
/// <param name="asset">Asset</param>
128188
/// <param name="fromAccountId">From account id</param>
@@ -133,7 +193,12 @@ Task<WebCallResult<BitMEXTransaction[]>> GetBalanceHistoryAsync(string? asset =
133193

134194
/// <summary>
135195
/// Create a new withdrawal request
136-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_requestWithdrawal" /></para>
196+
/// <para>
197+
/// Docs:<br />
198+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_requestWithdrawal" /><br />
199+
/// Endpoint:<br />
200+
/// POST /api/v1/user/requestWithdrawal
201+
/// </para>
137202
/// </summary>
138203
/// <param name="asset">Asset</param>
139204
/// <param name="network">Network</param>
@@ -162,7 +227,12 @@ Task<WebCallResult<BitMEXTransaction>> WithdrawAsync(
162227

163228
/// <summary>
164229
/// Cancel a pending withdrawal request
165-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/User/User_cancelPendingWithdrawal" /></para>
230+
/// <para>
231+
/// Docs:<br />
232+
/// <a href="https://www.bitmex.com/api/explorer/#!/User/User_cancelPendingWithdrawal" /><br />
233+
/// Endpoint:<br />
234+
/// DELETE /api/v1/user/withdrawal
235+
/// </para>
166236
/// </summary>
167237
/// <param name="transactId">Transaction id</param>
168238
/// <param name="ct">Cancellation token</param>
@@ -171,7 +241,12 @@ Task<WebCallResult<BitMEXTransaction>> WithdrawAsync(
171241

172242
/// <summary>
173243
/// Set isolated margin enabled for a symbol
174-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/Position/Position_isolateMargin" /></para>
244+
/// <para>
245+
/// Docs:<br />
246+
/// <a href="https://www.bitmex.com/api/explorer/#!/Position/Position_isolateMargin" /><br />
247+
/// Endpoint:<br />
248+
/// POST /api/v1/position/isolate
249+
/// </para>
175250
/// </summary>
176251
/// <param name="symbol">Symbol</param>
177252
/// <param name="isolatedMarginEnabled">Isolated margin enabled</param>
@@ -181,7 +256,12 @@ Task<WebCallResult<BitMEXTransaction>> WithdrawAsync(
181256

182257
/// <summary>
183258
/// Update risk limit for a position
184-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/Position/Position_updateRiskLimit" /></para>
259+
/// <para>
260+
/// Docs:<br />
261+
/// <a href="https://www.bitmex.com/api/explorer/#!/Position/Position_updateRiskLimit" /><br />
262+
/// Endpoint:<br />
263+
/// POST /api/v1/position/riskLimit
264+
/// </para>
185265
/// </summary>
186266
/// <param name="symbol">Symbol</param>
187267
/// <param name="riskLimit">Risk limit</param>
@@ -192,7 +272,12 @@ Task<WebCallResult<BitMEXTransaction>> WithdrawAsync(
192272

193273
/// <summary>
194274
/// Add or remove margin to an isolated margin position
195-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/Position/Position_transferIsolatedMargin" /></para>
275+
/// <para>
276+
/// Docs:<br />
277+
/// <a href="https://www.bitmex.com/api/explorer/#!/Position/Position_transferIsolatedMargin" /><br />
278+
/// Endpoint:<br />
279+
/// POST /api/v1/position/transferMargin
280+
/// </para>
196281
/// </summary>
197282
/// <param name="symbol">Symbol</param>
198283
/// <param name="quantity">Quantity to add or remove</param>
@@ -203,15 +288,25 @@ Task<WebCallResult<BitMEXTransaction>> WithdrawAsync(
203288

204289
/// <summary>
205290
/// Get saved addresses
206-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/Address/Address_get" /></para>
291+
/// <para>
292+
/// Docs:<br />
293+
/// <a href="https://www.bitmex.com/api/explorer/#!/Address/Address_get" /><br />
294+
/// Endpoint:<br />
295+
/// GET /api/v1/address
296+
/// </para>
207297
/// </summary>
208298
/// <param name="ct">Cancellation token</param>
209299
/// <returns></returns>
210300
Task<WebCallResult<BitMEXAddress[]>> GetSavedAddressesAsync(CancellationToken ct = default);
211301

212302
/// <summary>
213303
/// Add a saved address
214-
/// <para><a href="https://www.bitmex.com/api/explorer/#!/Address/Address_new" /></para>
304+
/// <para>
305+
/// Docs:<br />
306+
/// <a href="https://www.bitmex.com/api/explorer/#!/Address/Address_new" /><br />
307+
/// Endpoint:<br />
308+
/// POST /api/v1/address
309+
/// </para>
215310
/// </summary>
216311
/// <param name="currency">Currency which the asset is for</param>
217312
/// <param name="network">Network of the address</param>
@@ -238,15 +333,25 @@ Task<WebCallResult<BitMEXAddress>> AddSavedAddressAsync(
238333

239334
/// <summary>
240335
/// Get address book config
241-
/// <para><a href="https://www.bitmex.com/api/explorer/#/AddressConfig" /></para>
336+
/// <para>
337+
/// Docs:<br />
338+
/// <a href="https://www.bitmex.com/api/explorer/#/AddressConfig" /><br />
339+
/// Endpoint:<br />
340+
/// GET /api/v1/addressConfig
341+
/// </para>
242342
/// </summary>
243343
/// <param name="ct">Cancellation token</param>
244344
/// <returns></returns>
245345
Task<WebCallResult<BitMEXAddressBookConfig>> GetAddressBookSettingsAsync(CancellationToken ct = default);
246346

247347
/// <summary>
248348
/// Get API key info
249-
/// <para><a href="https://www.bitmex.com/api/explorer/#/APIKey" /></para>
349+
/// <para>
350+
/// Docs:<br />
351+
/// <a href="https://www.bitmex.com/api/explorer/#/APIKey" /><br />
352+
/// Endpoint:<br />
353+
/// GET /api/v1/apiKey
354+
/// </para>
250355
/// </summary>
251356
/// <param name="ct">Cancellation token</param>
252357
/// <returns></returns>

0 commit comments

Comments
 (0)