Main - PMS
Number of APIs: 94
Query string parameters
For GET
requests all non-primitive parameter values are passed in JSV format.
Alternatively the entire DTO can be sent in the Body of the request in regular JSON format.
DateRange
objects
Most Date parameters in the API are DateRange
obejcts. This provides a flexible way to specify the range.
The example below specifies the date range >= 1-Jan-2023 through to < 1-Feb-2023
{
"From": "2023-01-01",
"To": "2023-02-01",
"FromIsInclusive": true,
"ToIsInclusive": false
}
To pass this in a parameter as JSV becomes:
{From:2023-01-01,To:2023-02-01,FromIsInclusive:true}
To specify an exact date use the following format:
{
"Exact":"2023-02-03"
}
Tp pass this in a parameter as JSV becomes:
{Exact:2023-02-03}
Paginated reults
API methods that can return large datasets are paginated. Paginated methods return a field named nextToken
that needs to be passed in the Token
paramenter at the next call to the same method. All other parameters can be omitted at this time (they will be ignored if passed)
The caller should keep calling the method passing the nextToken
each call until all results are exhausted.
-
Trades-Create - Create FRA Trade POST {{BASE_URL}}/trades/fra
-
Transactions - Get Position Transfers GET {{BASE_URL}}/transactions/positiontransfer?Status=New&TradeDate={From:2023-01-01}
-
Cash - Get Cash Activity GET {{BASE_URL}}/cash
-
Cash - Get Daily Cash Balances GET {{BASE_URL}}/cash/balances/daily
-
Cash - Get Cash Balances As Of GET {{BASE_URL}}/cash/balances/totals
-
Trades-Create - Create Equity Trade POST {{BASE_URL}}/trades/equity
-
Trades-Create - Create Fx Ndf Trade POST {{BASE_URL}}/trades/fxndf
-
Trades-Create - Create Fx Forward Trade POST {{BASE_URL}}/trades/fxforward
-
Trades-Get - Get Trades GET {{BASE_URL}}/trades/current?TransactionIds=640546d18675b10aa0bc9bba
-
Trades - Cancel Trade PATCH {{BASE_URL}}/trades/TRADE0000005901/6aca054d-d38a-4562-9368-9c3cafba628e