Skip to content

Commit e39f360

Browse files
f3rnof3rno
authoredSep 1, 2018
Merge pull request #386 from ezeswci/all-opts-to-funding
Add all option for offers, loans and credits history
·
v7.0.04.0.2
2 parents 542e574 + fd4899d commit e39f360

File tree

3 files changed

+101
-90
lines changed

3 files changed

+101
-90
lines changed
 

‎doc/rest2.md

+80-81
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ See _makePublicLegacyRequest
9898

9999
| Param | Type |
100100
| --- | --- |
101-
| method | <code>string</code> |
102-
| params | <code>Object</code> |
103-
| cb | <code>Method</code> |
101+
| method | <code>string</code> |
102+
| params | <code>Object</code> |
103+
| cb | <code>Method</code> |
104104

105105
<a name="RESTv2+status"></a>
106106

@@ -111,7 +111,7 @@ See _makePublicLegacyRequest
111111

112112
| Param | Type |
113113
| --- | --- |
114-
| cb | <code>Method</code> |
114+
| cb | <code>Method</code> |
115115

116116
<a name="RESTv2+ticker"></a>
117117

@@ -122,8 +122,8 @@ See _makePublicLegacyRequest
122122

123123
| Param | Type | Default |
124124
| --- | --- | --- |
125-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
126-
| cb | <code>Method</code> | |
125+
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
126+
| cb | <code>Method</code> | |
127127

128128
<a name="RESTv2+tickers"></a>
129129

@@ -134,8 +134,8 @@ See _makePublicLegacyRequest
134134

135135
| Param | Type |
136136
| --- | --- |
137-
| symbols | <code>Array.&lt;string&gt;</code> |
138-
| cb | <code>Method</code> |
137+
| symbols | <code>Array.&lt;string&gt;</code> |
138+
| cb | <code>Method</code> |
139139

140140
<a name="RESTv2+stats"></a>
141141

@@ -146,9 +146,9 @@ See _makePublicLegacyRequest
146146

147147
| Param | Type | Default |
148148
| --- | --- | --- |
149-
| key | <code>string</code> | <code>&quot;pos.size:1m:tBTCUSD:long&quot;</code> |
150-
| context | <code>string</code> | <code>&quot;hist&quot;</code> |
151-
| cb | <code>Method</code> | |
149+
| key | <code>string</code> | <code>&quot;pos.size:1m:tBTCUSD:long&quot;</code> |
150+
| context | <code>string</code> | <code>&quot;hist&quot;</code> |
151+
| cb | <code>Method</code> | |
152152

153153
<a name="RESTv2+candles"></a>
154154

@@ -174,8 +174,8 @@ See _makePublicLegacyRequest
174174

175175
| Param | Type | Default |
176176
| --- | --- | --- |
177-
| type | <code>string</code> | <code>&quot;price&quot;</code> |
178-
| cb | <code>Method</code> | |
177+
| type | <code>string</code> | <code>&quot;price&quot;</code> |
178+
| cb | <code>Method</code> | |
179179

180180
<a name="RESTv2+alertSet"></a>
181181

@@ -186,9 +186,9 @@ See _makePublicLegacyRequest
186186

187187
| Param | Type | Default |
188188
| --- | --- | --- |
189-
| type | <code>string</code> | <code>&quot;price&quot;</code> |
190-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
191-
| price | <code>number</code> | <code>0</code> |
189+
| type | <code>string</code> | <code>&quot;price&quot;</code> |
190+
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
191+
| price | <code>number</code> | <code>0</code> |
192192

193193
<a name="RESTv2+alertDelete"></a>
194194

@@ -199,8 +199,8 @@ See _makePublicLegacyRequest
199199

200200
| Param | Type | Default |
201201
| --- | --- | --- |
202-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
203-
| price | <code>number</code> | <code>0</code> |
202+
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
203+
| price | <code>number</code> | <code>0</code> |
204204

205205
<a name="RESTv2+trades"></a>
206206

@@ -254,7 +254,7 @@ See _makePublicLegacyRequest
254254

255255
| Param | Type |
256256
| --- | --- |
257-
| cb | <code>Method</code> |
257+
| cb | <code>Method</code> |
258258

259259
<a name="RESTv2+activeOrders"></a>
260260

@@ -265,7 +265,7 @@ See _makePublicLegacyRequest
265265

266266
| Param | Type |
267267
| --- | --- |
268-
| cb | <code>Method</code> |
268+
| cb | <code>Method</code> |
269269

270270
<a name="RESTv2+movements"></a>
271271

@@ -321,12 +321,12 @@ See _makePublicLegacyRequest
321321

322322
| Param | Type | Default |
323323
| --- | --- | --- |
324-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
325-
| start | <code>number</code> | <code></code> |
326-
| end | <code>number</code> | <code></code> |
327-
| limit | <code>number</code> | <code></code> |
328-
| orderID | <code>number</code> | |
329-
| cb | <code>Method</code> | |
324+
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
325+
| start | <code>number</code> | <code></code> |
326+
| end | <code>number</code> | <code></code> |
327+
| limit | <code>number</code> | <code></code> |
328+
| orderID | <code>number</code> | |
329+
| cb | <code>Method</code> | |
330330

