Search
Preparing search index...
The search index is not available
degiro-api
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"DeGiro"
DeGiro
Class DeGiro
description
Main class of DeGiro Unofficial API.
Hierarchy
DeGiro
Implements
DeGiroClassInterface
Index
Constructors
constructor
Properties
account
Config
account
Data
jsession
Id
pwd
username
Methods
complete
Portfolio
Details
create
Order
delete
Order
execute
Order
get
Account
Config
get
Account
Data
get
Account
Info
get
Account
Reports
get
Account
State
get
Cash
Funds
get
Config
Dictionary
get
Favourite
Products
get
Historical
Orders
getJSESSIONID
get
News
get
Orders
get
Popular
Stocks
get
Portfolio
get
Products
ByIds
get
Web
Settings
get
Web
User
Settings
get
Webi18n
Messages
has
Session
Id
is
Login
login
login
WithJSESSIONID
logout
search
Product
create
Constructors
constructor
new
DeGiro
(
params
?:
DeGiroSettupType
)
:
DeGiro
Parameters
Default value
params:
DeGiroSettupType
= {}
Returns
DeGiro
Properties
Private
account
Config
account
Config
:
AccountConfigType
|
undefined
Private
account
Data
account
Data
:
AccountDataType
|
undefined
Private
jsession
Id
jsession
Id
:
string
|
undefined
Private
Readonly
pwd
pwd
:
string
Private
Readonly
username
username
:
string
Methods
Private
complete
Portfolio
Details
complete
Portfolio
Details
(
portfolio
:
any
[]
, getProductDetails
:
boolean
)
:
Promise
<
any
[]
>
Parameters
portfolio:
any
[]
getProductDetails:
boolean
Returns
Promise
<
any
[]
>
create
Order
create
Order
(
order
:
OrderType
)
:
Promise
<
CreateOrderResultType
>
Parameters
order:
OrderType
Returns
Promise
<
CreateOrderResultType
>
delete
Order
delete
Order
(
orderId
:
String
)
:
Promise
<
void
>
Parameters
orderId:
String
Returns
Promise
<
void
>
execute
Order
execute
Order
(
order
:
OrderType
, executeId
:
String
)
:
Promise
<
String
>
Parameters
order:
OrderType
executeId:
String
Returns
Promise
<
String
>
get
Account
Config
get
Account
Config
(
sessionId
?:
undefined
|
string
)
:
Promise
<
AccountConfigType
>
Parameters
Optional
sessionId:
undefined
|
string
Returns
Promise
<
AccountConfigType
>
get
Account
Data
get
Account
Data
(
)
:
Promise
<
AccountDataType
>
Returns
Promise
<
AccountDataType
>
get
Account
Info
get
Account
Info
(
)
:
Promise
<
AccountInfoType
>
Returns
Promise
<
AccountInfoType
>
get
Account
Reports
get
Account
Reports
(
)
:
Promise
<
AccountReportsType
>
Returns
Promise
<
AccountReportsType
>
get
Account
State
get
Account
State
(
options
:
GetAccountStateOptionsType
)
:
Promise
<
any
[]
>
Parameters
options:
GetAccountStateOptionsType
Returns
Promise
<
any
[]
>
get
Cash
Funds
get
Cash
Funds
(
)
:
Promise
<
CashFoundType
[]
>
Returns
Promise
<
CashFoundType
[]
>
get
Config
Dictionary
get
Config
Dictionary
(
)
:
Promise
<
ConfigDictionaryType
>
Returns
Promise
<
ConfigDictionaryType
>
get
Favourite
Products
get
Favourite
Products
(
)
:
Promise
<
FavouriteProductType
[]
>
Returns
Promise
<
FavouriteProductType
[]
>
get
Historical
Orders
get
Historical
Orders
(
options
:
GetHistoricalOrdersOptionsType
)
:
Promise
<
HistoricalOrdersType
>
Parameters
options:
GetHistoricalOrdersOptionsType
Returns
Promise
<
HistoricalOrdersType
>
getJSESSIONID
getJSESSIONID
(
)
:
undefined
|
string
Returns
undefined
|
string
get
News
get
News
(
options
:
GetNewsOptionsType
)
:
Promise
<
NewsType
>
Parameters
options:
GetNewsOptionsType
Returns
Promise
<
NewsType
>
get
Orders
get
Orders
(
config
:
GetOrdersConfigType
)
:
Promise
<
GetOrdersResultType
>
Parameters
config:
GetOrdersConfigType
Returns
Promise
<
GetOrdersResultType
>
get
Popular
Stocks
get
Popular
Stocks
(
)
:
Promise
<
StockType
[]
>
Returns
Promise
<
StockType
[]
>
get
Portfolio
get
Portfolio
(
config
:
GetPorfolioConfigType
)
:
Promise
<
any
[]
>
Parameters
config:
GetPorfolioConfigType
Returns
Promise
<
any
[]
>
get
Products
ByIds
get
Products
ByIds
(
ids
:
string
[]
)
:
Promise
<
any
[]
>
Parameters
ids:
string
[]
Returns
Promise
<
any
[]
>
get
Web
Settings
get
Web
Settings
(
)
:
Promise
<
WebSettingsType
>
Returns
Promise
<
WebSettingsType
>
get
Web
User
Settings
get
Web
User
Settings
(
)
:
Promise
<
WebUserSettingType
>
Returns
Promise
<
WebUserSettingType
>
get
Webi18n
Messages
get
Webi18n
Messages
(
lang
?:
string
)
:
Promise
<
i18nMessagesType
>
Parameters
Default value
lang:
string
= "es_ES"
Returns
Promise
<
i18nMessagesType
>
Private
has
Session
Id
has
Session
Id
(
)
:
boolean
Returns
boolean
is
Login
is
Login
(
options
?:
IsLoginOptionsType
)
:
boolean
|
Promise
<
boolean
>
Parameters
Optional
options:
IsLoginOptionsType
Returns
boolean
|
Promise
<
boolean
>
login
login
(
)
:
Promise
<
AccountDataType
>
Returns
Promise
<
AccountDataType
>
Private
login
WithJSESSIONID
login
WithJSESSIONID
(
jsessionId
:
string
)
:
Promise
<
AccountDataType
>
Parameters
jsessionId:
string
Returns
Promise
<
AccountDataType
>
logout
logout
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
search
Product
search
Product
(
options
:
SearchProductOptionsType
)
:
Promise
<
SearchProductResultType
[]
>
Parameters
options:
SearchProductOptionsType
Returns
Promise
<
SearchProductResultType
[]
>
Static
create
create
(
params
:
DeGiroSettupType
)
:
DeGiro
Parameters
params:
DeGiroSettupType
Returns
DeGiro
Globals
"
DeGiro"
De
Giro
constructor
account
Config
account
Data
jsession
Id
pwd
username
complete
Portfolio
Details
create
Order
delete
Order
execute
Order
get
Account
Config
get
Account
Data
get
Account
Info
get
Account
Reports
get
Account
State
get
Cash
Funds
get
Config
Dictionary
get
Favourite
Products
get
Historical
Orders
getJSESSIONID
get
News
get
Orders
get
Popular
Stocks
get
Portfolio
get
Products
ByIds
get
Web
Settings
get
Web
User
Settings
get
Webi18n
Messages
has
Session
Id
is
Login
login
login
WithJSESSIONID
logout
search
Product
create
Generated using
TypeDoc
Main class of DeGiro Unofficial API.