Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get Cash Balances
This request returns the current cash balances for an account. These cash balances represent the amount available to trade, the amount available to withdraw, and those funds otherwise pending an activity.
Request URL
| Syntax | GET /restapi/accounts/{accountnumber}/balances |
|---|---|
| Example URL | https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/balances |
Response Data Fields
| Field | Description |
|---|---|
| accountNumber | The account number requested. |
| balanceAvailableForT1Trades | The balance available for T+1 trades. This includes settled cash as well as pending cash that will be settled on or before the T+1 settlement of a trade done today. |
| balanceAvailableForT2Trades | The balance available for T+2 trades. This includes settled cash as well as pending cash that will be settled on or before the T+2 settlement of a trade done today. |
| balanceAvailableForT3Trades | The balance available for T+3 trades. This includes settled cash as well as pending cash that will be settled on or before the T+3 settlement of a trade done today. This will be deprecated in Q4 of 2017. |
| balanceAvailableForWithdrawal | The balance available for withdrawal. |
| balanceWithheldFromT1Trades | The balance withheld from T+1 trades. |
| balanceWithheldFromT2Trades | The balance withheld from T+2 trades. |
| balanceWithheldFromT3Trades | The balance withheld from T+3 trades. This will be deprecated in Q4 of 2017. |
| balanceWithheldFromWithdrawal | The balance withheld from withdrawal. |
| settlementDateBalance | The balance of the account on the settlement date. |
| tradeDateBalance | The balance of the account on the trade date. |
Response Example
Status Code: 200 OK
Content-Type: application/json
Date: Mon, 30 Sep 2013 18:35:11 GMT
Server: Sun GlassFish Enterprise Server v2.1.1
Transfer-Encoding: chunked
X-Powered-By: Servlet/2.5
{
"accountNumber": "RA1234ABCD",
"balanceAvailableForT1Trades": "1971.20120",
"balanceAvailableForT2Trades": "1971.20120",
"balanceAvailableForT3Trades": "1971.20120",
"balanceAvailableForWithdrawal": "1971.20120",
"balanceWithheldFromT1Trades": null,
"balanceWithheldFromT2Trades": null,
"balanceWithheldFromT3Trades": null,
"balanceWithheldFromWithdrawal": null,
"settlementDateBalance": "1971.20120",
"tradeDateBalance": "1971.20120"
}
Change Log
08/11/2017
- Added balanceAvailableForT2Trades and balanceWithheldFromT2Trades
- Removed totalPendingWithdrawalRequests and accountId incorrectly listed in documentation.