331331
<a name="RESTv2+positions"></a>
332332

@@ -337,7 +337,7 @@ See _makePublicLegacyRequest
337337

338338
| Param | Type |
339339
| --- | --- |
340-
| cb | <code>Method</code> |
340+
| cb | <code>Method</code> |
341341

342342
<a name="RESTv2+fundingOffers"></a>
343343

@@ -348,8 +348,8 @@ See _makePublicLegacyRequest
348348

349349
| Param | Type | Default |
350350
| --- | --- | --- |
351-
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
352-
| cb | <code>Method</code> | |
351+
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
352+
| cb | <code>Method</code> | |
353353

354354
<a name="RESTv2+fundingOfferHistory"></a>
355355

@@ -360,11 +360,11 @@ See _makePublicLegacyRequest
360360

361361
| Param | Type | Default |
362362
| --- | --- | --- |
363-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
364-
| start | <code>number</code> | <code></code> |
365-
| end | <code>number</code> | <code></code> |
366-
| limit | <code>number</code> | <code></code> |
367-
| cb | <code>Method</code> | |
363+
| symbol | <code>string</code> | optional, omit/leave empty for all |
364+
| start | <code>number</code> | <code></code> |
365+
| end | <code>number</code> | <code></code> |
366+
| limit | <code>number</code> | <code></code> |
367+
| cb | <code>Method</code> | |
368368

369369
<a name="RESTv2+fundingLoans"></a>
370370

@@ -375,8 +375,8 @@ See _makePublicLegacyRequest
375375

376376
| Param | Type | Default |
377377
| --- | --- | --- |
378-
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
379-
| cb | <code>Method</code> | |
378+
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
379+
| cb | <code>Method</code> | |
380380

381381
<a name="RESTv2+fundingLoanHistory"></a>
382382

@@ -387,11 +387,11 @@ See _makePublicLegacyRequest
387387

388388
| Param | Type | Default |
389389
| --- | --- | --- |
390-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
391-
| start | <code>number</code> | <code></code> |
392-
| end | <code>number</code> | <code></code> |
393-
| limit | <code>number</code> | <code></code> |
394-
| cb | <code>Method</code> | |
390+
| symbol | <code>string</code> | optional, omit/leave empty for all |
391+
| start | <code>number</code> | <code></code> |
392+
| end | <code>number</code> | <code></code> |
393+
| limit | <code>number</code> | <code></code> |
394+
| cb | <code>Method</code> | |
395395

396396
<a name="RESTv2+fundingCredits"></a>
397397

@@ -402,8 +402,8 @@ See _makePublicLegacyRequest
402402

403403
| Param | Type | Default |
404404
| --- | --- | --- |
405-
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
406-
| cb | <code>Method</code> | |
405+
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
406+
| cb | <code>Method</code> | |
407407

408408
<a name="RESTv2+fundingCreditHistory"></a>
409409

@@ -414,11 +414,11 @@ See _makePublicLegacyRequest
414414

415415
| Param | Type | Default |
416416
| --- | --- | --- |
417-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
418-
| start | <code>number</code> | <code></code> |
419-
| end | <code>number</code> | <code></code> |
420-
| limit | <code>number</code> | <code></code> |
421-
| cb | <code>Method</code> | |
417+
| symbol | <code>string</code> | optional, omit/leave empty for all |
418+
| start | <code>number</code> | <code></code> |
419+
| end | <code>number</code> | <code></code> |
420+
| limit | <code>number</code> | <code></code> |
421+
| cb | <code>Method</code> | |
422422

423423
<a name="RESTv2+fundingTrades"></a>
424424

@@ -429,11 +429,11 @@ See _makePublicLegacyRequest
429429

430430
| Param | Type | Default |
431431
| --- | --- | --- |
432-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
433-
| start | <code>number</code> | <code></code> |
434-
| end | <code>number</code> | <code></code> |
435-
| limit | <code>number</code> | <code></code> |
436-
| cb | <code>Method</code> | |
432+
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
433+
| start | <code>number</code> | <code></code> |
434+
| end | <code>number</code> | <code></code> |
435+
| limit | <code>number</code> | <code></code> |
436+
| cb | <code>Method</code> | |
437437

438438
<a name="RESTv2+marginInfo"></a>
439439

@@ -444,8 +444,8 @@ See _makePublicLegacyRequest
444444

445445
| Param | Type | Default |
446446
| --- | --- | --- |
447-
| key | <code>string</code> | <code>&quot;base&quot;</code> |
448-
| cb | <code>Method</code> | |
447+
| key | <code>string</code> | <code>&quot;base&quot;</code> |
448+
| cb | <code>Method</code> | |
449449

450450
<a name="RESTv2+fundingInfo"></a>
451451

@@ -456,8 +456,8 @@ See _makePublicLegacyRequest
456456

