Skip to content

Commit 86fe517

Browse files
authored
Merge pull request #60 from mxenabled/newlin/list_holdings
Adding _list holdings by account_ endpoint
2 parents eda6947 + d9b521b commit 86fe517

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

openapi/mx_platform_api_beta.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2693,6 +2693,60 @@ paths:
26932693
summary: List account numbers by account
26942694
tags:
26952695
- mx_platform
2696+
"/users/{user_guid}/accounts/{account_guid}/holdings":
2697+
get:
2698+
description: This endpoint returns all holdings associated with the specified
2699+
`account`.
2700+
operationId: listHoldingsByAccount
2701+
parameters:
2702+
- description: The unique id for the `account`.
2703+
example: ACT-7c6f361b-e582-15b6-60c0-358f12466b4b
2704+
in: path
2705+
name: account_guid
2706+
required: true
2707+
schema:
2708+
type: string
2709+
- description: Filter holdings from this date.
2710+
example: '2015-09-20'
2711+
in: query
2712+
name: from_date
2713+
schema:
2714+
type: string
2715+
- description: Specify current page.
2716+
example: 1
2717+
in: query
2718+
name: page
2719+
schema:
2720+
type: integer
2721+
- description: Specify records per page.
2722+
example: 10
2723+
in: query
2724+
name: records_per_page
2725+
schema:
2726+
type: integer
2727+
- description: Filter holdings to this date.
2728+
example: '2019-10-20'
2729+
in: query
2730+
name: to_date
2731+
schema:
2732+
type: string
2733+
- description: The unique id for the `user`.
2734+
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
2735+
in: path
2736+
name: user_guid
2737+
required: true
2738+
schema:
2739+
type: string
2740+
responses:
2741+
'200':
2742+
content:
2743+
application/vnd.mx.api.v1+json:
2744+
schema:
2745+
"$ref": "#/components/schemas/HoldingsResponseBody"
2746+
description: OK
2747+
summary: List holdings by account
2748+
tags:
2749+
- mx_platform
26962750
"/users/{user_guid}/accounts/{account_guid}/transactions":
26972751
get:
26982752
description: This endpoint returns a list of the last 90 days of transactions

0 commit comments

Comments
 (0)