Skip to main content
GET
Get portfolio performance

Authorizations

x-api-key
string
header
required

A scoped API key created in the PaperDrill dashboard.

Response

Portfolio returned successfully.

quoteAsset
string
required
equity
string
required

A non-negative decimal encoded as a string.

Pattern: ^\d+(\.\d+)?$
Example:

"125.50"

baselineEquity
string
required

A non-negative decimal encoded as a string.

Pattern: ^\d+(\.\d+)?$
Example:

"125.50"

pnl
string
required

A signed decimal encoded as a string.

Pattern: ^[+-]?\d+(\.\d+)?$
Example:

"+3.40"

pnlPercent
string
required

A signed decimal encoded as a string.

Pattern: ^[+-]?\d+(\.\d+)?$
Example:

"+3.40"

baselineAt
string<date-time>
required
asOf
string<date-time>
required
partial
boolean
required
positions
object[]
required