457457
| Param | Type | Default |
458458
| --- | --- | --- |
459-
| key | <code>string</code> | <code>&quot;fUSD&quot;</code> |
460-
| cb | <code>Method</code> | |
459+
| key | <code>string</code> | <code>&quot;fUSD&quot;</code> |
460+
| cb | <code>Method</code> | |
461461

462462
<a name="RESTv2+performance"></a>
463463

@@ -468,7 +468,7 @@ See _makePublicLegacyRequest
468468

469469
| Param | Type |
470470
| --- | --- |
471-
| cb | <code>Method</code> |
471+
| cb | <code>Method</code> |
472472

473473
<a name="RESTv2+calcAvailableBalance"></a>
474474

@@ -479,11 +479,11 @@ See _makePublicLegacyRequest
479479

480480
| Param | Type | Default |
481481
| --- | --- | --- |
482-
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
483-
| dir | <code>string</code> | |
484-
| rate | <code>number</code> | |
485-
| type | <code>string</code> | |
486-
| cb | <code>Method</code> | |
482+
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
483+
| dir | <code>string</code> | |
484+
| rate | <code>number</code> | |
485+
| type | <code>string</code> | |
486+
| cb | <code>Method</code> | |
487487

488488
<a name="RESTv2+symbols"></a>
489489

@@ -513,7 +513,7 @@ Get a list of valid symbol names and details
513513

514514
| Param | Type |
515515
| --- | --- |
516-
| cb | <code>Method</code> |
516+
| cb | <code>Method</code> |
517517

518518
<a name="RESTv2+accountInfo"></a>
519519

@@ -528,7 +528,7 @@ Request information about your account
528528

529529
| Param | Type |
530530
| --- | --- |
531-
| cb | <code>Method</code> |
531+
| cb | <code>Method</code> |
532532

533533
<a name="RESTv2+accountFees"></a>
534534

@@ -543,7 +543,7 @@ Request account withdrawl fees
543543

544544
| Param | Type |
545545
| --- | --- |
546-
| cb | <code>Method</code> |
546+
| cb | <code>Method</code> |
547547

548548
<a name="RESTv2+accountSummary"></a>
549549

@@ -559,7 +559,7 @@ funding.
559559

560560
| Param | Type |
561561
| --- | --- |
562-
| cb | <code>Method</code> |
562+
| cb | <code>Method</code> |
563563

564564
<a name="RESTv2+deposit"></a>
565565

@@ -651,7 +651,7 @@ Fetch the permissions of the key being used to generate this request
651651

652652
| Param | Type |
653653
| --- | --- |
654-
| cb | <code>Method</code> |
654+
| cb | <code>Method</code> |
655655

656656
<a name="RESTv2+balances"></a>
657657

@@ -666,7 +666,7 @@ Request your wallet balances
666666

667667
| Param | Type |
668668
| --- | --- |
669-
| cb | <code>Method</code> |
669+
| cb | <code>Method</code> |
670670

671671
<a name="RESTv2+claimPosition"></a>
672672

@@ -679,10 +679,10 @@ Request your wallet balances
679679

680680
| Param | Type |
681681
| --- | --- |
682-
| params | <code>Object</code> |
683-
| params.position_id | <code>number</code> |
684-
| params.amount | <code>number</code> |
685-
| cb | <code>Method</code> |
682+
| params | <code>Object</code> |
683+
| params.position_id | <code>number</code> |
684+
| params.amount | <code>number</code> |
685+
| cb | <code>Method</code> |
686686

687687
<a name="RESTv2+closePosition"></a>
688688

@@ -695,9 +695,9 @@ Request your wallet balances
695695

696696
| Param | Type |
697697
| --- | --- |
698-
| params | <code>Object</code> |
699-
| params.position_id | <code>number</code> |
700-
| cb | <code>Method</code> |
698+
| params | <code>Object</code> |
699+
| params.position_id | <code>number</code> |
700+
| cb | <code>Method</code> |
701701

702702
<a name="RESTv2+updateSettings"></a>
703703

@@ -718,8 +718,8 @@ Request your wallet balances
718718

719719
| Param | Type |
720720
| --- | --- |
721-
| keys | <code>Array.&lt;string&gt;</code> |
722-
| cb | <code>Method</code> |
721+
| keys | <code>Array.&lt;string&gt;</code> |
722+
| cb | <code>Method</code> |
723723

724724
<a name="RESTv2+getSettings"></a>
725725

@@ -729,8 +729,8 @@ Request your wallet balances
729729

730730
| Param | Type |
731731
| --- | --- |
732-
| keys | <code>Array.&lt;string&gt;</code> |
733-
| cb | <code>Method</code> |
732+
| keys | <code>Array.&lt;string&gt;</code> |
733+
| cb | <code>Method</code> |
734734

735735
<a name="RESTv2+exchangeRate"></a>
736736

@@ -742,4 +742,3 @@ Request your wallet balances
742742
| --- | --- | --- |
743743
| ccy1 | <code>string</code> | i.e. BTC |
744744
| ccy2 | <code>string</code> | i.e. USD |
745-

0 commit comments

Comments
 (0)
Please sign in to comment.