v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB

Accounts

Retrieve Account Activities

Returns a list of activities

Notes:

Pagination is handled using the page_token and page_size parameters.
page_token represents the ID of the last item on your current page of results. For example, if the ID of the last activity in your first response is 20220203000000000::045b3b8d-c566-4bef-b741-2bf598dd6ae7, you would pass that value as page_token to retrieve the next page of results.
If specified with a direction of desc, for example, the results will end before the activity with the specified ID.
If specified with a direction of asc, results will begin with the activity immediately after the one specified.
page_size is the maximum number of entries to return in the response.
If date is not specified, the default and maximum value is 100.
If date is specified, the default behavior is to return all results, and there is no maximum page size.

get/v1/accounts/activities

Query parameters

account_idstring uuid

id of a single account to filter by

activity_typesActivityType[]

A comma-separated list of activity types used to filter the results.

category'trade_activity' | 'non_trade_activity'

The activity category. Cannot be used with "activity_types" parameter.

datestring date-time

Filter activities by their creation date (created_at), not the activity's settlement date. For non-trade activities such as fees, the creation date is typically the day after the trade date (in UTC). Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.

untilstring date-time

Get activities created before this date. Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.

afterstring date-time

Get activities created after this date. Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ are supported.

direction'asc' | 'desc'

Example:desc

The chronological order of response based on the submission time. asc or desc. Defaults to desc.

page_sizeinteger

The maximum number of entries to return in the response.

page_tokenstring

Token used for pagination. Provide the ID of the last activity from the last page to retrieve the next set of results.

Response

Success

Example response

[
  {
    "account_id": "c8f1ef5d-edc0-4f23-9ee4-378f19cb92a4",
    "id": "20220208125959696::88b5f678-fef5-447b-af15-f21e367e6d8c",
    "cum_qty": "0.9723",
    "leaves_qty": "0.5123",
    "order_id": "fe060a1b-5b45-4eba-ba46-c3a3345d8255",
    "order_status": "filled",
    "price": "3.1415",
    "qty": "0.38921",
    "side": "buy",
    "symbol": "AAPL",
    "transaction_time": "2021-05-10T14:01:04.650275Z",
    "type": "fill"
  }
]