> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rangler.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Price charts fields

> Definitions, types, allowed values, and defaults for price charts.

Use this reference with the endpoint documentation. A required field must be present; a nullable field can still contain `null`. Missing data does not mean zero. See [Field guide](/field-guide) for unit and status conventions.

### `GET /v1/companies/{company_ref}/chart/compare`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_ref` | path | string | required | Primary NGX ticker symbol or Rangler company UUID. |
| `compare` | query | array of string or null | optional | NGX ticker or company UUID to compare. Up to three distinct peers are returned. |
| `period` | query | string | optional | Primary lookback window used when from is omitted. Older period values remain accepted for existing integrations and are listed in the price-chart guide. Allowed values: `1d`, `1w`, `1m`, `3m`, `ytd`, `1y`, `all`. Default: `"1y"`. |
| `basis` | query | string | optional | Indexed performance starts every series at 100; raw requires one shared currency. Allowed values: `indexed`, `raw`. Default: `"indexed"`. |
| `from` | query | string (date) or null | optional | Inclusive start date. Overrides period when provided. |
| `to` | query | string (date) or null | optional | Inclusive end date. |

### `GET /v1/companies/{company_ref}/chart`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_ref` | path | string | required | NGX ticker symbol or Rangler company UUID. |
| `period` | query | string | optional | Primary lookback window used when from is omitted. Older period values remain accepted for existing integrations and are listed in the price-chart guide. Allowed values: `1d`, `1w`, `1m`, `3m`, `ytd`, `1y`, `all`. Default: `"1y"`. |
| `from` | query | string (date) or null | optional | Inclusive start date. Overrides period when provided. |
| `to` | query | string (date) or null | optional | Inclusive end date. |
| `format` | query | string | optional | Detailed objects, compact line points, or complete OHLCV candles. Allowed values: `detailed`, `line`, `ohlcv`. Default: `"detailed"`. |
| `interval` | query | string or null | optional | Optional observation interval. Use hourly with period=1w and format=detailed. Allowed values: `hourly`. |

<a id="company-chart-comparison-point" />

## Company chart comparison point

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `date` | string (date) | required | Calendar date of the observation in YYYY-MM-DD format. |
| `values` | array of number or null | required | Values in the same order as the response's series array; null means no observation on this date. |

<a id="company-chart-comparison-response" />

