Filings

HAS_MCP_EQUIVALENT

List Guidance Outcomes

Company guidance versus the reported actual.

post/v0/filings/list_guidance_outcomes

Request

Base URL: https://api.ultralayer.ai
URL: https://api.ultralayer.ai/v0/filings/list_guidance_outcomes
Auth: HTTP bearer

Request body

start_timestampstring date-time nullable

System timestamp; Inclusive ISO 8601

end_timestampstring date-time nullable

System timestamp; Inclusive ISO 8601; null=realtime

limitinteger

symbolsstring[] nullable

Match any.

metric_keysstring[] nullable

Match any.

metric_key_exact_matchboolean

true: exact metric_keys, case-insensitive; false: case-insensitive substring. Ignored without metric_keys.

metric_basisstring[] nullable

Match any.

segmentsstring[] nullable

Match any. 'null' is consolidated.

guided_period_typestring[] nullable

Match any.

guided_fiscal_yearinteger nullable

guided_fiscal_quarterinteger nullable

guided_period_end_fromstring date nullable

Inclusive guided period-end date.

guided_period_end_tostring date nullable

Inclusive guided period-end date.

detail'full' | 'standard' | 'essential'

essential:identity; standard:citable; full:all.

outcomesstring[] nullable

Match any. Omit: resolved labels only.

sort'timestamp' | 'outcome_abs'

timestamp: newest actual first; outcome_abs: largest |score| first.

Example request

{
  "symbols": [
    "NVDA",
    "AAPL"
  ],
  "metric_keys": [
    "revenue"
  ],
  "segments": [
    "null"
  ]
}

Response

Guidance outcomes at detail=full.

symbolstring required

Listing symbol of the filer.

company_namestring nullable required

Filer name.

cikinteger nullable required

SEC CIK of the filer.

timestampstring date-time required

System timestamp of the outcome.

source_timestampstring date-time required

When the actual became public.

metric_keystring required

Normalized metric identity.

metric_basis'gaap' | 'non_gaap' | 'unspecified' required

gaap, non_gaap, or unspecified.

segmentstring nullable required

Segment cut; null for consolidated guidance.

guided_period_type'quarter' | 'fiscal_year' | 'half' | 'multi_year' | 'other' required

Kind of period being guided.

guided_fiscal_yearinteger required

Filer fiscal year of the guided period.

guided_fiscal_quarterinteger nullable required

Filer fiscal quarter of the guided period; null for a full year.

guided_period_end_datestring date nullable required

Calendar day the guided period ends.

guidance_source_typestring required

Document class the scored guide was issued from.

actual_source_typestring required

Document class the actual was reported in.

Judgment of the actual against the guide.

rationalestring required

Why this outcome label.

guidance_quotestring required

Stating sentence of the scored guide.

actual_quotestring required

Sentence or table row the actual was read from.

Shape of the stated guide.

value_form'absolute' | 'relative' required

absolute is a level; relative is a change vs a temporal base.

value_lownumber nullable required

Lower bound of the scored guide as stated.

value_highnumber nullable required

Upper bound of the scored guide as stated.

value_midpointnumber nullable required

Midpoint of the scored guide as stated.

Unit of the stated guide.

currencystring nullable required

ISO currency code when unit is currency.

actual_valuenumber nullable required

Reported actual, scaled.

actual_unitstring nullable required

Unit of the reported actual.

comparability'comparable' | 'not_comparable' required

Whether the actual can be scored against the guide.

vs_midpoint_deltanumber nullable required

Actual minus guide midpoint, in the comparison unit.

vs_midpoint_delta_pctnumber nullable required

Actual vs midpoint as a percent of the midpoint; 5.0 means 5% above.

vs_low_deltanumber nullable required

Actual minus guide low bound.

vs_high_deltanumber nullable required

Actual minus guide high bound.

Changes

No recorded changes to this operation across all 1 revision of this API.