Trading Assistant API Documentation - v0.1.0
Preparing search index...
types/portfolio
PortfolioAPI
Interface PortfolioAPI
interface
PortfolioAPI
{
listPortfolios
(
activeOnly
?:
boolean
)
:
Promise
<
Portfolio
[]
>
;
getPortfolio
(
portfolioId
:
string
)
:
Promise
<
Portfolio
>
;
createPortfolio
(
data
:
CreatePortfolioRequest
)
:
Promise
<
Portfolio
>
;
updatePortfolio
(
portfolioId
:
string
,
data
:
UpdatePortfolioRequest
,
)
:
Promise
<
Portfolio
>
;
deletePortfolio
(
portfolioId
:
string
)
:
Promise
<
void
>
;
setDefaultPortfolio
(
portfolioId
:
string
)
:
Promise
<
Portfolio
>
;
getPositions
(
portfolioId
:
string
)
:
Promise
<
PositionsResponse
>
;
getTrades
(
portfolioId
:
string
,
startDate
?:
string
,
endDate
?:
string
,
)
:
Promise
<
TradesResponse
>
;
getPerformance
(
portfolioId
:
string
,
days
?:
number
,
)
:
Promise
<
PerformanceResponse
>
;
getAllocation
(
portfolioId
:
string
)
:
Promise
<
AllocationResponse
>
;
getRecommendations
(
portfolioId
:
string
)
:
Promise
<
RecommendationsResponse
>
;
}
Index
Methods
list
Portfolios
get
Portfolio
create
Portfolio
update
Portfolio
delete
Portfolio
set
Default
Portfolio
get
Positions
get
Trades
get
Performance
get
Allocation
get
Recommendations
Methods
list
Portfolios
listPortfolios
(
activeOnly
?:
boolean
)
:
Promise
<
Portfolio
[]
>
Parameters
Optional
activeOnly
:
boolean
Returns
Promise
<
Portfolio
[]
>
get
Portfolio
getPortfolio
(
portfolioId
:
string
)
:
Promise
<
Portfolio
>
Parameters
portfolioId
:
string
Returns
Promise
<
Portfolio
>
create
Portfolio
createPortfolio
(
data
:
CreatePortfolioRequest
)
:
Promise
<
Portfolio
>
Parameters
data
:
CreatePortfolioRequest
Returns
Promise
<
Portfolio
>
update
Portfolio
updatePortfolio
(
portfolioId
:
string
,
data
:
UpdatePortfolioRequest
,
)
:
Promise
<
Portfolio
>
Parameters
portfolioId
:
string
data
:
UpdatePortfolioRequest
Returns
Promise
<
Portfolio
>
delete
Portfolio
deletePortfolio
(
portfolioId
:
string
)
:
Promise
<
void
>
Parameters
portfolioId
:
string
Returns
Promise
<
void
>
set
Default
Portfolio
setDefaultPortfolio
(
portfolioId
:
string
)
:
Promise
<
Portfolio
>
Parameters
portfolioId
:
string
Returns
Promise
<
Portfolio
>
get
Positions
getPositions
(
portfolioId
:
string
)
:
Promise
<
PositionsResponse
>
Parameters
portfolioId
:
string
Returns
Promise
<
PositionsResponse
>
get
Trades
getTrades
(
portfolioId
:
string
,
startDate
?:
string
,
endDate
?:
string
,
)
:
Promise
<
TradesResponse
>
Parameters
portfolioId
:
string
Optional
startDate
:
string
Optional
endDate
:
string
Returns
Promise
<
TradesResponse
>
get
Performance
getPerformance
(
portfolioId
:
string
,
days
?:
number
)
:
Promise
<
PerformanceResponse
>
Parameters
portfolioId
:
string
Optional
days
:
number
Returns
Promise
<
PerformanceResponse
>
get
Allocation
getAllocation
(
portfolioId
:
string
)
:
Promise
<
AllocationResponse
>
Parameters
portfolioId
:
string
Returns
Promise
<
AllocationResponse
>
get
Recommendations
getRecommendations
(
portfolioId
:
string
)
:
Promise
<
RecommendationsResponse
>
Parameters
portfolioId
:
string
Returns
Promise
<
RecommendationsResponse
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
list
Portfolios
get
Portfolio
create
Portfolio
update
Portfolio
delete
Portfolio
set
Default
Portfolio
get
Positions
get
Trades
get
Performance
get
Allocation
get
Recommendations
Trading Assistant API Documentation - v0.1.0
Loading...