Filter all position records

post

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

Returns a filtered list of position 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 position

account_id

integer

The id of the Account associated with this Position

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 Position

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 position 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 Position

advisor_code

string

The advisor code of the Account associated with this Position

reported_date

date-time

required

The date the custodian reports the position

direction

string

enum

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

Allowed:

abs_units

float

The quantity of shares for the reported position

abs_settled_units

float

The quantity of settled shares for the reported position

market_value_unit_price

float

The end of day price of the asset

abs_cost_basis

float

The total cost basis value of the position as aggregated from reported open lots

cost_basis_fully_known

boolean

True if the cost basis for all shares in this positions are fully known

reported_unrealized_gain_loss

float

The unrealized gains or losses of the position if reported by the source

calculated_unrealized_gain_loss

float

The unrealized gains or losses of the position as calculated by comparing current market value to aggregated cost basis

created_at_utc

date-time

Timestamp for when the record was created

Responses

200An enveloped list of positions

400Bad Request