Examples Gallery¶
Copy-paste response shapes and API collections for integrators.
Regenerate JSON fixtures:
python scripts/generate_docs_examples.py
Score responses¶
Example |
Workflow |
File |
Guide |
|---|---|---|---|
Minimal 10-K score |
First CLI/Python/HTTP score |
||
Score with prior filing |
Year-over-year change components |
||
Full coverage with prior |
All nine headline components + prior; v2 cyber score when Item 1A incident language is present |
||
Panel batch response |
Multi-ticker HTTP screen |
event_materiality_score requires 8-K event sections (item_1_01, item_1_05, item_2_02, item_5_02, item_8_01) and stays null in the 10-K examples below.
Minimal score (excerpt)¶
"extraction_confs": [
0.35,
0.35
],
"diff_confs": [
0.2,
0.2
],
"extraction_warnings": [],
"required_sections_present": true,
"has_prior": false
},
"scores": {
"overall_disclosure_risk_score": 33.159052,
"score_coverage_ratio": 0.7778,
"confidence_score": 0.3426,
"missing_components": [
"disclosure_change_score",
"event_severity_score"
],
"components": {
"risk_factor_intensity_score": 60.0,
With prior filing (excerpt)¶
{
"overall_disclosure_risk_score": 33.10187,
"score_coverage_ratio": 1.0,
"confidence_score": 0.6729,
"missing_components": [],
"components": {
"risk_factor_intensity_score": 56.2975,
"disclosure_change_score": 38.6268,
"mdna_uncertainty_score": 26.726221,
"legal_regulatory_risk_score": 30.317069,
"liquidity_stress_score": 4.030477,
"boilerplate_risk_score": 42.528733,
"internal_controls_risk_score": 3.4483,
"event_severity_score": 45.19,
"specificity_quality_score": 36.2069,
"tone_negativity_score": 5.2956,
"cybersecurity_incident_risk_score": null,
"event_materiality_score": null
},
"aggregates": {
"disclosure_quality_score": 36.2069,
"disclosure_deterioration_score": 38.6268,
"static_disclosure_quality_score": 36.2069,
"static_disclosure_risk_score": 18.7244,
"disclosure_change_risk_score": 41.9084
}
}
Full coverage with prior (excerpt)¶
{
"overall_disclosure_risk_score": 32.298828,
"score_coverage_ratio": 1.0,
"confidence_score": 0.6705,
"missing_components": [],
"components": {
"risk_factor_intensity_score": 45.6425,
"disclosure_change_score": 37.763145,
"mdna_uncertainty_score": 26.726221,
"legal_regulatory_risk_score": 31.335654,
"liquidity_stress_score": 3.246773,
"boilerplate_risk_score": 58.666667,
"internal_controls_risk_score": 0.0,
"event_severity_score": 47.57,
"specificity_quality_score": 12.0,
"tone_negativity_score": 3.57145,
"cybersecurity_incident_risk_score": 65.0,
"event_materiality_score": null
},
"aggregates": {
"disclosure_quality_score": 12.0,
"disclosure_deterioration_score": 37.763145,
"static_disclosure_quality_score": 12.0,
"static_disclosure_risk_score": 20.591127,
"disclosure_change_risk_score": 42.666573
}
}
Panel response (excerpt)¶
{
"results": [
{
"ticker": "AAPL",
"status": "ok",
"filing": {
"ticker": "AAPL",
"fiscal_year": 2025,
"form_type": "10-K"
},
"scores": {
"overall_disclosure_risk_score": 33.159052,
"score_coverage_ratio": 0.7778,
"confidence_score": 0.3426,
"missing_components": [
"disclosure_change_score",
"event_severity_score"
],
"components": {
"risk_factor_intensity_score": 60.0,
"disclosure_change_score": null,
"mdna_uncertainty_score": 26.726221,
"legal_regulatory_risk_score": 37.6724,
"liquidity_stress_score": 4.030477,
"boilerplate_risk_score": 42.528733,
"internal_controls_risk_score": 3.4483,
"event_severity_score": null,
"specificity_quality_score": 36.2069,
"tone_negativity_score": 5.2956,
"cybersecurity_incident_risk_score": null,
"event_materiality_score": null
}
}
},
{
"ticker": "BAD",
"status": "error",
"error": "No 10-K for BAD FY2025"
}
],
"summary": {
"ok": 1,
"failed": 1
},
"versions": {
"scoring_model_version": "deterministic_scoring_v2"
}
}
Postman collections¶
Product-oriented collections under docs/postman/:
Collection |
Use when |
|---|---|
|
Health + filings |
|
Sections + metrics |
|
Matrix tiers |
|
Flags + changes |
|
Panel POST |
|
Full API |
Import into Postman or run via Newman. HTTP concepts: HTTP API Guide. Endpoint reference: HTTP Endpoint Reference.