API status
  • Balances

Returns

All accounts returns related paths.

get

List account returns

List account returns

start_datestring

Returns account returns starting from and including this date (UTC)

Example
"2023-08-15"
end_datestring

Returns account returns up until this date (UTC)

Example
"2023-08-15"
sortstring

Sort the result by date.

Default
"date"
Enum
  • date
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses

Response examples

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"
      }
    }
  ]
}
webhook

Account returns event

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Event type

Default
"ACCOUNT_RETURNS.CREATED"
Enum
  • ACCOUNT_RETURNS.CREATED
objectobject (Account Returns)

required

account_idstring

required

Account unique identifier.

Format
uuid
datestring

required

Date when returns were calculated. RFC 3339-5, ISO8601 UTC

Format
date-time
twrobject

required

webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "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"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?