Skip to main content
POST
/
v1
/
tools
/
stock_flag
curl
curl -sS "https://api.stockcontext.com/v1/tools/stock_flag" \
  -H "X-API-Key: $STOCKCONTEXT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"AAPL","field":"revenue","period":"2025-09-27","reason":"Value looks inconsistent with the cited filing.","schema":2}'
{ "subject": { "entity": { "cik": "0000320193", "name": "Apple Inc." }, "security": { "ticker": "AAPL" } }, "data": { "received": true, "flag_id": "flag_00000001" }, "meta": { "schema_version": "2" } }

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

Ticker or resolvable symbol.

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. Use 1 for the current default wire and 2 for the schema-2 envelope. 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.