Skip to main content
POST
curl

Authorizations

X-API-Key
string
header
required

Body

application/json

Request body for stock_search. The model requires exactly one of query or q.

query
string | null

Canonical schema-2 search term. Send exactly one of query or q.

Required string length: 1 - 128
q
string | null

Schema-1 search term alias. Send exactly one of q or query.

Required string length: 1 - 128
limit
integer
default:10

Maximum matches to return.

Required range: 1 <= x <= 50
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

Resolve securities by ticker, company name, or CIK. 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.