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.

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

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

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

The account number of the Account associated with this lot

The advisor code of the Account associated with this lot

The custodian reported lot identifier if applicable

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

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