GET /api/v1/agents/position-read
Last verified
Auto-generated. This article is rebuilt from FastAPI route introspection by
scripts/build_api_kb.py. Edit the route docstring inapp/and re-run the script — do not edit this file directly.
GET /api/v1/agents/position-read
Handler: app.signals.routes.get_agents_position_read
Methods: GET
Description
Translate the current market signal set into per-position relevance.
Given a position (symbol + side + optional option type), returns the
subset of active alerts and category implications that materially
affect that position. The category→position-kind mapping lives in
app/signals/config/position_relevance.json so the relevance rules are
auditable in one place rather than hard-coded into the route.
Parameters
| In | Name | Type | Default | Description |
|---|---|---|---|---|
| query | symbol |
str |
PydanticUndefined |
Underlying ticker (e.g. SPY, XLE, TLT). Case-insensitive. |
| query | side |
str |
'long' |
‘long’ or ‘short’ position direction. |
| query | type |
Optional[str] |
Option type: ‘call’ or ‘put’. Omit for stock/ETF positions. | |
| query | expiry |
Optional[str] |
Option expiry YYYY-MM-DD. Currently unused for relevance scoring; kept for forward compatibility. | |
| query | strike |
Optional[float] |
Option strike. Currently unused for relevance scoring; kept for forward compatibility. |
Curl
curl -s https://bigclawd.com/api/v1/agents/position-read