Order Management System REST API - Account Controller
The account/byids URL provides bulk management of Trading Account metadata by ID.
Retreive Trading Accounts by ID
Section titled “Retreive Trading Accounts by ID”GET /account/byids
Retrieves the listed Trading Accounts.
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| id | Optional | A Trading Account ID of the format <owner>/<account>. Can be repeated to retrieve additional Trading Accounts. |
| asAt | Optional | An ISO8601 date and time. The results returned will be those at the given timestamp. If omitted, returns the latest results. |
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is an array of AccountDetails objects. Trading Accounts that do not exist or are not visible will be omitted. |
Retreive Trading Accounts by ID (bulk)
Section titled “Retreive Trading Accounts by ID (bulk)”POST /account/byids
Retrieves the listed Trading Accounts.
This is an alternative endpoint for providing more identifiers than the maximum URL length permits.
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| asAt | Optional | An ISO8601 date and time. The results returned will be those at the given timestamp. If omitted, returns the latest results. |
POST Body
Section titled “POST Body”A JSON string array, listing the Trading Account IDs of the format <owner>/<account> to retrieve.
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 200 | Success | Content is an array of AccountDetails objects. Trading Accounts that do not exist or are not visible will be omitted. |