Filing Facts
Retrieve exact-QName facts or whole statement and disclosure presentation occurrences from one exact SEC filing accession.
Tier: registered | Cache: cold-allowed | Playground: authenticated only | Contract: 1.3.0
When To Use It
Use these tools when the model needs normalized financial facts, concept-level series, or statement-shaped outputs grounded in XBRL.
Request Examples
BASE_URL="${EDGAR_API_URL:-https://www.edgarparser.com}"
curl -sS "$BASE_URL/api/filing/facts/query" \
-X POST \
-H "Authorization: Bearer $EDGAR_API_KEY" \
-H "Content-Type: application/json" \
--data '{"fetch_policy":"cache_only","filing":{"accession":"0000320193-25-000079"},"issuer":{},"selectors":["example_selector"]}'import os
import requests
base_url = os.getenv("EDGAR_API_URL", "https://www.edgarparser.com")
headers = {"Authorization": f"Bearer {os.environ['EDGAR_API_KEY']}"}
payload = {
"fetch_policy": "cache_only",
"filing": {
"accession": "0000320193-25-000079"
},
"issuer": {},
"selectors": [
"example_selector"
]
}
response = requests.post(f"{base_url}/api/filing/facts/query", headers=headers, json=payload, timeout=30)
response.raise_for_status()
data = response.json()Key Response Fields
| Field | Type | Why It Matters |
|---|---|---|
results | array<object | object | object | object | object | object | object | object | object | object> | Search or retrieval results; inspect ranking and source fields before answering. |
contract_version | const "filing_facts.v1" | Financial fact or concept field; inspect unit, period, and source context before using it. |
filing | object | Financial fact or concept field; inspect unit, period, and source context before using it. |
producer | object | Financial fact or concept field; inspect unit, period, and source context before using it. |
retrieval | object | Financial fact or concept field; inspect unit, period, and source context before using it. |
Response Fields To Inspect
status/semantic_statusfor whether the tool produced a usable fact set.coverage_statusandcoverage_warningbefore treating the value as complete.source_ref, concept names, units, and period metadata for citation and auditability.
Errors And Coverage
401or403: the API key is missing, expired, or not allowed to use this tier.429: retry after the rate-limit window, and prefer broader batch or series tools over repeated single-period calls.- Cold work can take longer and may queue background fetch or parse work; use status fields or follow-up tools before finalizing.
- Treat partial coverage, empty arrays, and warning fields as answer-quality signals even when HTTP status is
200.
Related Tools
Filings, List Metrics, Search Metrics, Financials
Generated Reference
Contract
| Field | Value |
|---|---|
| Tool | get_filing_facts |
| Method | POST |
| Path | /api/filing/facts/query |
| Contract version | 1.3.0 |
Parameters
| Name | Location | Required | Type | Notes |
|---|---|---|---|---|
| none | - | - | - | - |
Request Body Schema
{
"additionalProperties": false,
"properties": {
"fetch_policy": {
"enum": [
"cache_only",
"allow_fetch"
],
"type": "string"
},
"filing": {
"additionalProperties": false,
"properties": {
"accession": {
"pattern": "^\\d{10}-\\d{2}-\\d{6}$",
"type": "string"
}
},
"required": [
"accession"
],
"type": "object"
},
"issuer": {
"additionalProperties": false,
"properties": {
"cik": {
"anyOf": [
{
"pattern": "^\\d{1,10}$",
"type": "string"
},
{
"type": "null"
}
]
},
"ticker": {
"anyOf": [
{
"maxLength": 32,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
]
}
},
"type": "object"
},
"selectors": {
"items": {
"discriminator": {
"mapping": {
"all_occurrences": "#/components/schemas/AllOccurrencesRequest",
"presentation_occurrences": "#/components/schemas/PresentationOccurrencesRequest",
"primary_statement_aggregate": "#/components/schemas/PrimaryStatementAggregateRequest"
},
"propertyName": "occurrence"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"occurrence": {
"const": "primary_statement_aggregate",
"type": "string"
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodRequest",
"instant": "#/components/schemas/InstantPeriodRequest"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"qname": {
"maxLength": 1024,
"minLength": 3,
"type": "string"
},
"statement_role": {
"anyOf": [
{
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"qname",
"period",
"occurrence"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"occurrence": {
"const": "all_occurrences",
"type": "string"
},
"period": {
"discriminator": {
"mapping": {
"all_reported_periods": "#/components/schemas/AllReportedPeriodsRequest",
"duration": "#/components/schemas/DurationPeriodRequest",
"instant": "#/components/schemas/InstantPeriodRequest"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "all_reported_periods",
"type": "string"
}
},
"required": [
"kind"
],
"type": "object"
}
]
},
"qname": {
"maxLength": 1024,
"minLength": 3,
"type": "string"
}
},
"required": [
"id",
"qname",
"period",
"occurrence"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"include_dimensions": {
"default": true,
"type": "boolean"
},
"occurrence": {
"const": "presentation_occurrences",
"type": "string"
},
"presentation_role_uris": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"occurrence",
"statement_roles"
],
"type": "object"
}
]
},
"maxItems": 25,
"minItems": 1,
"type": "array"
}
},
"required": [
"issuer",
"filing",
"selectors",
"fetch_policy"
],
"type": "object"
}Response Schema (200)
{
"additionalProperties": false,
"properties": {
"contract_version": {
"const": "filing_facts.v1",
"default": "filing_facts.v1",
"type": "string"
},
"filing": {
"additionalProperties": false,
"properties": {
"accepted_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"accession": {
"pattern": "^\\d{10}-\\d{2}-\\d{6}$",
"type": "string"
},
"cik": {
"type": "string"
},
"filing_date": {
"format": "date",
"type": "string"
},
"filing_index_url": {
"type": "string"
},
"form_type": {
"type": "string"
},
"primary_document_url": {
"type": "string"
},
"report_date": {
"format": "date",
"type": "string"
},
"ticker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"ticker",
"cik",
"accession",
"form_type",
"filing_date",
"report_date",
"accepted_at",
"filing_index_url",
"primary_document_url"
],
"type": "object"
},
"producer": {
"additionalProperties": false,
"properties": {
"id": {
"const": "edgar_updater",
"default": "edgar_updater",
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"results": {
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"observation": {
"additionalProperties": false,
"properties": {
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_qualifiers": {
"items": {
"additionalProperties": false,
"properties": {
"canonical_xml": {
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"origin",
"canonical_xml"
],
"type": "object"
},
"type": "array"
},
"dimensions": {
"items": {
"discriminator": {
"mapping": {
"explicit": "#/components/schemas/ExplicitDimensionResponse",
"typed": "#/components/schemas/TypedDimensionResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"kind": {
"const": "explicit",
"type": "string"
},
"member": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"member_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"member",
"member_label",
"origin"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"canonical_member_xml": {
"type": "string"
},
"kind": {
"const": "typed",
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"canonical_member_xml",
"origin"
],
"type": "object"
}
]
},
"type": "array"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"observation_kind": {
"const": "reported_xbrl_fact",
"type": "string"
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"presentation": {
"additionalProperties": false,
"properties": {
"occurrences": {
"items": {
"additionalProperties": false,
"properties": {
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parent_qname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"preferred_label": {
"additionalProperties": false,
"properties": {
"negates_value": {
"type": "boolean"
},
"role_uri": {
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"role_uri",
"negates_value"
],
"type": "object"
},
"role_name": {
"type": "string"
},
"role_uri": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"statement_roles",
"role_uri",
"role_name",
"parent_qname",
"order",
"preferred_label"
],
"type": "object"
},
"type": "array"
},
"presentation_roles": {
"items": {
"type": "string"
},
"type": "array"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"statement_roles",
"presentation_roles",
"occurrences"
],
"type": "object"
},
"presentation_display": {
"discriminator": {
"mapping": {
"known": "#/components/schemas/PresentationDisplayKnownResponse",
"unknown": "#/components/schemas/PresentationDisplayUnknownResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"kind": {
"const": "known",
"type": "string"
},
"numeric_kind": {
"enum": [
"currency",
"per_share",
"count",
"percentage"
],
"type": "string"
},
"precision": {
"anyOf": [
{
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"scale": {
"enum": [
"unit",
"thousands",
"millions",
"billions"
],
"type": "string"
},
"unit_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"numeric_kind",
"scale",
"currency",
"unit_label",
"precision"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "unknown",
"type": "string"
},
"reason": {
"minLength": 1,
"type": "string"
}
},
"required": [
"kind",
"reason"
],
"type": "object"
}
]
},
"provenance": {
"additionalProperties": false,
"properties": {
"context_ref": {
"type": "string"
},
"locators": {
"items": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context_ref": {
"type": "string"
},
"snippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"source_xpath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"anchor",
"snippet",
"source_xpath",
"context_ref",
"source_document_url",
"source_filename"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
}
},
"required": [
"context_ref",
"source_document_url",
"source_filename",
"locators"
],
"type": "object"
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"value": {
"discriminator": {
"mapping": {
"nil": "#/components/schemas/NilValueResponse",
"numeric": "#/components/schemas/NumericValueResponse",
"text": "#/components/schemas/TextValueResponse"
},
"propertyName": "state"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"native_number": {
"discriminator": {
"mapping": {
"decimal": "#/components/schemas/DecimalNumberResponse",
"rational": "#/components/schemas/RationalNumberResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "decimal",
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"kind",
"value"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"denominator": {
"type": "string"
},
"kind": {
"const": "rational",
"type": "string"
},
"numerator": {
"type": "string"
}
},
"required": [
"kind",
"numerator",
"denominator"
],
"type": "object"
}
]
},
"source": {
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
"state": {
"const": "numeric",
"type": "string"
},
"unit": {
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
}
},
"required": [
"state",
"native_number",
"unit",
"source"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"const": "text",
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"state",
"text"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"item_kind": {
"enum": [
"numeric",
"text"
],
"type": "string"
},
"numeric_source": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
{
"type": "null"
}
]
},
"state": {
"const": "nil",
"type": "string"
},
"unit": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"item_kind"
],
"type": "object"
}
]
}
},
"required": [
"observation_kind",
"qname",
"entity",
"value",
"period",
"dimensions",
"context_qualifiers",
"context_qualification",
"presentation",
"presentation_display",
"provenance"
],
"type": "object"
},
"selector_id": {
"type": "string"
},
"status": {
"const": "selected_one",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"observation"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"observations": {
"items": {
"additionalProperties": false,
"properties": {
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_qualifiers": {
"items": {
"additionalProperties": false,
"properties": {
"canonical_xml": {
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"origin",
"canonical_xml"
],
"type": "object"
},
"type": "array"
},
"dimensions": {
"items": {
"discriminator": {
"mapping": {
"explicit": "#/components/schemas/ExplicitDimensionResponse",
"typed": "#/components/schemas/TypedDimensionResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"kind": {
"const": "explicit",
"type": "string"
},
"member": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"member_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"member",
"member_label",
"origin"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"canonical_member_xml": {
"type": "string"
},
"kind": {
"const": "typed",
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"canonical_member_xml",
"origin"
],
"type": "object"
}
]
},
"type": "array"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"observation_kind": {
"const": "reported_xbrl_fact",
"type": "string"
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"presentation": {
"additionalProperties": false,
"properties": {
"occurrences": {
"items": {
"additionalProperties": false,
"properties": {
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parent_qname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"preferred_label": {
"additionalProperties": false,
"properties": {
"negates_value": {
"type": "boolean"
},
"role_uri": {
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"role_uri",
"negates_value"
],
"type": "object"
},
"role_name": {
"type": "string"
},
"role_uri": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"statement_roles",
"role_uri",
"role_name",
"parent_qname",
"order",
"preferred_label"
],
"type": "object"
},
"type": "array"
},
"presentation_roles": {
"items": {
"type": "string"
},
"type": "array"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"statement_roles",
"presentation_roles",
"occurrences"
],
"type": "object"
},
"presentation_display": {
"discriminator": {
"mapping": {
"known": "#/components/schemas/PresentationDisplayKnownResponse",
"unknown": "#/components/schemas/PresentationDisplayUnknownResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"kind": {
"const": "known",
"type": "string"
},
"numeric_kind": {
"enum": [
"currency",
"per_share",
"count",
"percentage"
],
"type": "string"
},
"precision": {
"anyOf": [
{
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"scale": {
"enum": [
"unit",
"thousands",
"millions",
"billions"
],
"type": "string"
},
"unit_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"numeric_kind",
"scale",
"currency",
"unit_label",
"precision"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "unknown",
"type": "string"
},
"reason": {
"minLength": 1,
"type": "string"
}
},
"required": [
"kind",
"reason"
],
"type": "object"
}
]
},
"provenance": {
"additionalProperties": false,
"properties": {
"context_ref": {
"type": "string"
},
"locators": {
"items": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context_ref": {
"type": "string"
},
"snippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"source_xpath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"anchor",
"snippet",
"source_xpath",
"context_ref",
"source_document_url",
"source_filename"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
}
},
"required": [
"context_ref",
"source_document_url",
"source_filename",
"locators"
],
"type": "object"
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"value": {
"discriminator": {
"mapping": {
"nil": "#/components/schemas/NilValueResponse",
"numeric": "#/components/schemas/NumericValueResponse",
"text": "#/components/schemas/TextValueResponse"
},
"propertyName": "state"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"native_number": {
"discriminator": {
"mapping": {
"decimal": "#/components/schemas/DecimalNumberResponse",
"rational": "#/components/schemas/RationalNumberResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "decimal",
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"kind",
"value"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"denominator": {
"type": "string"
},
"kind": {
"const": "rational",
"type": "string"
},
"numerator": {
"type": "string"
}
},
"required": [
"kind",
"numerator",
"denominator"
],
"type": "object"
}
]
},
"source": {
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
"state": {
"const": "numeric",
"type": "string"
},
"unit": {
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
}
},
"required": [
"state",
"native_number",
"unit",
"source"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"const": "text",
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"state",
"text"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"item_kind": {
"enum": [
"numeric",
"text"
],
"type": "string"
},
"numeric_source": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
{
"type": "null"
}
]
},
"state": {
"const": "nil",
"type": "string"
},
"unit": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"item_kind"
],
"type": "object"
}
]
}
},
"required": [
"observation_kind",
"qname",
"entity",
"value",
"period",
"dimensions",
"context_qualifiers",
"context_qualification",
"presentation",
"presentation_display",
"provenance"
],
"type": "object"
},
"minItems": 2,
"type": "array"
},
"selector_id": {
"type": "string"
},
"status": {
"const": "selected_set",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"observations"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"occurrences": {
"items": {
"additionalProperties": false,
"properties": {
"accession": {
"type": "string"
},
"binding": {
"anyOf": [
{
"discriminator": {
"mapping": {
"ambiguous": "#/components/schemas/AmbiguousBindingResponse",
"bound": "#/components/schemas/BoundBindingResponse",
"gap": "#/components/schemas/GapBindingResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"fact": {
"additionalProperties": false,
"properties": {
"consistent_duplicates": {
"items": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context_ref": {
"type": "string"
},
"snippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"source_xpath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"anchor",
"snippet",
"source_xpath",
"context_ref",
"source_document_url",
"source_filename"
],
"type": "object"
},
"type": "array"
},
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_qualifiers": {
"items": {
"additionalProperties": false,
"properties": {
"canonical_xml": {
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"origin",
"canonical_xml"
],
"type": "object"
},
"type": "array"
},
"dimensions": {
"items": {
"discriminator": {
"mapping": {
"explicit": "#/components/schemas/ExplicitDimensionResponse",
"typed": "#/components/schemas/TypedDimensionResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"kind": {
"const": "explicit",
"type": "string"
},
"member": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"member_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"member",
"member_label",
"origin"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"canonical_member_xml": {
"type": "string"
},
"kind": {
"const": "typed",
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"canonical_member_xml",
"origin"
],
"type": "object"
}
]
},
"type": "array"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"native_quantity": {
"discriminator": {
"mapping": {
"nil": "#/components/schemas/NilValueResponse",
"numeric": "#/components/schemas/NumericValueResponse",
"text": "#/components/schemas/TextValueResponse"
},
"propertyName": "state"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"native_number": {
"discriminator": {
"mapping": {
"decimal": "#/components/schemas/DecimalNumberResponse",
"rational": "#/components/schemas/RationalNumberResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "decimal",
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"kind",
"value"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"denominator": {
"type": "string"
},
"kind": {
"const": "rational",
"type": "string"
},
"numerator": {
"type": "string"
}
},
"required": [
"kind",
"numerator",
"denominator"
],
"type": "object"
}
]
},
"source": {
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
"state": {
"const": "numeric",
"type": "string"
},
"unit": {
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
}
},
"required": [
"state",
"native_number",
"unit",
"source"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"const": "text",
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"state",
"text"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"item_kind": {
"enum": [
"numeric",
"text"
],
"type": "string"
},
"numeric_source": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
{
"type": "null"
}
]
},
"state": {
"const": "nil",
"type": "string"
},
"unit": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"item_kind"
],
"type": "object"
}
]
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"provenance": {
"additionalProperties": false,
"properties": {
"context_ref": {
"type": "string"
},
"locators": {
"items": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context_ref": {
"type": "string"
},
"snippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"source_xpath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"anchor",
"snippet",
"source_xpath",
"context_ref",
"source_document_url",
"source_filename"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
}
},
"required": [
"context_ref",
"source_document_url",
"source_filename",
"locators"
],
"type": "object"
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
}
},
"required": [
"qname",
"entity",
"native_quantity",
"period",
"dimensions",
"context_qualifiers",
"context_qualification",
"provenance",
"consistent_duplicates"
],
"type": "object"
},
"kind": {
"const": "bound",
"type": "string"
}
},
"required": [
"kind",
"fact"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "gap",
"type": "string"
},
"reason": {
"enum": [
"no_fact_for_presented_cell",
"no_context_for_printed_column"
],
"type": "string"
}
},
"required": [
"kind",
"reason"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"candidates": {
"items": {
"additionalProperties": false,
"properties": {
"consistent_duplicates": {
"items": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context_ref": {
"type": "string"
},
"snippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"source_xpath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"anchor",
"snippet",
"source_xpath",
"context_ref",
"source_document_url",
"source_filename"
],
"type": "object"
},
"type": "array"
},
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_qualifiers": {
"items": {
"additionalProperties": false,
"properties": {
"canonical_xml": {
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"origin",
"canonical_xml"
],
"type": "object"
},
"type": "array"
},
"dimensions": {
"items": {
"discriminator": {
"mapping": {
"explicit": "#/components/schemas/ExplicitDimensionResponse",
"typed": "#/components/schemas/TypedDimensionResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"kind": {
"const": "explicit",
"type": "string"
},
"member": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"member_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"member",
"member_label",
"origin"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"axis": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"canonical_member_xml": {
"type": "string"
},
"kind": {
"const": "typed",
"type": "string"
},
"origin": {
"enum": [
"segment",
"scenario"
],
"type": "string"
}
},
"required": [
"kind",
"axis",
"canonical_member_xml",
"origin"
],
"type": "object"
}
]
},
"type": "array"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"native_quantity": {
"discriminator": {
"mapping": {
"nil": "#/components/schemas/NilValueResponse",
"numeric": "#/components/schemas/NumericValueResponse",
"text": "#/components/schemas/TextValueResponse"
},
"propertyName": "state"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"native_number": {
"discriminator": {
"mapping": {
"decimal": "#/components/schemas/DecimalNumberResponse",
"rational": "#/components/schemas/RationalNumberResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "decimal",
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"kind",
"value"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"denominator": {
"type": "string"
},
"kind": {
"const": "rational",
"type": "string"
},
"numerator": {
"type": "string"
}
},
"required": [
"kind",
"numerator",
"denominator"
],
"type": "object"
}
]
},
"source": {
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
"state": {
"const": "numeric",
"type": "string"
},
"unit": {
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
}
},
"required": [
"state",
"native_number",
"unit",
"source"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"const": "text",
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"state",
"text"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"item_kind": {
"enum": [
"numeric",
"text"
],
"type": "string"
},
"numeric_source": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"decimals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fraction_denominator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"fraction_numerator": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_value": {
"type": "string"
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"transform"
],
"type": "object"
},
{
"type": "null"
}
]
},
"inline_sign": {
"anyOf": [
{
"enum": [
"+",
"-"
],
"type": "string"
},
{
"type": "null"
}
]
},
"lexical_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scale_exponent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"transform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"transform_namespace_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"lexical_value",
"scale_exponent",
"decimals",
"transform",
"inline_sign"
],
"type": "object"
},
{
"type": "null"
}
]
},
"state": {
"const": "nil",
"type": "string"
},
"unit": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"denominator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
},
"numerator_measures": {
"items": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"numerator_measures",
"denominator_measures"
],
"type": "object"
},
{
"type": "null"
}
]
}
},
"required": [
"state",
"item_kind"
],
"type": "object"
}
]
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"provenance": {
"additionalProperties": false,
"properties": {
"context_ref": {
"type": "string"
},
"locators": {
"items": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context_ref": {
"type": "string"
},
"snippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"source_xpath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"anchor",
"snippet",
"source_xpath",
"context_ref",
"source_document_url",
"source_filename"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
}
},
"required": [
"context_ref",
"source_document_url",
"source_filename",
"locators"
],
"type": "object"
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
}
},
"required": [
"qname",
"entity",
"native_quantity",
"period",
"dimensions",
"context_qualifiers",
"context_qualification",
"provenance",
"consistent_duplicates"
],
"type": "object"
},
"minItems": 2,
"type": "array"
},
"kind": {
"const": "ambiguous",
"type": "string"
}
},
"required": [
"kind",
"candidates"
],
"type": "object"
}
]
},
{
"type": "null"
}
]
},
"calculation": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"arcrole": {
"type": "string"
},
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parent_qname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"role_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"weight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"parent_qname",
"weight",
"order",
"role_uri",
"arcrole"
],
"type": "object"
},
{
"type": "null"
}
]
},
"line_kind": {
"enum": [
"numeric",
"text",
"abstract"
],
"type": "string"
},
"line_qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"occurrence_kind": {
"const": "filing_presentation_cell",
"type": "string"
},
"preferred_label": {
"additionalProperties": false,
"properties": {
"negates_value": {
"type": "boolean"
},
"role_uri": {
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"role_uri",
"negates_value"
],
"type": "object"
},
"presentation": {
"additionalProperties": false,
"properties": {
"presentation_kind": {
"enum": [
"statement",
"parenthetical",
"disclosure",
"document"
],
"type": "string"
},
"presentation_role_name": {
"type": "string"
},
"presentation_role_uri": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
},
"table_title": {
"type": "string"
}
},
"required": [
"statement_roles",
"presentation_role_uri",
"presentation_role_name",
"table_title",
"presentation_kind"
],
"type": "object"
},
"presentation_display": {
"discriminator": {
"mapping": {
"known": "#/components/schemas/PresentationDisplayKnownResponse",
"unknown": "#/components/schemas/PresentationDisplayUnknownResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"kind": {
"const": "known",
"type": "string"
},
"numeric_kind": {
"enum": [
"currency",
"per_share",
"count",
"percentage"
],
"type": "string"
},
"precision": {
"anyOf": [
{
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"scale": {
"enum": [
"unit",
"thousands",
"millions",
"billions"
],
"type": "string"
},
"unit_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"numeric_kind",
"scale",
"currency",
"unit_label",
"precision"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "unknown",
"type": "string"
},
"reason": {
"minLength": 1,
"type": "string"
}
},
"required": [
"kind",
"reason"
],
"type": "object"
}
]
},
"presentation_state": {
"anyOf": [
{
"enum": [
"reported_numeric",
"reported_fixed_zero_dash",
"reported_nil",
"unbound_dash",
"unbound_blank"
],
"type": "string"
},
{
"type": "null"
}
]
},
"printed_column": {
"additionalProperties": false,
"properties": {
"heading": {
"type": "string"
},
"period_end": {
"format": "date",
"type": "string"
},
"period_ref": {
"discriminator": {
"mapping": {
"fiscal_year": "#/components/schemas/PrintedFiscalYearPeriodResponse",
"instant": "#/components/schemas/PrintedInstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"fiscal_year": {
"type": "integer"
},
"kind": {
"const": "fiscal_year",
"type": "string"
},
"period_end": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"fiscal_year",
"period_end"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"date": {
"format": "date",
"type": "string"
},
"fiscal_year": {
"type": "integer"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"date",
"fiscal_year"
],
"type": "object"
}
]
},
"period_start": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
]
},
"position": {
"minimum": 0.0,
"type": "integer"
}
},
"required": [
"position",
"heading",
"period_ref",
"period_start",
"period_end"
],
"type": "object"
},
"printed_lexical": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"additionalProperties": false,
"properties": {
"cell_locator": {
"type": "string"
},
"primary_document_url": {
"type": "string"
},
"row_locator": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"table_locator": {
"type": "string"
},
"xbrl_locators": {
"items": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context_ref": {
"type": "string"
},
"snippet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_document_url": {
"type": "string"
},
"source_filename": {
"type": "string"
},
"source_xpath": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"anchor",
"snippet",
"source_xpath",
"context_ref",
"source_document_url",
"source_filename"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"primary_document_url",
"source_filename",
"table_locator",
"row_locator",
"cell_locator",
"xbrl_locators"
],
"type": "object"
},
"tree": {
"additionalProperties": false,
"properties": {
"depth": {
"minimum": 0.0,
"type": "integer"
},
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"parent_qname": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sibling_index": {
"minimum": 0.0,
"type": "integer"
}
},
"required": [
"parent_qname",
"order",
"depth",
"sibling_index"
],
"type": "object"
}
},
"required": [
"occurrence_kind",
"accession",
"line_qname",
"line_kind",
"presentation",
"tree",
"preferred_label",
"printed_column",
"presentation_state",
"printed_lexical",
"presentation_display",
"binding",
"source",
"calculation"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"selector_id": {
"type": "string"
},
"status": {
"const": "selected_set",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"occurrences"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"selector_id": {
"type": "string"
},
"status": {
"const": "not_reported_in_filing",
"type": "string"
}
},
"required": [
"selector_id",
"status"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"selector_id": {
"type": "string"
},
"status": {
"const": "not_reported_for_period",
"type": "string"
}
},
"required": [
"selector_id",
"status"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"candidates": {
"items": {
"additionalProperties": false,
"properties": {
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_ref": {
"type": "string"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"locator_count": {
"minimum": 1.0,
"type": "integer"
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"source_document_url": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
},
"value_state": {
"enum": [
"numeric",
"text",
"nil"
],
"type": "string"
}
},
"required": [
"qname",
"entity",
"period",
"value_state",
"context_qualification",
"statement_roles",
"context_ref",
"source_document_url",
"locator_count"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"selector_id": {
"type": "string"
},
"status": {
"const": "other_entity_only",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"candidates"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"candidates": {
"items": {
"additionalProperties": false,
"properties": {
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_ref": {
"type": "string"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"locator_count": {
"minimum": 1.0,
"type": "integer"
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"source_document_url": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
},
"value_state": {
"enum": [
"numeric",
"text",
"nil"
],
"type": "string"
}
},
"required": [
"qname",
"entity",
"period",
"value_state",
"context_qualification",
"statement_roles",
"context_ref",
"source_document_url",
"locator_count"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"qualification_kinds": {
"items": {
"enum": [
"dimensioned",
"other_qualifier"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"selector_id": {
"type": "string"
},
"status": {
"const": "qualified_only",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"qualification_kinds",
"candidates"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"candidates": {
"items": {
"additionalProperties": false,
"properties": {
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_ref": {
"type": "string"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"locator_count": {
"minimum": 1.0,
"type": "integer"
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"source_document_url": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
},
"value_state": {
"enum": [
"numeric",
"text",
"nil"
],
"type": "string"
}
},
"required": [
"qname",
"entity",
"period",
"value_state",
"context_qualification",
"statement_roles",
"context_ref",
"source_document_url",
"locator_count"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"selector_id": {
"type": "string"
},
"status": {
"const": "non_primary_only",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"candidates"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"candidates": {
"items": {
"additionalProperties": false,
"properties": {
"context_qualification": {
"enum": [
"unqualified",
"dimensioned",
"other_qualified",
"mixed"
],
"type": "string"
},
"context_ref": {
"type": "string"
},
"entity": {
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"is_filing_registrant": {
"type": "boolean"
},
"scheme": {
"type": "string"
}
},
"required": [
"scheme",
"identifier",
"is_filing_registrant"
],
"type": "object"
},
"locator_count": {
"minimum": 1.0,
"type": "integer"
},
"period": {
"discriminator": {
"mapping": {
"duration": "#/components/schemas/DurationPeriodResponse",
"instant": "#/components/schemas/InstantPeriodResponse"
},
"propertyName": "kind"
},
"oneOf": [
{
"additionalProperties": false,
"properties": {
"instant": {
"format": "date",
"type": "string"
},
"kind": {
"const": "instant",
"type": "string"
}
},
"required": [
"kind",
"instant"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"end": {
"format": "date",
"type": "string"
},
"kind": {
"const": "duration",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
}
},
"required": [
"kind",
"start",
"end"
],
"type": "object"
}
]
},
"qname": {
"additionalProperties": false,
"properties": {
"lexical_qname": {
"type": "string"
},
"local_name": {
"type": "string"
},
"namespace_uri": {
"type": "string"
}
},
"required": [
"lexical_qname",
"namespace_uri",
"local_name"
],
"type": "object"
},
"source_document_url": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"type": "array"
},
"value_state": {
"enum": [
"numeric",
"text",
"nil"
],
"type": "string"
}
},
"required": [
"qname",
"entity",
"period",
"value_state",
"context_qualification",
"statement_roles",
"context_ref",
"source_document_url",
"locator_count"
],
"type": "object"
},
"minItems": 2,
"type": "array"
},
"selector_id": {
"type": "string"
},
"status": {
"const": "ambiguous",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"candidates"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"selector_id": {
"type": "string"
},
"statement_roles": {
"items": {
"enum": [
"balance_sheet",
"income_statement",
"comprehensive_income",
"equity",
"cash_flow",
"disclosure"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"status": {
"const": "role_not_presented",
"type": "string"
}
},
"required": [
"selector_id",
"status",
"statement_roles"
],
"type": "object"
}
]
},
"maxItems": 25,
"minItems": 1,
"type": "array"
},
"retrieval": {
"additionalProperties": false,
"properties": {
"effective_fetch_policy": {
"enum": [
"cache_only",
"allow_fetch"
],
"type": "string"
},
"outcome": {
"enum": [
"cache_hit",
"fetched"
],
"type": "string"
},
"requested_fetch_policy": {
"enum": [
"cache_only",
"allow_fetch"
],
"type": "string"
}
},
"required": [
"requested_fetch_policy",
"effective_fetch_policy",
"outcome"
],
"type": "object"
}
},
"required": [
"producer",
"filing",
"retrieval",
"results"
],
"type": "object"
}