Skip to content
noxstock
Reference

Response model

Success envelopes, error envelopes, common fields, and unsupported responses.

Success envelope

{
  "data": {
    "symbol": "AAPL",
    "freshness": "intraday",
    "as_of": "2026-06-02T18:32:10Z"
  }
}

Error envelope

{
  "error": {
    "code": "SYMBOL_UNKNOWN",
    "message": "Symbol 'XYZ' is not in the supported universe. Use /v2/search to discover supported tickers.",
    "retryable": false
  }
}

Common success fields

FieldNotes
symbolResolved symbol for symbol endpoints.
freshnessintraday, end_of_day, stale, degraded, or unsupported.
market_statusopen or closed; omitted on stateless lookup routes.
as_ofUpstream timestamp when available, otherwise response generation time.
currencyPresent only when monetary values are in the payload.
periodPresent on period-based endpoints such as fundamentals/history.
asset_typePresent where stock/ETF shape branches.

Unsupported response

When an endpoint does not apply, noxstock returns success with freshness: "unsupported" instead of pretending the data exists.

{
  "data": {
    "symbol": "SPY",
    "asset_type": "etf",
    "freshness": "unsupported",
    "reason": "ETFs do not report earnings",
    "as_of": "2026-06-02T18:32:10Z",
    "market_status": "open"
  }
}

Null policy

  • Meaningful sometimes-null fields may appear as null.
  • Persistent source gaps are omitted where the schema allows.
  • Financial-company guardrails suppress metrics that are misleading for bank-like issuers.