Get portfolio performance
curl --request GET \
--url https://api.paperdrill.dev/v1/portfolio \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.paperdrill.dev/v1/portfolio', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paperdrill.dev/v1/portfolio"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"quoteAsset": "<string>",
"equity": "125.50",
"baselineEquity": "125.50",
"pnl": "+3.40",
"pnlPercent": "+3.40",
"baselineAt": "2023-11-07T05:31:56Z",
"asOf": "2023-11-07T05:31:56Z",
"partial": true,
"positions": [
{
"asset": "<string>",
"available": "125.50",
"locked": "125.50",
"total": "125.50",
"markPrice": "125.50",
"value": "125.50"
}
]
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}Account
Get portfolio performance
Returns valued positions and performance relative to the account’s PnL baseline.
Requires the ACCOUNT_READ scope.
GET
/
portfolio
Get portfolio performance
curl --request GET \
--url https://api.paperdrill.dev/v1/portfolio \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.paperdrill.dev/v1/portfolio', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paperdrill.dev/v1/portfolio"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"quoteAsset": "<string>",
"equity": "125.50",
"baselineEquity": "125.50",
"pnl": "+3.40",
"pnlPercent": "+3.40",
"baselineAt": "2023-11-07T05:31:56Z",
"asOf": "2023-11-07T05:31:56Z",
"partial": true,
"positions": [
{
"asset": "<string>",
"available": "125.50",
"locked": "125.50",
"total": "125.50",
"markPrice": "125.50",
"value": "125.50"
}
]
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}Authorizations
A scoped API key created in the PaperDrill dashboard.
Response
Portfolio returned successfully.
A non-negative decimal encoded as a string.
Pattern:
^\d+(\.\d+)?$Example:
"125.50"
A non-negative decimal encoded as a string.
Pattern:
^\d+(\.\d+)?$Example:
"125.50"
A signed decimal encoded as a string.
Pattern:
^[+-]?\d+(\.\d+)?$Example:
"+3.40"
A signed decimal encoded as a string.
Pattern:
^[+-]?\d+(\.\d+)?$Example:
"+3.40"
Show child attributes
Show child attributes