@livefolio/sdk / AdjustOrder

Type Alias: AdjustOrder

AdjustOrder = object

Defined in: orders/types.ts:84

Adjusts fields of an existing position without fully closing it. Currently supports changing quantity (e.g. after a corporate action). Cash is not affected other than deducting fees.

Example

import type { AdjustOrder } from '@livefolio/sdk';

const order: AdjustOrder = {
  id:         'ord_003',
  kind:       'adjust',
  positionId: 'pos_1',
  changes:    { quantity: 150 },
};

Properties

changes

changes: object

Defined in: orders/types.ts:94

Fields to update. Currently only quantity is supported. Omitting a field leaves it unchanged.

quantity?

optional quantity?: number

---

id

id: string

Defined in: orders/types.ts:86

Caller-supplied identifier carried back on the resulting Fill via orderRef.

---

kind

kind: "adjust"

Defined in: orders/types.ts:87

---

positionId

positionId: PositionId

Defined in: orders/types.ts:89

ID of the Position to modify.