DeltaResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/0si-ai/json-schema/0si-ai-delta-response-schema.json",
  "title": "DeltaResponse",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/0si-ai-openapi.json#/components/schemas/DeltaResponse",
  "type": "object",
  "required": [
    "object",
    "data",
    "meta"
  ],
  "properties": {
    "object": {
      "const": "disclosure_delta"
    },
    "data": {
      "type": "object",
      "required": [
        "disclosure_id",
        "available",
        "delta"
      ],
      "properties": {
        "disclosure_id": {
          "type": "string"
        },
        "accession_number": {
          "type": "string",
          "description": "SEC filings only"
        },
        "available": {
          "type": "boolean",
          "description": "false when no structured delta exists for this filing"
        },
        "delta": {
          "oneOf": [
            {
              "$ref": "#/$defs/GenericDelta"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    },
    "meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "$defs": {
    "Amount": {
      "type": "object",
      "required": [
        "value",
        "display"
      ],
      "properties": {
        "value": {
          "type": [
            "number",
            "null"
          ]
        },
        "display": {
          "type": "string"
        }
      }
    },
    "CorporateActionDelta": {
      "type": "object",
      "required": [
        "schema_version",
        "type",
        "action_type",
        "status",
        "confidence"
      ],
      "properties": {
        "schema_version": {
          "const": 1
        },
        "type": {
          "const": "corporate_action_delta"
        },
        "action_type": {
          "type": "string",
          "enum": [
            "contract",
            "dividend",
            "buyback",
            "retirement",
            "capital_raise",
            "convertible",
            "share_split",
            "capital_reduction",
            "other"
          ]
        },
        "status": {
          "type": "string"
        },
        "amount_krw": {
          "type": [
            "number",
            "null"
          ]
        },
        "share_count": {
          "type": [
            "number",
            "null"
          ]
        },
        "issued_share_delta": {
          "type": [
            "number",
            "null"
          ]
        },
        "maximum_dilution_shares": {
          "type": [
            "number",
            "null"
          ]
        },
        "price_per_share": {
          "type": [
            "number",
            "null"
          ]
        },
        "ratio_pct": {
          "type": [
            "number",
            "null"
          ]
        },
        "confidence": {
          "type": "string",
          "enum": [
            "high",
            "medium",
            "low"
          ]
        },
        "details": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CorrectionDelta": {
      "type": "object",
      "required": [
        "schema_version",
        "type",
        "changes"
      ],
      "properties": {
        "schema_version": {
          "const": 1
        },
        "type": {
          "const": "correction_delta"
        },
        "materiality": {
          "type": "string"
        },
        "changes": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "corporate_action": {
          "$ref": "#/$defs/CorporateActionDelta"
        }
      },
      "additionalProperties": true
    },
    "EarningsComparison": {
      "type": "object",
      "required": [
        "rate_pct",
        "transition",
        "label",
        "direction",
        "prior",
        "period"
      ],
      "properties": {
        "rate_pct": {
          "type": [
            "number",
            "null"
          ],
          "description": "Percentage change. Null for transitions such as profit turnaround."
        },
        "transition": {
          "type": [
            "string",
            "null"
          ],
          "description": "흑자전환 or 적자전환 when a percentage is not meaningful."
        },
        "label": {
          "type": "string"
        },
        "direction": {
          "type": "string",
          "enum": [
            "up",
            "down",
            "flat"
          ]
        },
        "prior": {
          "$ref": "#/$defs/Amount"
        },
        "period": {
          "type": "string"
        }
      }
    },
    "EarningsCumulative": {
      "type": "object",
      "required": [
        "current",
        "yoy"
      ],
      "properties": {
        "current": {
          "$ref": "#/$defs/Amount"
        },
        "yoy": {
          "oneOf": [
            {
              "$ref": "#/$defs/EarningsComparison"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    },
    "EarningsDelta": {
      "type": "object",
      "required": [
        "schema_version",
        "type",
        "period",
        "basis",
        "basis_label",
        "unit",
        "is_correction",
        "metrics",
        "source_note"
      ],
      "properties": {
        "schema_version": {
          "const": 1
        },
        "type": {
          "const": "earnings_delta"
        },
        "period_type": {
          "type": "string",
          "enum": [
            "month"
          ],
          "description": "Optional discriminator for monthly country/entity earnings."
        },
        "period": {
          "type": "string"
        },
        "basis": {
          "type": "string",
          "enum": [
            "consolidated",
            "separate",
            "unknown"
          ]
        },
        "basis_label": {
          "type": "string"
        },
        "unit": {
          "type": "string"
        },
        "is_correction": {
          "type": "boolean"
        },
        "metrics": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/EarningsMetric"
          }
        },
        "source_note": {
          "type": "string"
        }
      }
    },
    "EarningsMetric": {
      "type": "object",
      "required": [
        "key",
        "label",
        "current",
        "qoq",
        "yoy",
        "cumulative"
      ],
      "properties": {
        "key": {
          "type": "string",
          "pattern": "^(revenue|operating_income|net_income|parent_net_income|diluted_eps|country:[^:]+:(revenue|operating_income|net_income|parent_net_income))$"
        },
        "label": {
          "type": "string"
        },
        "scope": {
          "type": "string",
          "description": "Country/entity scope for monthly earnings, not consolidated totals."
        },
        "current": {
          "$ref": "#/$defs/Amount"
        },
        "qoq": {
          "oneOf": [
            {
              "$ref": "#/$defs/EarningsComparison"
            },
            {
              "type": "null"
            }
          ]
        },
        "mom": {
          "description": "Month-over-month comparison. Present for period_type=month; qoq is null in that case.",
          "oneOf": [
            {
              "$ref": "#/$defs/EarningsComparison"
            },
            {
              "type": "null"
            }
          ]
        },
        "yoy": {
          "oneOf": [
            {
              "$ref": "#/$defs/EarningsComparison"
            },
            {
              "type": "null"
            }
          ]
        },
        "cumulative": {
          "oneOf": [
            {
              "$ref": "#/$defs/EarningsCumulative"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    },
    "GenericDelta": {
      "oneOf": [
        {
          "$ref": "#/$defs/EarningsDelta"
        },
        {
          "$ref": "#/$defs/PeriodicDelta"
        },
        {
          "$ref": "#/$defs/CorrectionDelta"
        },
        {
          "$ref": "#/$defs/CorporateActionDelta"
        }
      ]
    },
    "Meta": {
      "type": "object",
      "required": [
        "request_id",
        "generated_at",
        "api_version"
      ],
      "properties": {
        "request_id": {
          "type": "string"
        },
        "generated_at": {
          "type": "string",
          "format": "date-time"
        },
        "api_version": {
          "type": "string",
          "const": "v1"
        }
      }
    },
    "PeriodicDelta": {
      "type": "object",
      "required": [
        "schema_version",
        "type",
        "metrics"
      ],
      "properties": {
        "schema_version": {
          "const": 1
        },
        "type": {
          "const": "periodic_delta"
        },
        "label": {
          "type": "string"
        },
        "headline": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "metrics": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PeriodicMetric"
          }
        },
        "metadata": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "source_note": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "PeriodicMetric": {
      "type": "object",
      "required": [
        "key",
        "label",
        "current",
        "prior",
        "change",
        "change_value",
        "direction",
        "period",
        "prior_period",
        "comparison_basis"
      ],
      "properties": {
        "key": {
          "type": "string",
          "enum": [
            "revenue",
            "operating_income",
            "net_income",
            "diluted_eps",
            "assets",
            "liabilities",
            "equity",
            "cash",
            "operating_cash_flow"
          ]
        },
        "label": {
          "type": "string"
        },
        "current": {
          "type": "string"
        },
        "prior": {
          "type": "string"
        },
        "change": {
          "type": "string"
        },
        "change_value": {
          "type": [
            "number",
            "null"
          ]
        },
        "direction": {
          "type": "string",
          "enum": [
            "up",
            "down",
            "flat"
          ]
        },
        "period": {
          "type": "string"
        },
        "prior_period": {
          "type": "string"
        },
        "comparison_basis": {
          "type": "string"
        },
        "comparisons": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "ttm": {
          "type": "string"
        }
      }
    }
  }
}