Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add all option for offers, loans and credits history #386

Merged
merged 4 commits into from
Sep 1, 2018
Merged

Add all option for offers, loans and credits history #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d59bbd
Merge pull request #1 from bitfinexcom/master
ezewer Aug 31, 2018
fd5aac3
Add logic for not sending symbol on founding offers, credits and loans
ezewer Aug 31, 2018
ac551d6
Add tests for not sending symbols on founding offers, credits and loans
ezewer Aug 31, 2018
fd4899d
Add documentation
ezewer Aug 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 80 additions & 81 deletions doc/rest2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ See _makePublicLegacyRequest

| Param | Type |
| --- | --- |
| method | <code>string</code> |
| params | <code>Object</code> |
| cb | <code>Method</code> |
| method | <code>string</code> |
| params | <code>Object</code> |
| cb | <code>Method</code> |

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

Expand All @@ -111,7 +111,7 @@ See _makePublicLegacyRequest

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -122,8 +122,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -134,8 +134,8 @@ See _makePublicLegacyRequest

| Param | Type |
| --- | --- |
| symbols | <code>Array.&lt;string&gt;</code> |
| cb | <code>Method</code> |
| symbols | <code>Array.&lt;string&gt;</code> |
| cb | <code>Method</code> |

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

Expand All @@ -146,9 +146,9 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| key | <code>string</code> | <code>&quot;pos.size:1m:tBTCUSD:long&quot;</code> |
| context | <code>string</code> | <code>&quot;hist&quot;</code> |
| cb | <code>Method</code> | |
| key | <code>string</code> | <code>&quot;pos.size:1m:tBTCUSD:long&quot;</code> |
| context | <code>string</code> | <code>&quot;hist&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -174,8 +174,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| type | <code>string</code> | <code>&quot;price&quot;</code> |
| cb | <code>Method</code> | |
| type | <code>string</code> | <code>&quot;price&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -186,9 +186,9 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| type | <code>string</code> | <code>&quot;price&quot;</code> |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| price | <code>number</code> | <code>0</code> |
| type | <code>string</code> | <code>&quot;price&quot;</code> |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| price | <code>number</code> | <code>0</code> |

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

Expand All @@ -199,8 +199,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| price | <code>number</code> | <code>0</code> |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| price | <code>number</code> | <code>0</code> |

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

Expand Down Expand Up @@ -254,7 +254,7 @@ See _makePublicLegacyRequest

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -265,7 +265,7 @@ See _makePublicLegacyRequest

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand Down Expand Up @@ -321,12 +321,12 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| orderID | <code>number</code> | |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| orderID | <code>number</code> | |
| cb | <code>Method</code> | |

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

Expand All @@ -337,7 +337,7 @@ See _makePublicLegacyRequest

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -348,8 +348,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -360,11 +360,11 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | optional, omit/leave empty for all |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |

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

Expand All @@ -375,8 +375,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -387,11 +387,11 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | optional, omit/leave empty for all |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |

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

Expand All @@ -402,8 +402,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -414,11 +414,11 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | optional, omit/leave empty for all |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |

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

Expand All @@ -429,11 +429,11 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| start | <code>number</code> | <code></code> |
| end | <code>number</code> | <code></code> |
| limit | <code>number</code> | <code></code> |
| cb | <code>Method</code> | |

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

Expand All @@ -444,8 +444,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| key | <code>string</code> | <code>&quot;base&quot;</code> |
| cb | <code>Method</code> | |
| key | <code>string</code> | <code>&quot;base&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -456,8 +456,8 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| key | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |
| key | <code>string</code> | <code>&quot;fUSD&quot;</code> |
| cb | <code>Method</code> | |

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

Expand All @@ -468,7 +468,7 @@ See _makePublicLegacyRequest

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -479,11 +479,11 @@ See _makePublicLegacyRequest

| Param | Type | Default |
| --- | --- | --- |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| dir | <code>string</code> | |
| rate | <code>number</code> | |
| type | <code>string</code> | |
| cb | <code>Method</code> | |
| symbol | <code>string</code> | <code>&quot;tBTCUSD&quot;</code> |
| dir | <code>string</code> | |
| rate | <code>number</code> | |
| type | <code>string</code> | |
| cb | <code>Method</code> | |

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

Expand Down Expand Up @@ -513,7 +513,7 @@ Get a list of valid symbol names and details

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -528,7 +528,7 @@ Request information about your account

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -543,7 +543,7 @@ Request account withdrawl fees

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -559,7 +559,7 @@ funding.

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

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

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -666,7 +666,7 @@ Request your wallet balances

| Param | Type |
| --- | --- |
| cb | <code>Method</code> |
| cb | <code>Method</code> |

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

Expand All @@ -679,10 +679,10 @@ Request your wallet balances

| Param | Type |
| --- | --- |
| params | <code>Object</code> |
| params.position_id | <code>number</code> |
| params.amount | <code>number</code> |
| cb | <code>Method</code> |
| params | <code>Object</code> |
| params.position_id | <code>number</code> |
| params.amount | <code>number</code> |
| cb | <code>Method</code> |

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

Expand All @@ -695,9 +695,9 @@ Request your wallet balances

| Param | Type |
| --- | --- |
| params | <code>Object</code> |
| params.position_id | <code>number</code> |
| cb | <code>Method</code> |
| params | <code>Object</code> |
| params.position_id | <code>number</code> |
| cb | <code>Method</code> |

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

Expand All @@ -718,8 +718,8 @@ Request your wallet balances

| Param | Type |
| --- | --- |
| keys | <code>Array.&lt;string&gt;</code> |
| cb | <code>Method</code> |
| keys | <code>Array.&lt;string&gt;</code> |
| cb | <code>Method</code> |

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

Expand All @@ -729,8 +729,8 @@ Request your wallet balances

| Param | Type |
| --- | --- |
| keys | <code>Array.&lt;string&gt;</code> |
| cb | <code>Method</code> |
| keys | <code>Array.&lt;string&gt;</code> |
| cb | <code>Method</code> |

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

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

Loading