AM/FA/Inv - Get Position Details

Details

/external/v1/position

Synopsis

Get Position Details

get

This route is used to retrieve the details of positions, given a set of search filters. This endpoint is paginated, up to 100 records can be retrieved per call. This endpoint can be called by applications with access to scope "readPosition".

Required scopes

This endpoint requires the following scopes:

• : readPosition

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

positionIdsFilterstringOptional

The comma delimited list of position ids to filter the position records. Up to 100 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

Responses

200

Successfully retrieved the position details

application/json

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/position

HTTPcURLJavaScriptPython

GET /external/v1/position HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "dividendReinvestmentPlanElection": "reinvest",
    "status": "sync",
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "positionId": "TEST1234",
    "securityId": "TEST1234",
    "accountId": "TEST1234"
  }
]