Get positions summary for end user
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/positions \
--header 'x-api-key: <api-key>'{
"llm_summary": "<string>",
"positions": [
{
"group": "<string>",
"heron_id": "<string>",
"inflow_metrics": {
"count": 123,
"max_amount": {
"amount": "1234.56",
"currency": "USD"
},
"max_timestamp": "2023-11-07T05:31:56Z",
"min_amount": {
"amount": "1234.56",
"currency": "USD"
},
"min_timestamp": "2023-11-07T05:31:56Z",
"total_amount": {
"amount": "1234.56",
"currency": "USD"
}
},
"investment_transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"description": "<string>",
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"is_active": true,
"is_renewal": true,
"llm_summary": "<string>",
"merchant": "<string>",
"missed_payments": [
"2023-12-25"
],
"nsf_fees": [
{
"amount": 123,
"date": "2023-12-25",
"merchant": "<string>"
}
],
"outflow_metrics": {
"changed_in_last_90_days": true,
"count": 123,
"duration_days": 123,
"estimated_monthly_amount": {
"amount": "1234.56",
"currency": "USD"
},
"estimated_remaining_balance": {
"amount": "1234.56",
"currency": "USD"
},
"estimated_right_to_receive_amount": {
"amount": "1234.56",
"currency": "USD"
},
"has_repayment_modifications": true,
"latest_repayment_amount": {
"amount": "1234.56",
"currency": "USD"
},
"max_amount": {
"amount": "1234.56",
"currency": "USD"
},
"max_timestamp": "2023-11-07T05:31:56Z",
"mean_amount": {
"amount": "1234.56",
"currency": "USD"
},
"mean_interval_days": 123,
"min_amount": {
"amount": "1234.56",
"currency": "USD"
},
"min_timestamp": "2023-11-07T05:31:56Z",
"mode_interval_days": 123,
"remaining_repayment_duration_days": 123,
"std_dev_amount": {
"amount": "1234.56",
"currency": "USD"
},
"total_amount": {
"amount": "1234.56",
"currency": "USD"
},
"total_expected_duration_days": 123,
"total_expected_payments_to_date": 123
},
"parent_position_heron_id": "<string>",
"repayment_transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"description": "<string>",
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"reversal_transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"description": "<string>",
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"reversals": [
{
"amount": 123,
"date": "2023-12-25",
"merchant": "<string>"
}
]
}
]
}Positions
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
Get positions summary for end user
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/positions \
--header 'x-api-key: <api-key>'{
"llm_summary": "<string>",
"positions": [
{
"group": "<string>",
"heron_id": "<string>",
"inflow_metrics": {
"count": 123,
"max_amount": {
"amount": "1234.56",
"currency": "USD"
},
"max_timestamp": "2023-11-07T05:31:56Z",
"min_amount": {
"amount": "1234.56",
"currency": "USD"
},
"min_timestamp": "2023-11-07T05:31:56Z",
"total_amount": {
"amount": "1234.56",
"currency": "USD"
}
},
"investment_transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"description": "<string>",
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"is_active": true,
"is_renewal": true,
"llm_summary": "<string>",
"merchant": "<string>",
"missed_payments": [
"2023-12-25"
],
"nsf_fees": [
{
"amount": 123,
"date": "2023-12-25",
"merchant": "<string>"
}
],
"outflow_metrics": {
"changed_in_last_90_days": true,
"count": 123,
"duration_days": 123,
"estimated_monthly_amount": {
"amount": "1234.56",
"currency": "USD"
},
"estimated_remaining_balance": {
"amount": "1234.56",
"currency": "USD"
},
"estimated_right_to_receive_amount": {
"amount": "1234.56",
"currency": "USD"
},
"has_repayment_modifications": true,
"latest_repayment_amount": {
"amount": "1234.56",
"currency": "USD"
},
"max_amount": {
"amount": "1234.56",
"currency": "USD"
},
"max_timestamp": "2023-11-07T05:31:56Z",
"mean_amount": {
"amount": "1234.56",
"currency": "USD"
},
"mean_interval_days": 123,
"min_amount": {
"amount": "1234.56",
"currency": "USD"
},
"min_timestamp": "2023-11-07T05:31:56Z",
"mode_interval_days": 123,
"remaining_repayment_duration_days": 123,
"std_dev_amount": {
"amount": "1234.56",
"currency": "USD"
},
"total_amount": {
"amount": "1234.56",
"currency": "USD"
},
"total_expected_duration_days": 123,
"total_expected_payments_to_date": 123
},
"parent_position_heron_id": "<string>",
"repayment_transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"description": "<string>",
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"reversal_transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"description": "<string>",
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"reversals": [
{
"amount": 123,
"date": "2023-12-25",
"merchant": "<string>"
}
]
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.herondata.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Path Parameters
The end user ID or heron ID
Query Parameters
Account IDs to filter positions by
If true, include investment/repayment/reversal transactions on each position
Was this page helpful?
⌘I