Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@icastillejogomez
icastillejogomez committed Jun 20, 2020
1 parent 3ed0af7 commit 654c68f
Show file tree
Hide file tree
Showing 65 changed files with 1,221 additions and 396 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

74 changes: 37 additions & 37 deletions docs/classes/_degiro_.degiro.html
View file

Large diffs are not rendered by default.

76 changes: 52 additions & 24 deletions docs/enums/_enums_degiroenums_.degiro_api_paths.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,12 @@ <h3>Enumeration members</h3>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#base_api_url" class="tsd-kind-icon">BASE_<wbr>API_<wbr>URL</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#create_order_path" class="tsd-kind-icon">CREATE_<wbr>ORDER_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_account_config_path" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>CONFIG_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_account_info" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>INFO</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_account_info_path" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>INFO_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_account_state_path" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>STATE_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_latests_news" class="tsd-kind-icon">GET_<wbr>LATESTS_<wbr>NEWS</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_top_news" class="tsd-kind-icon">GET_<wbr>TOP_<wbr>NEWS</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_latests_news_path" class="tsd-kind-icon">GET_<wbr>LATESTS_<wbr>NEWS_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_top_news_path" class="tsd-kind-icon">GET_<wbr>TOP_<wbr>NEWS_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_web_settings_path" class="tsd-kind-icon">GET_<wbr>WEB_<wbr>SETTINGS_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#get_web_user_settings_path" class="tsd-kind-icon">GET_<wbr>WEB_<wbr>USER_<wbr>SETTINGS_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#login_url_path" class="tsd-kind-icon">LOGIN_<wbr>URL_<wbr>PATH</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_enums_degiroenums_.degiro_api_paths.html#logout_url_path" class="tsd-kind-icon">LOGOUT_<wbr>URL_<wbr>PATH</a></li>
</ul>
Expand All @@ -98,7 +100,7 @@ <h3>BASE_<wbr>API_<wbr>URL</h3>
<div class="tsd-signature tsd-kind-icon">BASE_<wbr>API_<wbr>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;https://trader.degiro.nl/&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L2">enums/DeGiroEnums.ts:2</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L2">enums/DeGiroEnums.ts:2</a></li>
</ul>
</aside>
</section>
Expand All @@ -108,7 +110,7 @@ <h3>CREATE_<wbr>ORDER_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">CREATE_<wbr>ORDER_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;v5/checkOrder&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L6">enums/DeGiroEnums.ts:6</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L6">enums/DeGiroEnums.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -118,17 +120,17 @@ <h3>GET_<wbr>ACCOUNT_<wbr>CONFIG_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>CONFIG_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;login/secure/config&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L5">enums/DeGiroEnums.ts:5</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L5">enums/DeGiroEnums.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="get_account_info" class="tsd-anchor"></a>
<h3>GET_<wbr>ACCOUNT_<wbr>INFO</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>INFO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;v5/account/info/&quot;</span></div>
<a name="get_account_info_path" class="tsd-anchor"></a>
<h3>GET_<wbr>ACCOUNT_<wbr>INFO_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>INFO_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;v5/account/info/&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L8">enums/DeGiroEnums.ts:8</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L8">enums/DeGiroEnums.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -138,27 +140,47 @@ <h3>GET_<wbr>ACCOUNT_<wbr>STATE_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>STATE_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;v6/accountoverview&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L7">enums/DeGiroEnums.ts:7</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L7">enums/DeGiroEnums.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="get_latests_news" class="tsd-anchor"></a>
<h3>GET_<wbr>LATESTS_<wbr>NEWS</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>LATESTS_<wbr>NEWS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;newsfeed/v2/latest-news&quot;</span></div>
<a name="get_latests_news_path" class="tsd-anchor"></a>
<h3>GET_<wbr>LATESTS_<wbr>NEWS_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>LATESTS_<wbr>NEWS_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;newsfeed/v2/latest-news&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L9">enums/DeGiroEnums.ts:9</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L9">enums/DeGiroEnums.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="get_top_news" class="tsd-anchor"></a>
<h3>GET_<wbr>TOP_<wbr>NEWS</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>TOP_<wbr>NEWS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;newsfeed/v2/top-news-preview&quot;</span></div>
<a name="get_top_news_path" class="tsd-anchor"></a>
<h3>GET_<wbr>TOP_<wbr>NEWS_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>TOP_<wbr>NEWS_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;newsfeed/v2/top-news-preview&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L10">enums/DeGiroEnums.ts:10</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L10">enums/DeGiroEnums.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="get_web_settings_path" class="tsd-anchor"></a>
<h3>GET_<wbr>WEB_<wbr>SETTINGS_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>WEB_<wbr>SETTINGS_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;settings/web&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L11">enums/DeGiroEnums.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="get_web_user_settings_path" class="tsd-anchor"></a>
<h3>GET_<wbr>WEB_<wbr>USER_<wbr>SETTINGS_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">GET_<wbr>WEB_<wbr>USER_<wbr>SETTINGS_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;settings/user&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L12">enums/DeGiroEnums.ts:12</a></li>
</ul>
</aside>
</section>
Expand All @@ -168,7 +190,7 @@ <h3>LOGIN_<wbr>URL_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">LOGIN_<wbr>URL_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;login/secure/login&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L3">enums/DeGiroEnums.ts:3</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L3">enums/DeGiroEnums.ts:3</a></li>
</ul>
</aside>
</section>
Expand All @@ -178,7 +200,7 @@ <h3>LOGOUT_<wbr>URL_<wbr>PATH</h3>
<div class="tsd-signature tsd-kind-icon">LOGOUT_<wbr>URL_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;trading/secure/logout&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L4">enums/DeGiroEnums.ts:4</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L4">enums/DeGiroEnums.ts:4</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -212,16 +234,22 @@ <h3>LOGOUT_<wbr>URL_<wbr>PATH</h3>
<a href="_enums_degiroenums_.degiro_api_paths.html#get_account_config_path" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>CONFIG_<wbr>PATH</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="_enums_degiroenums_.degiro_api_paths.html#get_account_info" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>INFO</a>
<a href="_enums_degiroenums_.degiro_api_paths.html#get_account_info_path" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>INFO_<wbr>PATH</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="_enums_degiroenums_.degiro_api_paths.html#get_account_state_path" class="tsd-kind-icon">GET_<wbr>ACCOUNT_<wbr>STATE_<wbr>PATH</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="_enums_degiroenums_.degiro_api_paths.html#get_latests_news" class="tsd-kind-icon">GET_<wbr>LATESTS_<wbr>NEWS</a>
<a href="_enums_degiroenums_.degiro_api_paths.html#get_latests_news_path" class="tsd-kind-icon">GET_<wbr>LATESTS_<wbr>NEWS_<wbr>PATH</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="_enums_degiroenums_.degiro_api_paths.html#get_top_news_path" class="tsd-kind-icon">GET_<wbr>TOP_<wbr>NEWS_<wbr>PATH</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="_enums_degiroenums_.degiro_api_paths.html#get_web_settings_path" class="tsd-kind-icon">GET_<wbr>WEB_<wbr>SETTINGS_<wbr>PATH</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="_enums_degiroenums_.degiro_api_paths.html#get_top_news" class="tsd-kind-icon">GET_<wbr>TOP_<wbr>NEWS</a>
<a href="_enums_degiroenums_.degiro_api_paths.html#get_web_user_settings_path" class="tsd-kind-icon">GET_<wbr>WEB_<wbr>USER_<wbr>SETTINGS_<wbr>PATH</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="_enums_degiroenums_.degiro_api_paths.html#login_url_path" class="tsd-kind-icon">LOGIN_<wbr>URL_<wbr>PATH</a>
Expand Down
4 changes: 2 additions & 2 deletions docs/enums/_enums_degiroenums_.degiroactions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h3>BUY</h3>
<div class="tsd-signature tsd-kind-icon">BUY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;BUY&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L14">enums/DeGiroEnums.ts:14</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L16">enums/DeGiroEnums.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -101,7 +101,7 @@ <h3>SELL</h3>
<div class="tsd-signature tsd-kind-icon">SELL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;SELL&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L15">enums/DeGiroEnums.ts:15</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L17">enums/DeGiroEnums.ts:17</a></li>
</ul>
</aside>
</section>
Expand Down
8 changes: 4 additions & 4 deletions docs/enums/_enums_degiroenums_.degiromarketordertypes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h3>LIMITED</h3>
<div class="tsd-signature tsd-kind-icon">LIMITED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L19">enums/DeGiroEnums.ts:19</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L21">enums/DeGiroEnums.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -103,7 +103,7 @@ <h3>MARKET</h3>
<div class="tsd-signature tsd-kind-icon">MARKET<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L20">enums/DeGiroEnums.ts:20</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L22">enums/DeGiroEnums.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3>STOP_<wbr>LOSS</h3>
<div class="tsd-signature tsd-kind-icon">STOP_<wbr>LOSS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L21">enums/DeGiroEnums.ts:21</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L23">enums/DeGiroEnums.ts:23</a></li>
</ul>
</aside>
</section>
Expand All @@ -123,7 +123,7 @@ <h3>STOP_<wbr>LOSS_<wbr>LIMIT</h3>
<div class="tsd-signature tsd-kind-icon">STOP_<wbr>LOSS_<wbr>LIMIT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/83b252f/src/enums/DeGiroEnums.ts#L22">enums/DeGiroEnums.ts:22</a></li>
<li>Defined in <a href="https://github.com/icastillejogomez/degiro-api/blob/0e7aac2/src/enums/DeGiroEnums.ts#L24">enums/DeGiroEnums.ts:24</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 654c68f

Please sign in to comment.