All accounts returns related paths.
/accounts/{account_id}/returns
List account returns
start_date
string
Returns account returns starting from and including this date (UTC)
end_date
string
Returns account returns up until this date (UTC)
sort
string
Sort the result by date
.
order
string
Sort order of the result list if the sort
parameter is specified. Use ASC
for ascending or DESC
for descending sort order.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
OK
{
"meta": {
"offset": 0,
"limit": 100,
"count": 2,
"total_count": 2,
"sort": "date",
"order": "ASC"
},
"data": [
{
"account_id": "bbe9e784-e009-4cb6-a07c-24831897327b",
"date": "2023-09-01",
"twr": {
"daily": "0.0132434142",
"cumulative": "0.0324353234",
"cumulative_start_date": "2023-08-01"
}
},
{
"account_id": "bbe9e784-e009-4cb6-a07c-24831897327b",
"date": "2023-09-02",
"twr": {
"daily": "-0.005116543491",
"cumulative": "0.0271528232",
"cumulative_start_date": "2023-08-01"
}
}
]
}
id
string
required
Event unique identifier
created_at
string
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
object
object (Account Returns)
required
account_id
string
required
Account unique identifier.
date
string
required
Date when returns were calculated. RFC 3339-5, ISO8601 UTC
twr
object
required
webhook_id
string
required
Webhook unique identifier.
{
"id": "399dc0a7-f4cb-42a4-9513-496df030381e",
"created_at": "2023-09-02T05:15:00Z",
"type": "ACCOUNT_RETURNS.CREATED",
"object": {
"account_id": "bbe9e784-e009-4cb6-a07c-24831897327b",
"date": "2023-09-01",
"twr": {
"daily": "0.0132434142",
"cumulative": "0.0324353234",
"cumulative_start_date": "2023-08-01"
}
},
"webhook_id": "435719ac-c064-4c7a-a8b9-6db9446965de"
}
Request has been processed successfully.
Empty response
Was this page helpful?