v1
latestOpenAPI 3.0.02026-07-26224386470.0 KBPositions
Get positions summary for end user
Returns positions with calculated metrics for an end user, optionally filtered by account IDs
get/api/end_users/{end_user_id_or_heron_id}/positions
Path parameters
end_user_id_or_heron_idstring required
The end user ID or heron ID
Query parameters
account_idsstring[]
Account IDs to filter positions by
include_transactionsboolean
If true, include investment/repayment/reversal transactions on each position
Response
Positions summary retrieved successfully
Example response
{
"positions": [
{
"inflow_metrics": {
"max_amount": {
"currency": "USD"
},
"min_amount": {
"currency": "USD"
},
"total_amount": {
"currency": "USD"
}
},
"investment_transactions": [
{
"amount": {
"currency": "USD"
}
}
],
"outflow_metrics": {
"estimated_monthly_amount": {
"currency": "USD"
},
"estimated_remaining_balance": {
"currency": "USD"
},
"estimated_right_to_receive_amount": {
"currency": "USD"
},
"fallback_estimated_monthly_amount": {
"currency": "USD"
},
"latest_estimated_monthly_amount": {
"currency": "USD"
},
"latest_repayment_amount": {
"currency": "USD"
},
"max_amount": {
"currency": "USD"
},
"mean_amount": {
"currency": "USD"
},
"min_amount": {
"currency": "USD"
},
"std_dev_amount": {
"currency": "USD"
},
"total_amount": {
"currency": "USD"
}
},
"repayment_transactions": [
{
"amount": {
"currency": "USD"
}
}
],
"reversal_transactions": [
{
"amount": {
"currency": "USD"
}
}
]
}
]
}