## Company chart comparison

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `period` | string or null | optional | Requested chart window; null when an explicit date range is used. Allowed values: `1d`, `1w`, `1m`, `3m`, `ytd`, `1y`, `all`, `7d`, `30d`, `90d`, `6m`, `5y`, `max`. |
| `basis` | string | required | Comparison calculation basis, such as rebasing each series to a common starting value. Allowed values: `indexed`, `raw`. |
| `base_value` | number or null | optional | Starting value used for indexed comparison. Null for raw-price comparison. |
| `currency` | string or null | optional | Shared price currency for raw comparison. Null for indexed comparison. |
| `requested_start_date` | string (date) or null | optional | Requested inclusive first date; it can precede the first available observation. |
| `requested_end_date` | string (date) or null | optional | Requested inclusive last date; it can follow the last available observation. |
| `comparison_start_date` | string (date) or null | optional | First date in the aligned comparison window, after every non-empty series has begun. |
| `comparison_end_date` | string (date) or null | optional | Last date represented by at least one series in the aligned comparison window. |
| `count` | integer | required | Number of records or observations returned in this response. |
| `series` | array of [Company chart comparison series](/fields/charts#company-chart-comparison-series) | required | Compared securities and their actual available ranges. |
| `data` | array of [Company chart comparison point](/fields/charts#company-chart-comparison-point) | required | Returned records or observations. The item schema defines each element's fields. |

<a id="company-chart-comparison-series" />

## Company chart comparison series

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `symbol` | string | required | Trading symbol of the security. |
| `company_name` | string | required | Display name of the company. |
| `exchange` | string or null | optional | Exchange or trading venue code, such as NGX or NASD. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `start_date` | string (date) or null | optional | First date covered by the returned series or selection. |
| `end_date` | string (date) or null | optional | Last date covered by the returned series or selection. |
| `start_close` | number or null | optional | Closing price at the beginning of the comparison range. |
| `end_close` | number or null | optional | Closing price at the end of the comparison range. |
| `percentage_change` | number or null | optional | Fractional change from start\_close to the final returned close; 0.05 means 5%. |

<a id="company-chart-coverage" />

## Company chart coverage

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `earliest_available_date` | string (date) or null | optional | First close available in the complete stored history. |
| `latest_available_date` | string (date) or null | optional | Last close available in the complete stored history. |
| `earliest_candle_date` | string (date) or null | optional | First complete OHLCV candle inside the requested range. |
| `latest_candle_date` | string (date) or null | optional | Last complete OHLCV candle inside the requested range. |
| `requested_start_date` | string (date) or null | optional | Requested inclusive first date; it can precede the first available observation. |
| `requested_end_date` | string (date) or null | optional | Requested inclusive last date; it can follow the last available observation. |
| `available_points` | integer | required | Close observations in the complete stored history. |
| `returned_points` | integer | required | Observations returned for the requested range and format. |
| `candle_ready_points` | integer | required | Number of observations with complete, usable OHLCV values. |
| `incomplete_candle_points` | integer | required | Number of observations that cannot form usable OHLCV candles. |
| `omitted_incomplete_candles` | integer | required | Number of incomplete or inconsistent candles omitted from an OHLCV response. |
| `corporate_action_adjusted` | boolean | required | Whether historical prices have been adjusted for corporate actions. |
| `frequency` | string | optional | Observation frequency: intraday or daily. Allowed values: `daily`, `intraday`. Default: `"daily"`. |
| `freshness` | string | optional | Freshness category of the stored series; do not assume real-time quotes. Allowed values: `end_of_day`, `intraday`. Default: `"end_of_day"`. |

<a id="company-chart-detailed-point" />

## Company chart detailed point

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `timestamp` | string (date-time) | required | Timestamp of the observation, including its timezone. |
| `date` | string (date) | required | Calendar date of the observation in YYYY-MM-DD format. |
| `open` | number or null | optional | Opening price for the observation in currency. |
| `high` | number or null | optional | Highest traded price for the observation in currency. |
| `low` | number or null | optional | Lowest traded price for the observation in currency. |
| `close` | number | required | Closing or latest observed price for the observation in currency. |
| `volume` | number or null | optional | Number of security units traded during the observation. |
| `value_traded` | number or null | optional | Total traded value in the observation's currency. |
| `vwap` | number or null | optional | Volume-weighted average traded price in currency. |
| `trade_count` | number or null | optional | Number of reported trades during the observation. |
| `change` | number or null | optional | Absolute price change against the previous observation or close, in currency. |
| `percentage_change` | number or null | optional | Fractional daily change; 0.05 means 5%. |
| `candle_ready` | boolean | required | Whether the observation has complete and internally consistent OHLCV values. |

<a id="company-chart-detailed-response" />

## Company chart detailed

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `asset_type` | string | optional | Resource category: company for an issuer or fund for a linked fund security. Allowed values: `company`, `fund`. Default: `"company"`. |
| `symbol` | string | required | Trading symbol of the security. |
| `company_name` | string | required | Display name of the company. |
| `exchange` | string or null | optional | Exchange or trading venue code, such as NGX or NASD. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `period` | string or null | optional | Requested chart window; null when an explicit date range is used. Allowed values: `1d`, `1w`, `1m`, `3m`, `ytd`, `1y`, `all`, `7d`, `30d`, `90d`, `6m`, `5y`, `max`. |
| `count` | integer | required | Number of records or observations returned in this response. |
| `as_of_date` | string (date) or null | optional | Calendar date to which these observations or values apply. |
| `statistics` | [Company chart statistics](/fields/charts#company-chart-statistics) | required | Summary of the returned price range, including first/last close and change. |
| `coverage` | [Company chart coverage](/fields/charts#company-chart-coverage) | required | Available history, returned counts, candle completeness, frequency, and adjustment information. |
| `format` | string | optional | Response or document format; its allowed values are shown in the field schema. Allowed values: `detailed`. Default: `"detailed"`. |
| `data` | array of [Company chart detailed point](/fields/charts#company-chart-detailed-point) | required | Returned records or observations. The item schema defines each element's fields. |

<a id="company-chart-line-response" />

## Company chart line

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `asset_type` | string | optional | Resource category: company for an issuer or fund for a linked fund security. Allowed values: `company`, `fund`. Default: `"company"`. |
| `symbol` | string | required | Trading symbol of the security. |
| `company_name` | string | required | Display name of the company. |
| `exchange` | string or null | optional | Exchange or trading venue code, such as NGX or NASD. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `period` | string or null | optional | Requested chart window; null when an explicit date range is used. Allowed values: `1d`, `1w`, `1m`, `3m`, `ytd`, `1y`, `all`, `7d`, `30d`, `90d`, `6m`, `5y`, `max`. |
| `count` | integer | required | Number of records or observations returned in this response. |
| `as_of_date` | string (date) or null | optional | Calendar date to which these observations or values apply. |
| `statistics` | [Company chart statistics](/fields/charts#company-chart-statistics) | required | Summary of the returned price range, including first/last close and change. |
| `coverage` | [Company chart coverage](/fields/charts#company-chart-coverage) | required | Available history, returned counts, candle completeness, frequency, and adjustment information. |
| `format` | string | optional | Response or document format; its allowed values are shown in the field schema. Allowed values: `line`. Default: `"line"`. |
| `data` | array of tuple: \[string (date), number] | required | Returned records or observations. The item schema defines each element's fields. |

<a id="company-chart-ohlcv-response" />

## Company chart OHLCV

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `asset_type` | string | optional | Resource category: company for an issuer or fund for a linked fund security. Allowed values: `company`, `fund`. Default: `"company"`. |
| `symbol` | string | required | Trading symbol of the security. |
| `company_name` | string | required | Display name of the company. |
| `exchange` | string or null | optional | Exchange or trading venue code, such as NGX or NASD. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `period` | string or null | optional | Requested chart window; null when an explicit date range is used. Allowed values: `1d`, `1w`, `1m`, `3m`, `ytd`, `1y`, `all`, `7d`, `30d`, `90d`, `6m`, `5y`, `max`. |
| `count` | integer | required | Number of records or observations returned in this response. |
| `as_of_date` | string (date) or null | optional | Calendar date to which these observations or values apply. |
| `statistics` | [Company chart statistics](/fields/charts#company-chart-statistics) | required | Summary of the returned price range, including first/last close and change. |
| `coverage` | [Company chart coverage](/fields/charts#company-chart-coverage) | required | Available history, returned counts, candle completeness, frequency, and adjustment information. |
| `format` | string | optional | Response or document format; its allowed values are shown in the field schema. Allowed values: `ohlcv`. Default: `"ohlcv"`. |
| `data` | array of tuple: \[string (date), number, number, number, number, number] | required | Returned records or observations. The item schema defines each element's fields. |

<a id="company-chart-statistics" />

## Company chart statistics

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `first_close` | number or null | optional | First available closing price in the selected series. |
| `last_close` | number or null | optional | Last available closing price in the selected series. |
| `min_close` | number or null | optional | Lowest closing price in the selected series. |
| `max_close` | number or null | optional | Highest closing price in the selected series. |
| `net_change` | number or null | optional | Absolute price change in the security's price currency. |
| `percentage_change` | number or null | optional | Fractional change across the returned range; 0.05 means 5%. |
| `start_date` | string (date) or null | optional | Date of the close used as this series' performance base. It may precede the comparison start for a sparsely traded security. |
| `end_date` | string (date) or null | optional | Last date covered by the returned series or selection. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.