V0
Filings
HAS_MCP_EQUIVALENT

List Guidance

Forward-looking guidance issued by public companies, grouped into series with revision history.

post/v0/filings/list_guidance

Request

  • Base URL: https://api.ultralayer.ai
  • URL: https://api.ultralayer.ai/v0/filings/list_guidance
  • 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.

source_typesstring[] nullable

Match any. Document class the observation was read from.

revision_directionstring[] nullable

Match any; latest observation only.

sort'timestamp' | 'guided_period_end' | 'comparable' | 'revision_delta'

timestamp: recently updated; guided_period_end: period date; comparable: strongest like-for-like number in the match set; revision_delta: largest midpoint move.

values_mode'all' | 'latest'

all: revision history, newest first; latest: newest observation only.

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

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

Example request

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

Response

Guidance series at detail=full.

symbolstring required

Listing symbol of the filer.

company_namestring nullable required

Filer name.

cikinteger nullable required

SEC CIK of the filer.

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.

observation_countinteger required

Observations in this series as of the request end timestamp.

Changes

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