positions.add

write

Add position

Records one open position per leg for the signed-in user. Use dry_run to preview the rows without saving.

Free with an account. Requires a key or OAuth token with the write scope.

Input

Field	Type	Description
legs*	object[]	1–4 legs, each with an entry price
opened_at	string	Defaults to today
notes	string
strategy_type	string	Free-form label, e.g. "Vertical spread"

* required

Output

Returned under data; every response also carries meta with freshness, as_of and truncated.

Field	Type	Description
dry_run*	boolean	True when dry_run was requested: nothing was persisted; other fields show the would-be result
positions*	object[]

* required

Example request

Single long call from an OCC symbol

curl -X POST "https://impliedoptions.com/api/v1/tools/positions.add" \
  -H "Authorization: Bearer <YOUR_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "args": {
      "legs": [
        {
          "occ": "SPY260918C00620000",
          "qty": 2,
          "price": 6.47
        }
      ],
      "notes": "Post-CPI drift"
    }
  }'

Rendered result: /performance?tab=current

positions.add

Input

Output

Example request

Run