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://api.uat.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
accountId		Account identifier for Folio transaction occurred in
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
transactionId		Transaction identifier
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
Date: Thu, 14 Mar 2019 17:53:15 GMT
Transfer-Encoding: chunked
Location: https:// testapi api . uat. foliofn.com/restapi/accounts/RB18938005/folios/RB189380052W/transactions
Content-Type: application/json

[
  {
    "accountId" : "2445361",
    "categoryName" : "Distributions",
    "commission" : "0.00000",
    "date" : "2016-01-08T00:00:00.000-05:00",
    "folioName" : "Mid/Large Cap Blend",
    "marketNet" : "0.00000",
    "marketPrice" : "0.00000",
    "net" : "0.36000",
    "notes" : "",
    "price" : "0.00000",
    "quantity" : "0.77285",
    "subCategoryName" : "Dividends",
    "symbolName" : "MERCK & CO INC",
    "ticker" : "MRK",
    "transactionCode" : "CDIR",
    "transactionDesc" : "Cash Dividend Receipt",
    "transactionId" : "108",
    "transactionType" : "Dividend"
  }
]