AM/TA/Inv - Get Position History

Details

/external/v1/position/history

Synopsis

Get Position History

get

This route is used to retrieve the history data entries of positions given a set of filters such as blockchain details or position identifiers. This endpoint returns paginated data. Up to 100 can be extracted 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).

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350

transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$

channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$

processIdsFilterstringOptional

The comma delimited list of transaction process ids to filter the position history records. Up to 100 records can be provided. Each record should be a UUID v4 value.

Example: bbb562cc-636a-48c0-9d77-ba1f1b15da07,

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 history

application/json

timestampstring · date-timeRequired

The timestamp of the action

Example: 2024-09-12T00:00:00.000Z

blockNumbernumberRequired

The block number where the position history was recorded.

Example: 350

transactionIdstringRequired

The transaction id where the position history was recorded.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

The name of the channel where the position history was recorded on the ledger.

Example: OG123

eventall ofRequired

The type of the position action.

Example: Created

string · enumOptional

The type of the position action.

Possible values:

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/history

HTTPcURLJavaScriptPython

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

[
  {
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    },
    "event": "Created",
    "update": {
      "positionId": "US9QIMAOAS1Q",
      "securityId": "US9QIMAOABCD",
      "accountId": "US9QIMAXYZTU",
      "dividendReinvestmentPlanElection": "reinvest",
      "status": "sync",
      "extraData": {
        "custom": "property Data"
      },
      "organization": {
        "name": "Test Organization",
        "orgId": "TEST1234"
      }
    },
    "signerData": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
]