FundamentalsPlanned coverage

Financial ratios

fundamentals.ratios.observations

Derived ratio observations with explicit calculation methods and inputs.

Planned plan access: Research, Professional
Schema version: 1.2.0
Record key: entity_id, accession_number, ratio_id, period_end, available_at, formula_version

How to request it

When this dataset appears in your account’s catalog, select its version, supported fields and exact entity identifiers. Set a short date range and an as_of time, then request a small page. The record key identifies a row; it is not necessarily the identifier accepted by the query filter.

HTTP request template

This is a template, not a currently available request. Fill each variable from the authenticated catalog and your intended query. The Explorer can generate a complete request for an available dataset.

GET /v1/data/fundamentals.ratios.observationsHTTP

curl --fail-with-body --get "$ORIGINFOLD_API_URL/v1/data/fundamentals.ratios.observations" \
  --header "Authorization: Bearer $ORIGINFOLD_API_KEY" \
  --data-urlencode "dataset_version=$DATASET_VERSION" \
  --data-urlencode "fields=$FIELDS" \
  --data-urlencode "entity_id=$ENTITY_ID" \
  --data-urlencode "start=$START_DATE" \
  --data-urlencode "end=$END_DATE" \
  --data-urlencode "as_of=$AS_OF" \
  --data-urlencode "limit=25"

See a complete illustrative HTTP and Python example, including what each request parameter means.

Field dictionary

nullable fields may be empty. An empty value is not zero. Types and definitions below come from the dataset schema; the released API may expose only a qualified subset.

Field	Type	Meaning
`dataset_id`	string	Logical dataset identifier.
`version_id`	uuidv7	Immutable origin fragment version identifier; copy-forward manifests retain it without rewriting prior rows.
`schema_version`	semver	Row schema version.
`source_id`	string	Approved official structured source identifier.
`available_at`	timestamp_utc	Earliest documented public source availability; never replaced by report or period time.
`ingested_at`	timestamp_utc	Successful structured acquisition time.
`source_sha256`	sha256	Checksum of the temporary or bounded structured source bytes.
`source_url`	uri	Official provider URL; never a local source-document URL.
`parser_version`	string	Versioned structured parser or method identifier.
`quality_flags`	list[string]	Machine-readable quality and source caveats.
`entity_id`	string	Stable reporting entity identifier.
`accession_number`	string	Source filing accession for the ratio inputs.
`ratio_id`	string	Governed ratio identifier.
`period_end`	date	Ratio reporting period end.
`value`	decimal128_38_10 May be empty	Derived ratio quantized to ten decimal places using the formula rounding rule.
`formula_version`	string	Immutable formula version.
`input_metric_refs`	list[string]	Exact canonical input row references.
`input_available_at_max`	timestamp_utc	Maximum input knowledge time.
`quality_state`	string	pass, warn, missing, or invalid.
`missing_reason`	string May be empty	Explicit missing/invalid reason.

Understand observation time, availability and revisions · Limits and errors