openapi: 3.1.0
info:
  title: Broadridge Wealth Management Accounts Positions API
  description: The Broadridge Wealth Management API provides access to account activity, balances, positions, and transaction data for wealth management platforms. REST APIs enable broker-dealers and RIAs to integrate Broadridge back-office clearing and custody data into front-office wealth management applications.
  version: 1.0.0
  contact:
    name: Broadridge Developer Contact
    url: https://www.broadridge.com/resource/developer-api-contact
servers:
- url: https://api.broadridge.example.com
  description: Broadridge Wealth API
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Positions
  description: Portfolio positions and holdings
paths:
  /wealth/v1/accounts/{accountNumber}/positions:
    get:
      operationId: getAccountPositions
      summary: Get account positions
      description: Retrieve all securities holdings/positions in an account.
      tags:
      - Positions
      parameters:
      - name: accountNumber
        in: path
        required: true
        schema:
          type: string
      - name: asOfDate
        in: query
        schema:
          type: string
          format: date
      - name: assetClass
        in: query
        schema:
          type: string
          enum:
          - Equity
          - FixedIncome
          - MutualFund
          - ETF
          - Options
          - Cash
          - Alternative
      responses:
        '200':
          description: Account positions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PositionList'
components:
  schemas:
    PositionList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Position'
        totalMarketValue:
          type: number
    Position:
      type: object
      properties:
        positionId:
          type: string
        accountNumber:
          type: string
        cusip:
          type: string
        symbol:
          type: string
        securityDescription:
          type: string
        assetClass:
          type: string
          enum:
          - Equity
          - FixedIncome
          - MutualFund
          - ETF
          - Options
          - Cash
          - Alternative
        quantity:
          type: number
        price:
          type: number
        marketValue:
          type: number
        costBasis:
          type: number
        unrealizedGainLoss:
          type: number
        unrealizedGainLossPct:
          type: number
        currency:
          type: string
        asOfDate:
          type: string
          format: date
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.broadridge.example.com/oauth/token
          scopes:
            accounts:read: Read account data
            positions:read: Read position data
            transactions:read: Read transaction data
    bearerAuth:
      type: http
      scheme: bearer