> ## 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.

# Filings and disclosure evidence fields

> Definitions, types, allowed values, and defaults for filings and disclosure evidence.

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_id}/filings`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | path | string (uuid) | required | Filter or identify a company using its stable Rangler identifier. |
| `cursor` | query | string or null | optional | Opaque next-page cursor returned by the preceding response; pass it unchanged. |
| `type` | query | string or null | optional | Filter by filing\_type Allowed values: `results`, `full_financials`, `corporate_action`, `board_change`, `director_dealing`, `sustainability`, `other`. |
| `from` | query | string (date-time) or null | optional | Inclusive start date of the requested range in YYYY-MM-DD format. |
| `to` | query | string (date-time) or null | optional | Inclusive end date of the requested range in YYYY-MM-DD format. |
| `has_tables` | query | boolean or null | optional | Filter filings by whether stored statement tables are available. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `50`. |

### `GET /v1/companies/{company_id}/mentioned-by`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | path | string (uuid) | required | Filter or identify a company using its stable Rangler identifier. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `50`. |
| `from` | query | string (date-time) or null | optional | Inclusive start date of the requested range in YYYY-MM-DD format. |
| `to` | query | string (date-time) or null | optional | Inclusive end date of the requested range in YYYY-MM-DD format. |
| `source_company_id` | query | string (uuid) or null | optional | Filter mentions by the company whose filing contains the mention. |
| `filing_type` | query | string or null | optional | Disclosure category used to narrow the filing or mention selection. Allowed values: `results`, `full_financials`, `corporate_action`, `board_change`, `director_dealing`, `sustainability`, `other`. |

### `GET /v1/filings/board-change-companies`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `country_code` | query | string or null | optional | Filter by ISO 3166-1 alpha-2 market country code |

### `GET /v1/filings/insider-dealings`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | query | string (uuid) or null | optional | Filter or identify a company using its stable Rangler identifier. |
| `ticker` | query | string or null | optional | Filter by company ticker |
| `from` | query | string (date) or null | optional | Inclusive start date of the requested range in YYYY-MM-DD format. |
| `to` | query | string (date) or null | optional | Inclusive end date of the requested range in YYYY-MM-DD format. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `100`. |
| `country_code` | query | string or null | optional | Filter by ISO 3166-1 alpha-2 market country code |

### `GET /v1/filings`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `cursor` | query | string or null | optional | Opaque next-page cursor returned by the preceding response; pass it unchanged. |
| `q` | query | string or null | optional | Search by filing title excerpt |
| `company_id` | query | string (uuid) or null | optional | Filter by a company that is the filing's issuer or another linked subject |
| `type` | query | string or null | optional | Filter by filing\_type Allowed values: `results`, `full_financials`, `corporate_action`, `board_change`, `director_dealing`, `sustainability`, `other`. |
| `from` | query | string (date-time) or null | optional | Inclusive start date of the requested range in YYYY-MM-DD format. |
| `to` | query | string (date-time) or null | optional | Inclusive end date of the requested range in YYYY-MM-DD format. |
| `has_signal` | query | boolean or null | optional | Only filings that have an extracted signal |
| `has_tables` | query | boolean or null | optional | Filter filings by whether stored statement tables are available. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `25`. |
| `country_code` | query | string or null | optional | Filter by ISO 3166-1 alpha-2 market country code |

### `GET /v1/filings/{filing_id}`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `filing_id` | path | string (uuid) | required | Stable Rangler identifier of the requested filing. |

### `GET /v1/filings/{filing_id}/mentions`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `filing_id` | path | string (uuid) | required | Stable Rangler identifier of the requested filing. |
| `target_company_id` | query | string (uuid) or null | optional | Filter mentions by the company identified in the filing text. |

<a id="board-change-companies-page" />

## Board change companies page

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `data` | array of [Board change company](/fields/filings#board-change-company-read) | required | Returned records or observations. The item schema defines each element's fields. |

<a id="board-change-company-read" />

## Board change company

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `name` | string | required | Display name of the identified resource. |
| `ticker` | string | required | Exchange trading symbol when available. A ticker is not a substitute for the stable company ID. |
| `sector` | string or null | optional | Industry sector assigned to the company, when known. |
| `logo_url` | string or null | optional | URL of the resource's logo when available. |
| `change_count` | integer | required | Number of board-change records associated with this company. |
| `latest_published_at` | string (date-time) | required | Publication timestamp of the most recent matching filing. |

<a id="filing-badge-read" />

## Filing badge

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `key` | string | required | Stable machine-readable key; use label for presentation. |
| `label` | string | required | Human-readable label. Use the associated key or identifier for programmatic matching. |
| `color` | string | required | Presentation color associated with the filing badge. |

<a id="filing-board-change-detail-read" />

## Filing board change detail

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `person_name` | string | required | Name of the director, insider, or other person identified in the disclosure. |
| `role` | string or null | optional | Disclosed role or position held by the named person. |
| `action` | string | required | Disclosed personnel change, such as appointment or resignation. |
| `effective_date` | string or null | optional | Date the disclosed change or corporate action takes effect. |

<a id="filing-company-summary" />

## Filing company summary

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `name` | string | required | Display name of the identified resource. |
| `ticker` | string | required | Exchange trading symbol when available. A ticker is not a substitute for the stable company ID. |
| `sector` | string or null | optional | Industry sector assigned to the company, when known. |
| `logo_url` | string or null | optional | URL of the resource's logo when available. |

<a id="filing-corporate-action-detail-read" />

## Filing corporate action detail

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `action_type` | string | required | Category of the corporate action described in the disclosure. |
| `summary` | string | required | Short description of the event, document, or resource. |
| `transaction_type` | string or null | optional | Transaction category stated or classified from the disclosure, such as a purchase or sale. |
| `amount` | string or null | optional | Monetary amount as disclosed in source text; use currency and retain any printed magnitude. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `ratio` | string or null | optional | Corporate-action ratio as disclosed, such as a bonus or rights ratio. |
| `quantity` | string or null | optional | Transaction or corporate-action quantity as disclosed in the source text. |
| `record_date` | string or null | optional | Disclosed shareholder record or qualification date. |
| `payment_date` | string or null | optional | Announced payment date; not proof that payment occurred. |
| `effective_date` | string or null | optional | Date the disclosed change or corporate action takes effect. |
| `person_name` | string or null | optional | Name of the director, insider, or other person identified in the disclosure. |
| `role` | string or null | optional | Disclosed role or position held by the named person. |
| `holding_after` | string or null | optional | Post-transaction holding as disclosed in source text. |

<a id="filing-director-dealing-read" />

## Filing director dealing

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `filing_id` | string (uuid) | required | Stable Rangler identifier of the source filing. |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `person_name` | string or null | optional | Name of the director, insider, or other person identified in the disclosure. |
| `role` | string or null | optional | Disclosed role or position held by the named person. |
| `transaction_type` | string or null | optional | Transaction category stated or classified from the disclosure, such as a purchase or sale. |
| `transaction_date` | string or null | optional | Date the disclosed transaction occurred when known. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `price_per_share` | number or null | optional | Disclosed transaction price per share in currency. |
| `quantity` | number or null | optional | Number of security units in the disclosed transaction. |
| `amount` | number or null | optional | Disclosed transaction amount in currency; follow the declared type for textual corporate-action amounts. |
| `instrument` | string or null | optional | Security or instrument described by the transaction disclosure. |
| `holding_after` | number or null | optional | Disclosed holding after the transaction, when known. |
| `summary` | string or null | optional | Short description of the event, document, or resource. |
| `source_excerpt` | string or null | optional | Text excerpt supporting the extracted value or event. |
| `source_page` | string or null | optional | Page reference in the source document, as provided by the source. |
| `confidence` | number or null | optional | Confidence score between 0 and 1. It is not a guarantee of correctness. |

<a id="filing-highlight-read" />

## Filing highlight

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `category` | string | required | Classification of the subject or extracted highlight. |
| `severity` | string | required | Source or system-assigned importance category of the event or highlight. |
| `topic` | string | required | Topic assigned to the extracted highlight. |
| `summary` | string | required | Short description of the event, document, or resource. |
| `metric_value` | string or null | optional | Display value associated with the highlight when present. |

<a id="filing-mention-evidence-read" />

## Filing mention evidence

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `page_number` | integer | required | One-based page number in the source document. |
| `page_label` | string or null | optional | Page label printed in the document when known; it can differ from the PDF page number. |
| `match_text` | string | required | Source text that matched the company identity. |
| `snippet` | string | required | Surrounding source text providing context for the match. |
| `match_start` | integer | required | Start character offset of the match within the stored page text. |
| `match_end` | integer | required | End character offset of the match within the stored page text. |
| `match_type` | string | required | Kind of identity match used to identify the company mention. |
| `is_company_mention` | boolean | optional | Whether this match is classified as a mention of the company rather than an unrelated text match. Default: `true`. |

<a id="filing-mention-target-read" />

## Filing mention target

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `target_company` | [Filing company summary](/fields/filings#filing-company-summary) | required | Company identified in the source filing's text. |
| `evidence_count` | integer | required | Number of stored text matches supporting the mention. |
| `primary_evidence` | [Filing mention evidence](/fields/filings#filing-mention-evidence-read) | required | Representative text match supporting the company mention. |
| `evidence` | array of [Filing mention evidence](/fields/filings#filing-mention-evidence-read) | required | Text matches supporting the identified company mention. |

<a id="filing-mentions-read" />

## Filing mentions

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `filing_id` | string (uuid) | required | Stable Rangler identifier of the source filing. |
| `data` | array of [Filing mention target](/fields/filings#filing-mention-target-read) | required | Returned records or observations. The item schema defines each element's fields. |

<a id="filing-read" />

## Filing

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `subject_kind` | string | required | Kind of entity associated with the filing, such as company or fund. Allowed values: `company`, `portfolio_fund`, `debt_instrument`, `market_instrument`. |
| `subject_id` | string (uuid) | required | Identifier of the filing subject; interpret it with subject\_kind. |
| `filing_type` | string | required | Classified disclosure type, such as result, board\_change, or insider\_dealing. Allowed values: `results`, `full_financials`, `corporate_action`, `board_change`, `director_dealing`, `sustainability`, `other`. |
| `title` | string | required | Human-readable title of the resource or source document. |
| `source_title` | string or null | optional | Title of the evidence supporting this record. |
| `period` | string or null | optional | Reporting-period label extracted from the source filing when available. |
| `published_at` | string (date-time) | required | Publication timestamp of the source document or article when known. |
| `url` | string | required | URL of the source document, article, or resource. |
| `has_tables` | boolean | required | Whether the filing has stored statement tables available through the reported-table endpoints. |
| `filing_family_key` | string or null | optional | Key grouping versions of the same disclosure. |
| `superseded_by_filing_id` | string (uuid) or null | optional | Identifier of the newer filing that replaces this filing, if applicable. |
| `superseded_at` | string (date-time) or null | optional | Timestamp when Rangler marked this filing as replaced. |
| `superseded_reason` | string or null | optional | Explanation of why this filing was replaced by another disclosure. |
| `badge` | [Filing badge](/fields/filings#filing-badge-read) or null | optional | Display label and color for the classified filing type. |
| `signal` | [Filing signal](/fields/filings#filing-signal-read) or null | optional | Extracted disclosure summary, facts, highlights, and evidence. |
| `company` | [Filing company summary](/fields/filings#filing-company-summary) or null | optional | Company identity or details associated with this record. |
| `subject` | [Filing subject](/fields/filings#filing-subject-read) or null | optional | Primary entity associated with this filing. |
| `subjects` | array of [Filing subject](/fields/filings#filing-subject-read) | optional | All identified entities associated with this filing. |

<a id="filing-result-details-read" />

## Filing result details

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `revenue` | string or null | optional | Revenue wording retained as text from the disclosure. |
| `profit_before_tax` | string or null | optional | Profit-before-tax wording retained as text from the disclosure. |
| `profit_after_tax` | string or null | optional | Profit-after-tax wording retained as text from the disclosure. |
| `earnings_per_share` | string or null | optional | Earnings-per-share wording retained as text from the disclosure. |
| `dividend_per_share` | string or null | optional | Dividend-per-share wording retained as text from the disclosure. |
| `dividend_currency` | string or null | optional | Currency of the disclosed dividend per share. |
| `record_date` | string or null | optional | Shareholder record or qualification date disclosed for the dividend. |
| `payment_date` | string or null | optional | Announced payment date retained from the disclosure; not proof of payment. |
| `period_end_date` | string or null | optional | Closing date of the reporting period. |
| `period_type` | string or null | optional | Reporting-period category, such as FY, H1, Q1, or TTM when applicable. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `value_scale` | string or null | optional | Magnitude printed by the source, such as units, thousands, or millions. |
| `revenue_value` | number or null | optional | Numeric disclosed revenue. Interpret its currency and source scale using the enclosing response. |
| `cost_of_sales` | number or null | optional | Cost of goods or services sold, extracted from the disclosure; use currency and value\_scale. |
| `gross_profit` | number or null | optional | Gross profit, standardized from the issuer's reported income statement and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `operating_profit` | number or null | optional | Operating profit, standardized from the issuer's reported income statement and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `ebitda` | number or null | optional | Derived profitability measure calculated as operating\_profit + abs(depreciation\_amortisation). Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `profit_before_tax_value` | number or null | optional | Numeric profit before tax extracted from the disclosure; use currency and value\_scale. |
| `profit_after_tax_value` | number or null | optional | Numeric profit after tax extracted from the disclosure; use currency and value\_scale. |
| `earnings_per_share_value` | number or null | optional | Numeric earnings per share extracted from the disclosure, in currency per share. |
| `total_assets` | number or null | optional | Total assets, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `total_liabilities` | number or null | optional | Total liabilities, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `total_equity` | number or null | optional | Total equity, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `cash_and_equivalents` | number or null | optional | Cash and equivalents, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `dividend_per_share_value` | number or null | optional | Numeric dividend per share extracted from the disclosure, in dividend\_currency per share. |
| `net_asset_per_share` | number or null | optional | Net assets per share extracted from the disclosure, in currency per share. |
| `dividend_payout_ratio` | number or null | optional | Disclosed dividend payout relative to earnings. This extracted figure does not establish a standardized unit convention. |
| `employee_count` | integer or null | optional | Reported number of employees. |
| `personnel_expenses` | number or null | optional | Reported employee-related expense extracted from the disclosure; use currency and value\_scale. |
| `capital_expenditure` | number or null | optional | Capital expenditure (capex), standardized from the issuer's reported cash flow and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `operating_cash_flow` | number or null | optional | Net cash from operating activities, standardized from the issuer's reported cash flow and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `interest_income` | number or null | optional | Interest income, standardized from the issuer's reported income statement and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `interest_expense` | number or null | optional | Interest expense, standardized from the issuer's reported income statement and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `net_interest_income` | number or null | optional | Net interest income, standardized from the issuer's reported income statement and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `non_interest_income` | number or null | optional | Non interest income, standardized from the issuer's reported income statement and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `operating_income` | number or null | optional | Operating income, standardized from the issuer's reported income statement and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `loans_and_advances` | number or null | optional | Loans and advances, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `customer_deposits` | number or null | optional | Customer deposits, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `investment_securities` | number or null | optional | Investment securities, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `long_term_debt` | number or null | optional | Long term debt, standardized from the issuer's reported balance sheet and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `net_interest_margin` | number or null | optional | Derived banking measure calculated as net\_interest\_income / average\_earning\_assets. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `cost_to_income_ratio` | number or null | optional | Derived banking measure calculated as operating\_expenses / operating\_income. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `non_performing_loan_ratio` | number or null | optional | Disclosed non-performing loans relative to the loan book; retain the source's ratio convention. |
| `return_on_assets` | number or null | optional | Derived returns measure calculated as profit\_after\_tax / average\_total\_assets. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `return_on_equity` | number or null | optional | Derived returns measure calculated as owners\_profit / average\_owners\_equity. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `financial_leverage` | number or null | optional | Disclosed leverage measure; its definition and ratio convention follow the source disclosure. |
| `capital_adequacy_ratio` | number or null | optional | Disclosed regulatory capital relative to risk-weighted assets; retain the source's ratio convention. |
| `gross_margin` | number or null | optional | Derived profitability measure calculated as gross\_profit / revenue. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `operating_margin` | number or null | optional | Derived profitability measure calculated as operating\_profit / revenue. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `pbt_margin` | number or null | optional | Derived profitability measure calculated as profit\_before\_tax / revenue. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `pat_margin` | number or null | optional | Derived profitability measure calculated as profit\_after\_tax / revenue. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `fcf_margin` | number or null | optional | Derived cash flow measure calculated as free\_cash\_flow / revenue. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `revenue_growth` | number or null | optional | Revenue growth extracted from the disclosure; retain the source's comparison period and percentage convention. |
| `free_cash_flow` | number or null | optional | Free cash flow, standardized from the issuer's reported cash flow and expressed in base currency units. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `gearing_ratio` | number or null | optional | Disclosed gearing measure; its debt/equity definition and ratio convention follow the source. |
| `debt_to_asset` | number or null | optional | Disclosed debt relative to total assets; retain the source's ratio convention. |
| `interest_coverage_ebit` | number or null | optional | EBIT relative to interest expense, expressed as a coverage multiple when disclosed. |
| `interest_coverage_ocf` | number or null | optional | Operating cash flow relative to interest expense, expressed as a coverage multiple when disclosed. |
| `asset_turnover` | number or null | optional | Derived efficiency measure calculated as revenue / average\_total\_assets. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `capex_intensity` | number or null | optional | Disclosed capital expenditure relative to revenue; retain the source's ratio convention. |
| `nwc_ratio` | number or null | optional | Disclosed net working capital relative to revenue; retain the source's ratio convention. |
| `ocf_conversion` | number or null | optional | Disclosed operating-cash-flow conversion measure; its earnings denominator follows the source. |
| `price_to_earnings` | number or null | optional | Derived valuation measure calculated as price / earnings\_per\_share. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `price_to_book` | number or null | optional | Derived valuation measure calculated as price / book\_value\_per\_share. Disclosure-extracted figure; use the source currency and scale. Standardized values and units are available from the financial endpoints. |
| `revenue_segments` | array of [Revenue segment (disclosure)](/fields/financials#app--schemas--filing--revenue-segment-read) | optional | Revenue segment figures extracted from the disclosure. Default: `[]`. |

<a id="filing-signal-metric-read" />

## Filing signal metric

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `name` | string | required | Display name of the identified resource. |
| `value` | string | required | Value as presented in the disclosure text; use its unit and period for interpretation. |
| `unit` | string or null | optional | Measurement unit of the associated value. Monetary units use the accompanying currency. |
| `period` | string or null | optional | Reporting-period label extracted from the source filing when available. |

<a id="filing-signal-read" />

## Filing signal

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `summary` | string | required | Short description of the event, document, or resource. |
| `confidence` | number | required | Confidence score between 0 and 1. It is not a guarantee of correctness. |
| `extracted_at` | string (date-time) | required | Timestamp when the disclosure summary and facts were extracted. |
| `reporting_period` | string or null | optional | Human-readable reporting-period label from the disclosure. |
| `key_points` | array of string | required | Principal facts identified in the disclosure summary. |
| `mentioned_tickers` | array of string | required | Trading symbols mentioned in the extracted disclosure. |
| `dates_mentioned` | array of string | required | Date references extracted from the disclosure text. |
| `risk_flags` | array of string | required | Risk-related observations identified in the disclosure summary. |
| `corporate_actions` | array of string | required | Short summaries of identified corporate actions. |
| `board_changes` | array of string | required | Short summaries of identified board or officer changes. |
| `metrics` | array of [Filing signal metric](/fields/filings#filing-signal-metric-read) | required | Financial figures extracted from the disclosure, with source labels and units. |
| `result_details` | [Filing result details](/fields/filings#filing-result-details-read) or null | optional | Structured financial-result figures extracted from the disclosure; not the standardized statement API. |
| `corporate_action_details` | array of [Filing corporate action detail](/fields/filings#filing-corporate-action-detail-read) | required | Structured details of identified corporate actions. |
| `board_change_details` | array of [Filing board change detail](/fields/filings#filing-board-change-detail-read) | required | Structured details of identified board or officer changes. |
| `director_dealings` | array of [Filing director dealing](/fields/filings#filing-director-dealing-read) | optional | Structured director or insider transaction disclosures. Default: `[]`. |
| `highlights` | array of [Filing highlight](/fields/filings#filing-highlight-read) | optional | Selected disclosure highlights with categories and severity labels. Default: `[]`. |

<a id="filing-subject-read" />

## Filing subject

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `kind` | string | required | Kind of entity or source represented by this object. Allowed values: `company`, `portfolio_fund`, `debt_instrument`, `market_instrument`. |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `name` | string or null | optional | Display name of the identified resource. |
| `ticker` | string or null | optional | Exchange trading symbol when available. A ticker is not a substitute for the stable company ID. |
| `slug` | string or null | optional | URL-friendly identifier of a non-company subject when available. |
| `category` | string or null | optional | Classification of the subject or extracted highlight. |

<a id="filings-page" />

## Filings page

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `data` | array of [Filing](/fields/filings#filing-read) | required | Returned records or observations. The item schema defines each element's fields. |
| `next_cursor` | string or null | optional | Opaque cursor for the next page. Pass it unchanged as cursor; null means no next page. |

<a id="insider-dealing-market-context-read" />

## Insider dealing market context

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `trade_date` | string | required | Trading date used for the market comparison. |
| `daily_market_volume` | number or null | optional | Total security units traded in the market on trade\_date. |
| `daily_market_value` | number or null | optional | Total traded market value on trade\_date in the market's currency. |
| `daily_trade_count` | number or null | optional | Number of market trades on trade\_date. |
| `end_of_day_price_change` | number or null | optional | Absolute end-of-day price change in the security's price currency. |
| `disclosed_insider_volume` | number or null | optional | Total disclosed insider transaction units for this comparison date. |
| `disclosed_insider_value` | number or null | optional | Total disclosed insider transaction value for this comparison date in currency. |
| `disclosed_volume_pct_of_daily_volume` | number or null | optional | Disclosed insider volume / daily market volume \* 100. |

<a id="insider-dealing-read" />

## Insider dealing

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `company` | [Filing company summary](/fields/filings#filing-company-summary) | required | Company identity or details associated with this record. |
| `filing_id` | string (uuid) | required | Stable Rangler identifier of the source filing. |
| `filing_title` | string | required | Title of the source filing. |
| `source_title` | string or null | optional | Title of the evidence supporting this record. |
| `filing_url` | string | required | URL of the source filing. |
| `filing_published_at` | string (date-time) | required | Publication timestamp of the source filing. |
| `person_name` | string or null | optional | Name of the director, insider, or other person identified in the disclosure. |
| `role` | string or null | optional | Disclosed role or position held by the named person. |
| `transaction_type` | string or null | optional | Transaction category stated or classified from the disclosure, such as a purchase or sale. |
| `transaction_date` | string or null | optional | Date the disclosed transaction occurred when known. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `price_per_share` | number or null | optional | Disclosed transaction price per share in currency. |
| `quantity` | number or null | optional | Number of security units in the disclosed transaction. |
| `amount` | number or null | optional | Disclosed transaction amount in currency; follow the declared type for textual corporate-action amounts. |
| `instrument` | string or null | optional | Security or instrument described by the transaction disclosure. |
| `holding_after` | number or null | optional | Disclosed holding after the transaction, when known. |
| `summary` | string or null | optional | Short description of the event, document, or resource. |
| `source_excerpt` | string or null | optional | Text excerpt supporting the extracted value or event. |
| `source_page` | string or null | optional | Page reference in the source document, as provided by the source. |
| `confidence` | number or null | optional | Confidence score between 0 and 1. It is not a guarantee of correctness. |
| `market_context` | [Insider dealing market context](/fields/filings#insider-dealing-market-context-read) or null | optional | Daily market totals for comparison with the disclosed insider transaction. |

<a id="insider-dealings-page" />

## Insider dealings page

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `data` | array of [Insider dealing](/fields/filings#insider-dealing-read) | required | Returned records or observations. The item schema defines each element's fields. |

<a id="mention-source-filing-read" />

## Mention source filing

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `subject_kind` | string | required | Kind of entity associated with the filing, such as company or fund. Allowed values: `company`, `portfolio_fund`, `debt_instrument`, `market_instrument`. |
| `subject_id` | string (uuid) | required | Identifier of the filing subject; interpret it with subject\_kind. |
| `filing_type` | string | required | Classified disclosure type, such as result, board\_change, or insider\_dealing. Allowed values: `results`, `full_financials`, `corporate_action`, `board_change`, `director_dealing`, `sustainability`, `other`. |
| `title` | string | required | Human-readable title of the resource or source document. |
| `source_title` | string or null | optional | Title of the evidence supporting this record. |
| `period` | string or null | optional | Reporting-period label extracted from the source filing when available. |
| `published_at` | string (date-time) | required | Publication timestamp of the source document or article when known. |
| `url` | string | required | URL of the source document, article, or resource. |

<a id="mentioned-by-item-read" />

## Mentioned by item

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `source_filing` | [Mention source filing](/fields/filings#mention-source-filing-read) | required | Filing containing the mention and its publication/source identity. |
| `source_company` | [Filing company summary](/fields/filings#filing-company-summary) | required | Issuer whose filing contains the mention. |
| `evidence_count` | integer | required | Number of stored text matches supporting the mention. |
| `primary_evidence` | [Filing mention evidence](/fields/filings#filing-mention-evidence-read) | required | Representative text match supporting the company mention. |

<a id="mentioned-by-page" />

## Mentioned by page

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `data` | array of [Mentioned by item](/fields/filings#mentioned-by-item-read) | required | Returned records or observations. The item schema defines each element's fields. |


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