Add-on, the official ruler

Add-on, the official ruler: the band and threshold ladder published by the source agency, its classification, and distance-to-action. NOT every line has an official ruler - pure market quotes do not. When it does not, you get 422 with no_charge:true and reason:no-ruler-for-this-line and you are NOT billed. Never a bag of nulls you paid for. Every record carries an offline-recomputable record_hash. Also searched as: unit definition; measurement scale; metric dictionary.

get/gauge/ruler

Request

Base URL: https://api.truthbear.co
URL: https://api.truthbear.co/gauge/ruler
Auth: none declared

Query parameters

signal_idstring required

Example:hydrology.river-level

required - signal id (genus.species); free list at GET /gauge/catalog (paged; ?all=1 for every line)

entitystring required

Example:07010000

required - monitored object id, paired with signal_id; free list at GET /gauge/catalog?signal_id=<signal_id> -> signals[0].entities[]

Response

Paid response

naturestring required

Neutrality statement: GAUGE supplies observations and trend description only - no judgement, no prediction, no recommendation

dimstring required

Always the literal "ruler"

signal_idstring

Signal id in genus.species ASCII binomial form (e.g. crypto.spot / macro.unemployment / shipping.route-disruption); full list at free /gauge/catalog

entitystring

Monitored object id (e.g. btc / us / hormuz); full list at free /gauge/catalog or /gauge/preview

entity_namestring nullable

Human-readable name of the object

observed_atstring

Actual observation time of the data, ISO-8601

data_age_hoursnumber nullable

Age frozen at collection time (0 = same hour), for reference only - if a collector stalls this field stops moving. For freshness always use provenance.age_hours_now (computed at request time) and provenance.freshness; the threshold basis is in provenance.freshness_basis

source_agreement_cvnumber nullable

Multi-source agreement, coefficient of variation (smaller = closer agreement). Present ONLY when two or more CONFIRMED-INDEPENDENT sources measure the same fact at the same time - see sources[].independent. Same source relayed through two channels does not count as independent, and two different time bases (daily mean vs spot) do not count as agreement. Single-source / unconfirmed independence / not applicable -> null

rulerobject nullable required

Official-ruler projection: band / thresholds / official category / distance to action / standard

record_hashstring nullable

sha256:<64hex> (contract A v3, binds the values plus provenance)

record_hash_verifiableobject nullable

{mode:offline|via-endpoint, note}

decision_pointsobject nullable

{count, points:[{tag,current,swappable,how}], note} - decision points you can re-run with a swapped tag (one swapped tag = one call); leave it alone and the original context is the default, at no extra charge

provenanceobject nullable

Data lineage: {served_from, data_as_of, oldest_leg_as_of, data_age_hours (frozen age, reference only), age_hours_now (age computed at request time - the real basis for freshness), freshness(fresh|recent|stale), freshness_basis (the cadence and threshold used for this row, as a string), dead_source (optional: upstream frozen or discontinued), data_lineage:[{signal,traceable_to,uncertainty,record_hash,...}], validation_status}. Freshness is cadence-aware, so monthly/quarterly/annual official lines are not misjudged against a 24h rule; the same basis is used by free /gauge/coverage. Buyers can trace back to the official source

source_refstring nullable

Official source URL (provenance)

gradestring nullable

Honest data-grade disclosure (e.g. "screening-level, not decision-grade")

scopestring nullable

Honest statement of scope and limits: monitoring is not forecasting, intelligence is not instruction, and the boundary of what is verifiable

_citationobject nullable

Offline-verifiable citation: {statement_type, not_advice:bool, claim, fact, source, record_hash, signature(Ed25519), key_id, issuer_DID(did:key), verify_url} - the trust root for zero-trust self-verification

Changes

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