-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1481 lines (1370 loc) · 47.1 KB
/
Copy pathopenapi.yaml
File metadata and controls
1481 lines (1370 loc) · 47.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Tickonomics API
version: 1.0.0
description: >
REST contract for the Tickonomics Quantitative Engine. Covers the KPI, signal,
configuration, demo, anomaly/drift, regime, disaster, governance/stress,
optimization, sentiment, stops, leverage, pairs, diagnostics, and quantitative
engine surfaces. Instrument and rate enumerations are aligned with the FINOS CDM
projection in the `cdm/` module. This is the Phase 0 contract that subsequent
tracks implement; endpoints without a controller yet are part of the planned
surface and are tagged accordingly.
contact:
name: Tickonomics
servers:
- url: http://localhost:8080
description: Local development server
tags:
- name: kpi
description: Key performance indicators (ILI, stress, beta, regime, EVT risk).
- name: signals
description: Alpha signal catalog and detail.
- name: config
description: Hot-reloadable configuration and change log.
- name: health
description: Aggregated system health.
- name: demo
description: Virtual portfolio and paper-trading endpoints.
- name: quality
description: Anomaly detection and drift simulation.
- name: regime
description: Regime detection (GARCH, CNN-LSTM hybrid, QED).
- name: disaster
description: Disaster alert ingestion (USGS/GDACS).
- name: operations
description: Participation governance and liquidity stress testing.
- name: optimization
description: Weight optimization status and execution.
- name: sentiment
description: News sentiment (model and lexicon).
- name: stops
description: Dynamic Markov stop calibration.
- name: leverage
description: Leverage rotation signaling.
- name: pairs
description: Pairs trading engine.
- name: diagnostics
description: Statistical diagnostics (QQ, ACF, convergence).
- name: volatility
description: Volatility forecasting.
- name: tournament
description: Multi-model tournament evaluation.
- name: explainability
description: Feature-importance attribution.
- name: fixed-income
description: Fixed-income fair value and analytical Greeks.
- name: quant
description: v5.2 quantitative engine (strategies, EVT, IRF, audit).
paths:
# ---------------------------------------------------------------------------
# KPI
# ---------------------------------------------------------------------------
/api/v1/kpi/ili:
get:
tags: [kpi]
operationId: getIli
summary: Current Institutional Liquidity Index (ILI) value with components.
responses:
'200':
description: Current ILI snapshot.
content:
application/json:
schema: { $ref: '#/components/schemas/IliSnapshot' }
/api/v1/kpi/ili/history:
get:
tags: [kpi]
operationId: getIliHistory
summary: ILI time-series history.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
responses:
'200':
description: Paginated ILI history.
content:
application/json:
schema: { $ref: '#/components/schemas/IliHistory' }
/api/v1/kpi/liquidity-stress:
get:
tags: [kpi]
operationId: getLiquidityStress
summary: Liquidity Stress Index.
responses:
'200':
description: Liquidity stress snapshot.
content:
application/json:
schema: { $ref: '#/components/schemas/LiquidityStress' }
/api/v1/kpi/repo-equity-beta:
get:
tags: [kpi]
operationId: getRepoEquityBeta
summary: Repo/Equity Beta per symbol.
parameters:
- name: symbol
in: query
required: false
schema: { type: string }
responses:
'200':
description: Repo/equity beta readings.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/RepoEquityBeta' }
/api/v1/kpi/rrp-drain:
get:
tags: [kpi]
operationId: getRrpDrain
summary: Reverse Repo Facility (RRP) drain velocity.
responses:
'200':
description: RRP drain velocity.
content:
application/json:
schema: { $ref: '#/components/schemas/RrpDrain' }
/api/v1/kpi/systemic-risk-heatmap:
get:
tags: [kpi]
operationId: getSystemicRiskHeatmap
summary: Systemic risk heatmap data.
responses:
'200':
description: Systemic risk heatmap.
content:
application/json:
schema: { $ref: '#/components/schemas/SystemicRiskHeatmap' }
/api/v1/kpi/volatility-regime:
get:
tags: [kpi]
operationId: getVolatilityRegime
summary: Volatility regime status.
responses:
'200':
description: Volatility regime.
content:
application/json:
schema: { $ref: '#/components/schemas/VolatilityRegime' }
/api/v1/kpi/evt-risk:
get:
tags: [kpi]
operationId: getEvtRisk
summary: Extreme Value Theory (EVT) risk metrics (v5.2).
responses:
'200':
description: EVT risk metrics.
content:
application/json:
schema: { $ref: '#/components/schemas/EvtRiskMetrics' }
/api/v1/kpi/efficiency-gap:
get:
tags: [kpi]
operationId: getEfficiencyGap
summary: Market efficiency gap KPI (v5.1).
responses:
'200':
description: Efficiency gap.
content:
application/json:
schema: { $ref: '#/components/schemas/EfficiencyGap' }
/api/v1/kpi/monetary-policy:
get:
tags: [kpi]
operationId: getMonetaryPolicy
summary: Monetary policy KPI (v5.1).
responses:
'200':
description: Monetary policy summary.
content:
application/json:
schema: { $ref: '#/components/schemas/MonetaryPolicy' }
# ---------------------------------------------------------------------------
# Signals
# ---------------------------------------------------------------------------
/api/v1/signals:
get:
tags: [signals]
operationId: listSignals
summary: Recent signals with filters.
parameters:
- name: symbol
in: query
required: false
schema: { type: string }
- name: direction
in: query
required: false
schema: { $ref: '#/components/schemas/SignalDirection' }
- name: status
in: query
required: false
schema: { type: string }
- $ref: '#/components/parameters/Limit'
responses:
'200':
description: Filtered signal list.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/Signal' }
/api/v1/signals/{id}:
get:
tags: [signals]
operationId: getSignal
summary: Single signal detail.
parameters:
- $ref: '#/components/parameters/UuidPath'
responses:
'200':
description: Signal detail.
content:
application/json:
schema: { $ref: '#/components/schemas/SignalDetail' }
'404': { $ref: '#/components/responses/NotFound' }
# ---------------------------------------------------------------------------
# Config
# ---------------------------------------------------------------------------
/api/v1/config:
get:
tags: [config]
operationId: getConfig
summary: Current configuration snapshot.
responses:
'200':
description: Current configuration.
content:
application/json:
schema: { $ref: '#/components/schemas/ConfigSnapshot' }
put:
tags: [config]
operationId: updateConfig
summary: Update hot-reloadable configuration.
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/ConfigUpdate' }
responses:
'200':
description: Updated configuration.
content:
application/json:
schema: { $ref: '#/components/schemas/ConfigSnapshot' }
'400': { $ref: '#/components/responses/BadRequest' }
/api/v1/config/history:
get:
tags: [config]
operationId: getConfigHistory
summary: Configuration change log.
responses:
'200':
description: Configuration change history.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/ConfigHistoryEntry' }
# ---------------------------------------------------------------------------
# Health
# ---------------------------------------------------------------------------
/api/v1/health:
get:
tags: [health]
operationId: getHealth
summary: Aggregated system health.
responses:
'200':
description: System health.
content:
application/json:
schema: { $ref: '#/components/schemas/HealthStatus' }
# ---------------------------------------------------------------------------
# Demo / Virtual portfolio
# ---------------------------------------------------------------------------
/api/v1/demo/portfolio:
get:
tags: [demo]
operationId: getDemoPortfolio
summary: Virtual portfolio summary.
responses:
'200':
description: Portfolio summary.
content:
application/json:
schema: { $ref: '#/components/schemas/DemoPortfolio' }
/api/v1/demo/positions:
get:
tags: [demo]
operationId: getDemoPositions
summary: Open virtual positions.
responses:
'200':
description: Open positions.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/DemoPosition' }
/api/v1/demo/trades:
get:
tags: [demo]
operationId: getDemoTrades
summary: Paper trade history.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
responses:
'200':
description: Paper trades.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/DemoTrade' }
/api/v1/demo/signal-quality:
get:
tags: [demo]
operationId: getDemoSignalQuality
summary: Signal quality report.
responses:
'200':
description: Signal quality report.
content:
application/json:
schema: { $ref: '#/components/schemas/SignalQuality' }
/api/v1/demo/execution-comparison:
get:
tags: [demo]
operationId: getDemoExecutionComparison
summary: Dual portfolio P&L execution comparison (v5).
responses:
'200':
description: Execution comparison.
content:
application/json:
schema: { $ref: '#/components/schemas/ExecutionComparison' }
/api/v1/demo/close-position/{positionId}:
post:
tags: [demo]
operationId: closeDemoPosition
summary: Close a virtual position at the given price.
parameters:
- name: positionId
in: path
required: true
schema: { type: integer, format: int64 }
- name: price
in: query
required: true
schema: { type: number, format: double }
responses:
'200':
description: Resulting close trade.
content:
application/json:
schema: { $ref: '#/components/schemas/DemoCloseResult' }
# ---------------------------------------------------------------------------
# Quality: anomaly + drift
# ---------------------------------------------------------------------------
/api/v1/anomaly/detect:
post:
tags: [quality]
operationId: detectAnomaly
summary: Autoencoder anomaly detection on a submitted data window (v4).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/AnomalyDetectionRequest' }
responses:
'200':
description: Anomaly scores with MSE threshold classification.
content:
application/json:
schema: { $ref: '#/components/schemas/AnomalyDetectionResult' }
'400': { $ref: '#/components/responses/BadRequest' }
/api/v1/drift/simulate:
post:
tags: [quality]
operationId: simulateDrift
summary: Drift-diffusion simulation for parameter trajectories (v4).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/DriftSimulationRequest' }
responses:
'200':
description: Drift-diffusion trajectory with Ito process parameters.
content:
application/json:
schema: { $ref: '#/components/schemas/DriftSimulationResult' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Regime
# ---------------------------------------------------------------------------
/api/v1/regime/garch:
get:
tags: [regime]
operationId: getRegimeGarch
summary: GARCH regime status and conditional variance classification (v4).
responses:
'200':
description: GARCH regime status.
content:
application/json:
schema: { $ref: '#/components/schemas/RegimeStatus' }
/api/v1/regime/hybrid:
get:
tags: [regime]
operationId: getRegimeHybrid
summary: CNN-LSTM hybrid regime status and ensemble classification (v4).
responses:
'200':
description: Hybrid regime status.
content:
application/json:
schema: { $ref: '#/components/schemas/RegimeStatus' }
/api/v1/regime/qed:
get:
tags: [regime]
operationId: getRegimeQed
summary: QED market dynamics status and crash probability (v4).
responses:
'200':
description: QED regime status.
content:
application/json:
schema: { $ref: '#/components/schemas/RegimeStatus' }
/api/v1/regime/compare:
get:
tags: [regime]
operationId: compareRegimes
summary: A/B comparison of all regime detectors (v4).
responses:
'200':
description: Side-by-side regime comparison.
content:
application/json:
schema: { $ref: '#/components/schemas/RegimeComparison' }
# ---------------------------------------------------------------------------
# Disaster
# ---------------------------------------------------------------------------
/api/v1/disaster/alerts:
post:
tags: [disaster]
operationId: submitDisasterAlerts
summary: Disaster alert status from USGS/GDACS feeds (v4).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/DisasterAlertBatch' }
responses:
'200':
description: Acknowledged disaster alerts.
content:
application/json:
schema: { $ref: '#/components/schemas/DisasterAlertBatch' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Governance & stress
# ---------------------------------------------------------------------------
/api/v1/participation/status:
get:
tags: [operations]
operationId: getParticipationStatus
summary: Participation governance admissibility decomposition (v4).
responses:
'200':
description: Participation governance status.
content:
application/json:
schema: { $ref: '#/components/schemas/ParticipationStatus' }
/api/v1/stress/liquidity:
post:
tags: [operations]
operationId: runLiquidityStress
summary: Liquidity stress test execution (Swiss franc model) (v4).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/LiquidityStressRequest' }
responses:
'200':
description: Liquidity stress test results.
content:
application/json:
schema: { $ref: '#/components/schemas/LiquidityStressResult' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Optimization
# ---------------------------------------------------------------------------
/api/v1/optimization/status:
get:
tags: [optimization]
operationId: getOptimizationStatus
summary: Bayesian/Firefly optimizer status and last result (v4).
responses:
'200':
description: Optimizer status.
content:
application/json:
schema: { $ref: '#/components/schemas/OptimizationStatus' }
/api/v1/optimization/run:
post:
tags: [optimization]
operationId: runOptimization
summary: Trigger a weight optimization run (v4).
responses:
'200':
description: New weight proposal.
content:
application/json:
schema: { $ref: '#/components/schemas/OptimizationProposal' }
# ---------------------------------------------------------------------------
# Sentiment
# ---------------------------------------------------------------------------
/api/v1/sentiment/analyze:
post:
tags: [sentiment]
operationId: analyzeSentiment
summary: Model-based (FinBERT) sentiment scores with certainty (v5).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/SentimentRequest' }
responses:
'200':
description: Model sentiment scores.
content:
application/json:
schema: { $ref: '#/components/schemas/SentimentResult' }
'400': { $ref: '#/components/responses/BadRequest' }
/api/v1/sentiment/lexicon:
post:
tags: [sentiment]
operationId: lexiconSentiment
summary: Lexicon (SALI/AFINN) sentiment scores (v5).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/SentimentRequest' }
responses:
'200':
description: Lexicon sentiment scores.
content:
application/json:
schema: { $ref: '#/components/schemas/SentimentResult' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Stops
# ---------------------------------------------------------------------------
/api/v1/stops/calibrate:
post:
tags: [stops]
operationId: calibrateStops
summary: Markov optimal stop levels (v5).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/StopCalibrationRequest' }
responses:
'200':
description: Optimal stop levels.
content:
application/json:
schema: { $ref: '#/components/schemas/StopCalibrationResult' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Leverage
# ---------------------------------------------------------------------------
/api/v1/leverage/status:
get:
tags: [leverage]
operationId: getLeverageStatus
summary: Current leverage rotation signal (v5).
responses:
'200':
description: Leverage status.
content:
application/json:
schema: { $ref: '#/components/schemas/LeverageStatus' }
# ---------------------------------------------------------------------------
# Pairs
# ---------------------------------------------------------------------------
/api/v1/pairs/active:
get:
tags: [pairs]
operationId: getActivePairs
summary: Active pairs with divergence status (v5).
responses:
'200':
description: Active pairs.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/Pair' }
# ---------------------------------------------------------------------------
# Diagnostics
# ---------------------------------------------------------------------------
/api/v1/diagnostics/stats:
post:
tags: [diagnostics]
operationId: computeDiagnostics
summary: Statistical diagnostics (QQ-plot, ACF, convergence) (v5.1).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/DiagnosticsRequest' }
responses:
'200':
description: Diagnostic statistics.
content:
application/json:
schema: { $ref: '#/components/schemas/DiagnosticsResult' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Volatility forecast
# ---------------------------------------------------------------------------
/api/v1/volatility/forecast:
get:
tags: [volatility]
operationId: getVolatilityForecast
summary: Volatility forecast (v5.1).
parameters:
- name: symbol
in: query
required: false
schema: { type: string }
responses:
'200':
description: Volatility forecast.
content:
application/json:
schema: { $ref: '#/components/schemas/VolatilityForecast' }
# ---------------------------------------------------------------------------
# Tournament
# ---------------------------------------------------------------------------
/api/v1/tournament/evaluate:
post:
tags: [tournament]
operationId: evaluateTournament
summary: Multi-model tournament benchmark (v5.1).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/TournamentRequest' }
responses:
'200':
description: Tournament results.
content:
application/json:
schema: { $ref: '#/components/schemas/TournamentResult' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Explainability
# ---------------------------------------------------------------------------
/api/v1/explainability/feature-importance:
post:
tags: [explainability]
operationId: explainFeatureImportance
summary: Feature-importance attribution (v5.1).
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/ExplainabilityRequest' }
responses:
'200':
description: Feature importance.
content:
application/json:
schema: { $ref: '#/components/schemas/FeatureImportance' }
'400': { $ref: '#/components/responses/BadRequest' }
# ---------------------------------------------------------------------------
# Fixed income
# ---------------------------------------------------------------------------
/api/v1/fixed-income/q-world-fair-value:
get:
tags: [fixed-income]
operationId: getQWorldFairValue
summary: Fixed-income Q-world fair value via CIR model (v5.1).
parameters:
- name: rateType
in: query
required: false
schema: { $ref: '#/components/schemas/RateType' }
responses:
'200':
description: Q-world fair value.
content:
application/json:
schema: { $ref: '#/components/schemas/QWorldFairValue' }
/api/v1/fixed-income/tbill-greeks:
get:
tags: [fixed-income]
operationId: getTbillGreeks
summary: Analytical T-Bill Greeks (v5.1).
parameters:
- name: maturity
in: query
required: false
schema: { $ref: '#/components/schemas/RateType' }
responses:
'200':
description: T-Bill Greeks.
content:
application/json:
schema: { $ref: '#/components/schemas/TbillGreeks' }
# ---------------------------------------------------------------------------
# Quantitative engine (v5.2)
# ---------------------------------------------------------------------------
/api/v1/quant/strategies/active:
get:
tags: [quant]
operationId: getActiveQuantStrategies
summary: List all active strategies and their current status.
responses:
'200':
description: List of active strategies with formula references.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/StrategyStatus' }
/api/v1/quant/strategies/options/butterfly:
post:
tags: [quant]
operationId: computeButterflySignal
summary: Calculate butterfly spread signal (Eq. 79-100).
parameters:
- name: underlying
in: query
required: true
schema: { type: string }
responses:
'200':
description: Butterfly spread signal.
content:
application/json:
schema: { $ref: '#/components/schemas/AlphaSignal' }
/api/v1/quant/signals/active:
get:
tags: [quant]
operationId: getActiveQuantSignals
summary: Retrieve currently active alpha signals.
parameters:
- name: category
in: query
required: false
schema: { type: string }
responses:
'200':
description: List of active alpha signals.
content:
application/json:
schema:
type: array
items: { $ref: '#/components/schemas/AlphaSignal' }
/api/v1/quant/risk/tail-parameters:
get:
tags: [quant]
operationId: getTailParameters
summary: Retrieve Generalized Pareto Distribution (GPD) parameters for tail-risk assessment.
responses:
'200':
description: GPD tail parameters.
content:
application/json:
schema: { $ref: '#/components/schemas/EvtMetric' }
/api/v1/quant/risk/evt-tail:
get:
tags: [quant]
operationId: getEvtTail
summary: Retrieve EVT tail model output including IRF vectors.
responses:
'200':
description: EVT tail model output.
content:
application/json:
schema:
type: object
properties:
irfVector: { $ref: '#/components/schemas/IrfVector' }
/api/v1/quant/macro/shock-response:
get:
tags: [quant]
operationId: getShockResponse
summary: Retrieve structural VAR impulse response for macro shock analysis.
responses:
'200':
description: Structural VAR impulse response.
content:
application/json:
schema:
type: object
properties:
irfVector: { $ref: '#/components/schemas/IrfVector' }
/api/v1/quant/audit/intersubjective-reproducibility/{id}:
get:
tags: [quant]
operationId: getAuditPath
summary: Forensic reconstruction path (Coding Rules) for a specific data point.
parameters:
- $ref: '#/components/parameters/UuidPath'
responses:
'200':
description: Intersubjective reproducibility path.
content:
application/json:
schema: { $ref: '#/components/schemas/IntersubjectivePath' }
/api/v1/perspex/mismatches:
get:
tags: [perspex]
operationId: getPerspexMismatches
summary: Current perspective-mismatch signals (prediction-market vs OSINT news divergence).
description: >-
On-demand deterministic divergence between market-implied probability and news-tone-derived
probability. Real-time delivery is the /ws/signals WebSocket; this endpoint is for ad-hoc
inspection (ADR-037).
responses:
'200':
description: Deterministic perspective-mismatch verdicts.
content:
application/json:
schema:
type: object
properties:
mismatches:
type: array
items:
type: object
properties:
market_id: { type: string }
question: { type: string }
tickers: { type: array, items: { type: string } }
market_probability: { type: number, format: double }
news_probability: { type: number, format: double }
divergence: { type: number, format: double }
direction: { type: string, enum: [bullish, bearish] }
confidence: { type: number, format: double }
evaluated_markets: { type: integer }
skipped_thin: { type: integer }
skipped_no_ticker: { type: integer }
skipped_no_news: { type: integer }
skipped_aligned: { type: integer }
'503':
description: Analytics worker unavailable.
components:
parameters:
Limit:
name: limit
in: query
required: false
schema: { type: integer, minimum: 1, maximum: 1000, default: 100 }
Offset:
name: offset
in: query
required: false
schema: { type: integer, minimum: 0, default: 0 }
UuidPath:
name: id
in: path
required: true
schema: { type: string, format: uuid }
responses:
BadRequest:
description: Invalid request payload or parameters.
content:
application/json:
schema: { $ref: '#/components/schemas/Error' }
NotFound:
description: Resource not found.
content:
application/json:
schema: { $ref: '#/components/schemas/Error' }
schemas:
# ---- CDM-aligned enumerations -----------------------------------------
RateType:
type: string
description: CDM-aligned rate/instrument identifier (mirrors cdm RateType enum).
enum: [SOFR, EFFR, TGCR, BGCR, IORB, OBFR, RRP, TGA, WALCL, TBILL_3M, TBILL_1M, TBILL_6M, TBILL_1Y, TBILL_2Y, TBILL_5Y, TBILL_10Y, TBILL_30Y, VIX, OIL_WTI, OIL_BRENT, GOLD]
InstrumentType:
type: string
description: CDM product taxonomy (mirrors cdm InstrumentType enum).
enum: [SOFR, EFFR, TGCR, BGCR, IORB, OBFR, REPO, BILL_3M, EQUITY, COMMODITY_OIL, COMMODITY_GOLD]
OptionType:
type: string
enum: [CALL, PUT]
SignalDirection:
type: string
enum: [LONG, SHORT, NEUTRAL]
# ---- Shared ------------------------------------------------------------
Error:
type: object
required: [timestamp, status, message]
properties:
timestamp: { type: string, format: date-time }
status: { type: integer }
message: { type: string }
path: { type: string }
AlphaSignal:
type: object
required: [timestamp, strategyId, symbol, direction]
properties:
timestamp: { type: string, format: date-time }
strategyId: { type: string, format: uuid }
symbol: { type: string }
direction: { $ref: '#/components/schemas/SignalDirection' }
strength: { type: number, format: double }
confidence: { type: number, format: double }
expected_move: { type: number, format: double }
metrics:
type: object
additionalProperties: { type: number }
StrategyStatus:
type: object
properties:
id: { type: string, format: uuid }
name: { type: string }
category: { type: string }
formula_refs: { type: array, items: { type: string } }