Skip to main content
POST
curl

Authorizations

X-API-Key
string
header
required

Body

application/json

Request body for stock_flag. stock_flag is v2-native and always returns a schema-2 envelope.

symbol
string
required

The EXACT canonical ticker of the value you are flagging - copy it verbatim from that response's subject.security.ticker (every tool response carries it). Unlike the read tools, stock_flag does NOT resolve aliases (a secondary share class like GOOG->GOOGL, or a renamed-away ticker), so the flag lands against the precise security the report named; a symbol that is not its own stored security refuses no_match.

Required string length: 1 - 32
field
string
required

Served field token being flagged.

Required string length: 1 - 64
period
string | null

Optional period label or period_end for the flagged value.

Required string length: 1 - 32
reason
string | null

Optional free-text reason for human triage.

Required string length: 1 - 500
claimed_value
string | null

Optional value the caller expected to see.

Required string length: 1 - 128
schema
enum<integer>
default:2

Response schema selector. Omit (or send 2) for the schema-2 envelope, the default; 1 selects the frozen legacy wire. Boolean values are rejected by the API boundary.

Available options:
1,
2

Response

Flag a served value for human triage. Envelope-level schema; captured examples remain authoritative for full nested payload detail.

Schema-2 envelope. The OpenAPI schema is structural; captured examples are authoritative for full nested payload detail.

data
object
required

Tool payload or typed schema-2 refusal.

meta
object
required

Schema-2 metadata. Unknown optional fields are omitted, not emitted as null.

subject
object

Resolved entity and security when the tool has a single subject.