Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get a Folio

This request returns the summary of folios for a brokerage account.

Request URL

Syntax GET /restapi/accounts/{accountnumber}/folios/{folionumber}
Example URL https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03

Response Data Fields

Field Description
folioNumber The folio number.
folioName The folio name. The maximum length of folioName is 16 characters.
accountNumber The account number to which the folio belongs.
dividendReinvest A Boolean indicator of whether dividend of $1 or more will be reinvested to the securities that paid the dividend. “true” or “false”.
dividendPayToAccount An indicator of whether dividend should be paid to account. “true” or “false”.
benchmark The security, index, or composite to be used by default when comparing performance.
prepackagedFolioId The prepackaged folio ID if this folio was created from a prepackaged folio.
folioStatus The status of a folio. The available statuses are:
“O” for open,
“C” for closed, and
“D” for deleted.
modelOid The identifier of a model if this folio was subscribed to a model.

Response Example


Status Code: 200 OK
Content-Type: application/json
Date: Mon, 30 Sep 2013 20:51:29 GMT
Link: <https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03/orders>; rel="GET"; type="text/html"; title="getOrders", <https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03/orders>; rel="POST"; type="application/json"; title="postOrder", <https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03/positions>; rel="GET"; type="application/json"; title="getPositions"
Location: https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03
Server: Sun GlassFish Enterprise Server v2.1.1
Transfer-Encoding: chunked
X-Powered-By: Servlet/2.5

{
  "folioNumber": "RA1234ABCD03",
  "folioName": "RTG Trading",
  "accountNumber": "RA1234ABCD",
  "dividendReinvest": false,
  "dividendPayToAccount": false,
  "prepackagedFolioId": "123124324234123",
  "folioStatus": "O"
}

Change Log

10/08/2015

  1. New field: “dividendPayToAccount”

Getting Started

REST APIs

Resources

Developer Home