Get Investment Transactions
Get Investment Transactions
Returns investment transactions for the accounts associated with a link. Results are paginated, and returned in reverse chronological order.
Note that this endpoint does not trigger a fetch of transactions from the institution; it merely returns transactions that have already been fetched. To force a check for new/updated owner information, you must use the /products endpoint.
If you have requested prefetch or an on-demand update, you should check the refreshed_at
date
for this product in the returned response, and compare that against the previous refreshed_at
date, which you can
get from any previous response for this or any other account or link request. If the refreshed_at date has not
increased, then updated data is not yet available.
URL
Request
Response
account_ids
: array
An optional list of account IDs to filter the results.
end_date
: string
The latest date for which data should be returned, formatted as YYYY-MM-DD.
format:
date
page
: integer
The page number to return.
default: 1
size
: integer
The number of items to return per page.
default: 50
start_date
: string
The earliest date for which data should be returned, formatted as YYYY-MM-DD.
format:
date
id
: string
required
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
Responses
200
Successful Response
total
: integer
required
The total number of results for this query.
example: 82
page
: integer
required
The page number corresponding to this batch of results.
example: 1
size
: integer
required
The number of results in this batch.
example: 50
investment_transactions
: array
required
A list of investment transactions.
securities
: array
required
A list of securities involved in these transactions.
accounts
: array
required
A list of accounts for which transactions are being returned.
link
: object
required
The link that these accounts belong to.
401
Invalid access_token or insufficent API client scope or unauthorized link access.
403
Forbidden by link owner. The user did not give permission to access this data when linking.
error_code
: string
required
link_error.forbidden_action
default: "link_error.forbidden_action"
Allowed values:
"link_error.forbidden_action"
error_message
: string
required
Error message
example: Accounts access not permitted
documentation_url
: string
required
404
Link not found.
error_code
: string
required
link_error.not_found
default: "link_error.not_found"
Allowed values:
"link_error.not_found"
error_message
: string
required
default: "Link not found."
documentation_url
: string
required
410
Link deleted.
error_code
: string
required
link_error.deleted
default: "link_error.deleted"
Allowed values:
"link_error.deleted"
error_message
: string
required
default: "Link deleted."
documentation_url
: string
required
422
Link error.
error_code
: string
required
link_error.bad_state
default: "link_error.bad_state"
Allowed values:
"link_error.bad_state"
error_message
: string
required
documentation_url
: string
required
link_error_code
: string
required
429
Rate limit exceeded.
error_code
: string
required
api_error.rate_limit_exceeded
default: "api_error.rate_limit_exceeded"
Allowed values:
"api_error.rate_limit_exceeded"
error_message
: string
required
Error message
default: "Rate limit exceeded"
documentation_url
: string
required