Filter all lot records

post

https://api.bridgeft.com/v2/data/source/lots/filter

Returns a filtered list of lot records

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pager.limit

integer

Number of items to return per page

pager.page

integer

Current page number

string

Select data related to identifiers in the response data. When a related query parameter is selected, a new json field will be populated in the response with a map of the relevant related data.

** Example **

GET https://api.bridgeft.com/v2/{selectedResource}?related=accounts

Response:

{
  "object": "object"
  "has_next": true,
  "has_previous": false,
  "current_page": 1,
  "total_pages": 10,
  "page_size_limit": 100,
  "has_next": true,
  "data": [
    {
      id: 1,
      account_id": "SOMEACCOUNTID1",
      ...
    },
    {
      id: 1,
      account_id": "SOMEACCOUNTID2",
      ...
    }
  ]
  "accounts": {
    "SOMEACCOUNTID1": {
      id: "SOMEACCOUNTID1",
      ...
    },
    "SOMEACCOUNTID2": {
      id: "SOMEACCOUNTID2",
      ...
    }
  }
}

Populating the related query parameter will pull additional information in the request for supported related data without reaching out to an additional endpoint.

See dropdown for the supported related fields for the resource.

Body Params

integer

The unique resource id for the lot

account_id

integer

The id of the Account associated with this lot

account_ids

array of integers

Provide a list of Account IDs to filter.

account_ids

security_id

integer

The id of the Security associated with this lot

source_security_symbol

string

The symbol of the corresponding security as reported by the source if applicable

source_security_cusip

string

The cusip of the corresponding security as reported by the source if applicable

source

string

enum

Custodian or source the lot data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services

account_number

string

The account number of the Account associated with this lot

advisor_code

string

The advisor code of the Account associated with this lot

reported_date

date-time

required

The date the custodian reports the lot

lot_identifier

string

The custodian reported lot identifier if applicable

abs_current_quantity

float

The quantity of shares for the reported lot

abs_current_market_value

float

The market value of the shares for the reported lot

abs_cost_basis

float

The total cost of the shares for the reported lot

abs_adjusted_cost_basis

float

The total adjusted cost of the shares for the reported lot

unrealized_gain_loss

float

The current unrealized gains for the lot if reported

acquisition_date

date-time

The date that the corresponding lot was initially opened (even outside of the current account)

abs_acquisition_quantity

float

The original quantity of shares which opened the corresponding lot

direction

string

enum

Flag to indicate if lot is Long or Short. Potential values, L = Long, S = Short

Allowed:

fully_known

boolean

True if the cost basis for this lot is fully known

wash_sale

boolean

True if the lot is affected by a wash sale

disallowed_loss_amount

boolean

True if the lot amount is disallowed

certified

boolean

True if the cost basis is certified

lot_selection_method

string

The lot selection method of the lot if reported by the source

created_at_utc

date-time

Timestamp for when the record was created

Responses

200An enveloped list of lots

400Bad Request