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

Get Folio Transactions

This request returns a summary of transactions for a folio within a member’s brokerage account.

Request URL

Syntax GET /restapi/accounts/{accountnumber}/folios/{folionumber}/transactions
Example URL https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03/transactions?dateRange=1m&ticker=AMZN,APPL&category=Deposits&subcategory=CASH&cashsweep=N

Request Query Parameters

Parameter Required? Description
daterange N Default to 3 days. It can be a date range. The format of a date should be “MM-dd-yyyy”. The start date and the end date should be separated by a comma, (“,”). For example, “daterange=11-01-2013,09-01-2014”. In additional to a customdate range, the value of daterange parameter could also be a code. See the other valid codes in Date Range Codes table below.
category N Transaction category name. See Transaction Codes
subCategoryName N Transaction sub category name. See Transaction Codes
ticker N Ticker symbol. You can pass mutiple tickers as comma delimited string, for example ticker="AMZN,AAPL,FB"
cashsweep N Default to 'Y'. Indicator for showing cash sweep transactions or not. 'Y' means show. 'N' means not show.

Response Data Fields

Field Values Description
categoryName see Transaction Codes Transaction category name
commission Trade commission
date Date in ISO-8601 format
folioName Name of folio
marketNet Used for internal transfers, same value as 'net'
marketPrice Used for internal transfers, same value as 'price'
net Net dollar value
notes Additional notes on transaction (If applicable)
price Price per share
quantity Quantity of shares
subCategoryName see Transaction Codes Sub category of the transaction categoryName
symbolName Name of security
ticker Ticker
transactionCode see Transaction Codes Folio transaction code
transactionDesc see Transaction Codes Description of transaction
transactionType see Transaction Codes Additional information on type of transaction

Date Range Codes

Code Description
3d Three days
5d Five days
10d Ten days
30d Thirty days
1m One month
3m Three months
6m Six months
12m Twelve months
1y One year
3y Three years
5y Five years
Mtd Month to date
Ytd Year to date

Category and Sub-category names

Please reference Get Account Transactions Transaction Codes

Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/folios/RA1234ABCD03/transactions
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 July 2014 17:51:06 GMT
[
{
  "categoryName" : "Trades",
  "commission" : "0.00000",
  "date" : "2014-07-04T00:00:00.000-04:00",
  "folioName" : "folio name",
  "marketNet" : "0.00000",
  "marketPrice" : "0.00000",
  "net" : "29.02025",
  "notes" : "ACH DEPOSIT",
  "price" : "49.92645",
  "quantity" : "0.58126",
  "subCategoryName" : "Reinvestments",
  "symbolName" : "VERIZON COMMUNICATIONS INC.",
  "ticker" : "VZ",
  "transactionCode" : "B",
  "transactionDesc" : "Buy",
  "transactionType" : "Reinvestments"
},
{
  "categoryName" : "Trades",
  "commission" : "0.00000",
  "date" : "2014-07-04T00:00:00.000-04:00",
  "folioName" : "folio name",
  "marketNet" : "0.00000",
  "marketPrice" : "0.00000",
  "net" : "50.85014",
  "price" : "51.16995",
  "quantity" : "0.99375",
  "subCategoryName" : "Reinvestments",
  "symbolName" : "GENERAL MLS INC",
  "ticker" : "GIS",
  "transactionCode" : "B",
  "transactionDesc" : "Buy",
  "transactionType" : "Reinvestments"
},
{
  "categoryName" : "Trades",
  "commission" : "0.00000",
  "date" : "2014-07-04T00:00:00.000-04:00",
  "folioName" : "folio name",
  "marketNet" : "0.00000",
  "marketPrice" : "0.00000",
  "net" : "78.13985",
  "price" : "35.31601",
  "quantity" : "2.21259",
  "subCategoryName" : "Reinvestments",
  "symbolName" : "AT&T INC COM",
  "ticker" : "T",
  "transactionCode" : "B",
  "transactionDesc" : "Buy",
  "transactionType" : "Reinvestments"
}
]

Change Log

03/24/2017

  1. Update Response Data Fields
  2. Update Date Range Codes
  3. Update Response Example
  4. Added Category and Sub-category names

11/03/2016

  1. Added additional query paramenters

08/19/2016

  1. Updated Response Data Fields

02/01/2016

  1. Updated descriptions

Getting Started

REST APIs

Resources

Developer Home