{ "opencollection": "1.0.0", "info": { "name": "MX Platform accounts investment holdings API", "version": "20111101" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "investment holdings", "type": "folder" }, "items": [ { "info": { "name": "List holdings by member", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/members/:member_guid/investment_holdings", "params": [ { "name": "member_guid", "value": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "type": "path", "description": "The unique id for a `member`." }, { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint lists all holdings associated with the specified member." }, { "info": { "name": "List holdings by user", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/investment_holdings", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint lists all holdings associated with the user across all accounts." }, { "info": { "name": "Read holding", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/investment_holdings/:holding_guid", "params": [ { "name": "holding_guid", "value": "HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2", "type": "path", "description": "The unique id for a `holding`." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Use this endpoint to read the attributes of a specific `holding`." }, { "info": { "name": "List holdings by account", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/accounts/:account_guid/investment_holdings", "params": [ { "name": "account_guid", "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1", "type": "path", "description": "The unique id for an `account`." }, { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint lists all holdings associated with the particular account defined." }, { "info": { "name": "Deactivate user from Investment Holdings", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/investment_holdings_deactivate", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "This endpoint deactivates the specific user from the `/investment_holdings` product. To reactivate a user, use any of the current `/investment_holding` endpoints." } ] } ], "bundled": true }