Skip to content
Purser

List Position Events

GET
/positions/{position_id}/events
curl --request GET \
  --url https://example.com/positions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events

Every event of the position, reversals included, newest first.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
position_id
required
Position Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Position Events Positions Position Id Events Get
Array<object>
PositionEventOut
object
cost_basis
required
Any of:
string
created_at
required
Created At
string format: date-time
fees
required
Any of:
string
id
required
Id
string format: uuid
kind
required
Kind
string
Allowed values: set_quantity buy sell
note
required
Any of:
string
occurred_on
required
Occurred On
string format: date
origin
required
Origin
string
Allowed values: manual agent import
position_id
required
Position Id
string format: uuid
price
required
Any of:
string
quantity
required
Quantity
string
replaces_id
required
Any of:
string format: uuid
reversed_by
required
Any of:
string format: uuid
reverses_id
required
Any of:
string format: uuid
source_note
required
Any of:
string

Example 

[
  {
    "kind": "set_quantity",
    "origin": "manual"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}