Skip to main content
Use this guide when a response contains a field whose meaning is unclear. The references below define the fields and request parameters in the published API contract. They include types, required or optional presence, allowed values where defined, and defaults.

Companies and dividends

Company identity, public-directory membership, listing board, share information, and dividend amounts.

Price charts

Observations, chart formats, range statistics, coverage, and corporate-action adjustments.

Markets

Equity and ETF observations, valuation fields, and exchange session times.

Forecasts and analyst views

Contributor estimates, consensus, forecast outcomes, ratings, and price targets.

Filings and evidence

Disclosure subjects, extracted facts, mentions, board changes, and insider dealings.

Financial statements

Financial periods, currency conversion, source tables, and metric metadata.

Funds and holdings

NAV, AUM, returns, comparison changes, and portfolio weights.

Events and calendars

Business events, schedules, revisions, occurrence evidence, and calendar summaries.

News developments

Grouped news summaries, supporting articles, and stored price context.

Connect

Linking requests, connections, synchronization results, accounts, positions, and transactions.

Errors

Error categories, codes, messages, request IDs, and additional details.

​
Required, optional, and missing values

Required and nullable are separate properties. A required field must appear in the response, but its value can be null if the type permits it. An optional field can be absent. A default describes the API model’s default; it does not prove that a value was observed in a source. Treat null or an absent value as unavailable. Do not replace it with zero, false, an empty date, or an invented status. An empty collection means no records were returned for that selection. See Response conventions for response shapes, pagination, dates, and timestamps.

​
Company identity and public status

Use the company’s id for stable identity. ticker and symbol identify trading symbols, which can change over time. isin identifies a security when known. exchange, board, and market_classification describe its venue and listing classification. is_public controls whether Rangler includes the record in the public-company directory: is_public does not distinguish a delisted company from a suspended or private company. The published company response has no separate listing_status or delisting date. listed_on is the original listing date when known; it is not a delisting date. A retained exchange or board value does not establish current trading eligibility.

​
Percentage formats

Do not infer the numeric format from a field’s suffix alone. The API uses both fractions and percentage points. The forecast reference describes the different mean and median baselines. See the financial metric catalog for financial units and formulas.

​
Money, scale, and currency

Read the associated currency field before adding or comparing amounts. For example, use price_currency with a fund price and aum_currency with AUM. Different currencies are not directly comparable. Standardized financial amounts use the conventions in unit_convention and the metric catalog. Printed statement cells preserve source scale: interpret numeric_value with the column’s value_scale and currency. Disclosure-extracted filing figures can retain source conventions; use the standardized financial endpoints when you need consistent calculated metrics and units. market_cap_usd_m is in millions of US dollars. market_cap_value and market_cap are numeric amounts in their accompanying currency. market_cap_display is a formatted label for presentation; do not parse it to recover an amount. Currency-conversion fields explain the original currency, target currency, multiplier, rate date, and outcome. An unavailable conversion is missing data, not a zero amount. See Units and currency for financial conversion rules.

​
Status fields have different meanings

Use the status definition for the particular resource. A market-clock status describes whether a session is open or closed. A calendar status describes scheduling and occurrence evidence. A dividend status describes the dividend lifecycle. Connect connection and synchronization statuses describe different processes. Meeting media also separates the hosting platform’s live_status from Rangler’s media_status, which identifies a live stream, upcoming stream, replay, unknown state, or stale schedule. None of these status fields describes a company’s listing status. Allowed values shown in the reference come from the API schema. String fields without an enumerated list can contain source-dependent labels; tolerate values your application does not yet recognize.

​
Dates and freshness

Distinguish the observation’s date from the time Rangler stored it. as_of_date identifies the observation date, published_at identifies publication time, and created_at identifies record creation time. last_fetched_at describes source retrieval when available. A stored latest price or profile is not automatically a live observation. Use price timestamps, chart coverage, source publication dates, and conversion rate dates to assess freshness. The market clock’s holiday_adjusted: false means weekday hours were used without an exchange-holiday calendar.

​
Financial metric keys and flexible objects

The field references define named request and response fields. Dynamic metrics, ratios, and growth keys are defined in the versioned financial metric catalog. Match the returned catalog_version when caching definitions. Event data, source performance histories, and additional source metrics can contain resource-specific keys. Their reference entries explain that flexible shape; do not assume every source supplies the same keys. Ignore additions your integration does not use.