-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathzero-paper-api.v1.yaml
More file actions
2373 lines (2373 loc) · 70.9 KB
/
zero-paper-api.v1.yaml
File metadata and controls
2373 lines (2373 loc) · 70.9 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: ZERO Paper API
version: 0.1.2
summary: Local paper runtime and operator API for ZERO.
description: |
ZERO Paper API is the public local runtime contract for paper-first,
self-custodial onchain operations. It requires no exchange credentials by
default. Live execution is local opt-in and is refused unless local custody,
journal, risk, and emergency preflight checks pass.
license:
name: Apache-2.0
identifier: Apache-2.0
servers:
- url: http://127.0.0.1:8765
description: Local paper runtime
tags:
- name: runtime
- name: operator
- name: paper
- name: audit
- name: network
- name: intelligence
- name: live
- name: market
paths:
/:
get:
tags: [runtime]
operationId: getRoot
summary: Runtime version probe.
responses:
"200":
description: Runtime identity and status.
content:
application/json:
schema:
$ref: "#/components/schemas/RootResponse"
/health:
get:
tags: [runtime]
operationId: getHealth
summary: Health, dependency, circuit breaker, and recovery state.
responses:
"200":
description: Runtime health packet.
content:
application/json:
schema:
$ref: "#/components/schemas/HealthResponse"
/v2/status:
get:
tags: [operator]
operationId: getV2Status
summary: Operator status summary consumed by the CLI.
responses:
"200":
description: Operator status packet.
content:
application/json:
schema:
$ref: "#/components/schemas/V2StatusResponse"
/positions:
get:
tags: [operator]
operationId: getPositions
summary: Current paper positions.
responses:
"200":
description: Position list.
content:
application/json:
schema:
$ref: "#/components/schemas/PositionsResponse"
/risk:
get:
tags: [operator]
operationId: getRisk
summary: Current risk state.
responses:
"200":
description: Risk state.
content:
application/json:
schema:
$ref: "#/components/schemas/RiskResponse"
/brief:
get:
tags: [operator]
operationId: getBrief
summary: Compact operator brief.
responses:
"200":
description: Brief packet.
content:
application/json:
schema:
$ref: "#/components/schemas/BriefResponse"
/decision/stack:
get:
tags: [paper]
operationId: getDecisionStack
summary: Paper lens, layer, and modifier decision stack.
parameters:
- $ref: "#/components/parameters/CoinQuery"
responses:
"200":
description: Decision stack packet.
content:
application/json:
schema:
$ref: "#/components/schemas/DecisionStackResponse"
"400":
$ref: "#/components/responses/BadRequest"
"503":
$ref: "#/components/responses/Unavailable"
/regime:
get:
tags: [operator]
operationId: getRegime
summary: Paper regime readout.
parameters:
- $ref: "#/components/parameters/CoinQuery"
responses:
"200":
description: Regime packet.
content:
application/json:
schema:
$ref: "#/components/schemas/RegimeResponse"
/evaluate/{coin}:
get:
tags: [paper]
operationId: evaluateCoin
summary: Evaluate a paper setup for one coin.
parameters:
- name: coin
in: path
required: true
schema:
type: string
example: BTC
responses:
"200":
description: Evaluation packet.
content:
application/json:
schema:
$ref: "#/components/schemas/EvaluateResponse"
"400":
$ref: "#/components/responses/BadRequest"
"503":
$ref: "#/components/responses/Unavailable"
/pulse:
get:
tags: [operator]
operationId: getPulse
summary: Recent decision events.
parameters:
- $ref: "#/components/parameters/LimitQuery"
responses:
"200":
description: Recent event packet.
content:
application/json:
schema:
$ref: "#/components/schemas/PulseResponse"
/approaching:
get:
tags: [operator]
operationId: getApproaching
summary: Gates or limits the operator is approaching.
responses:
"200":
description: Approaching packet.
content:
application/json:
schema:
$ref: "#/components/schemas/ApproachingResponse"
/rejections:
get:
tags: [paper]
operationId: getRejections
summary: Recent rejected paper decisions.
parameters:
- $ref: "#/components/parameters/CoinQuery"
- $ref: "#/components/parameters/LimitQuery"
responses:
"200":
description: Rejection list.
content:
application/json:
schema:
$ref: "#/components/schemas/RejectionsResponse"
/journal:
get:
tags: [audit]
operationId: getJournal
summary: Recent paper decision journal records.
parameters:
- $ref: "#/components/parameters/LimitQuery"
responses:
"200":
description: Journal tail.
content:
application/json:
schema:
$ref: "#/components/schemas/JournalResponse"
/memory:
get:
tags: [audit]
operationId: getMemory
summary: Public-safe local memory snapshot.
parameters:
- $ref: "#/components/parameters/LimitQuery"
- name: format
in: query
required: false
schema:
type: string
enum: [json, md]
responses:
"200":
description: Redacted memory state.
content:
application/json:
schema:
$ref: "#/components/schemas/MemorySnapshotResponse"
/genesis:
get:
tags: [audit]
operationId: getGenesis
summary: Plan-only genesis proposal classifications.
responses:
"200":
description: Genesis proposal snapshot.
content:
application/json:
schema:
$ref: "#/components/schemas/GenesisSnapshotResponse"
/evolve:
get:
tags: [audit]
operationId: getEvolve
summary: Paper-only evolve gate status.
responses:
"200":
description: Evolve gate snapshot.
content:
application/json:
schema:
$ref: "#/components/schemas/EvolveSnapshotResponse"
/research:
get:
tags: [audit]
operationId: getResearch
summary: Paper-only research command-chain report.
responses:
"200":
description: Research command-chain snapshot.
content:
application/json:
schema:
$ref: "#/components/schemas/ResearchSnapshotResponse"
/runtime/parity:
get:
tags: [runtime]
operationId: getRuntimeParity
summary: Production-parity OODA report with disabled live shadow execution.
responses:
"200":
description: Runtime production-parity packet.
content:
application/json:
schema:
$ref: "#/components/schemas/RuntimeParityResponse"
/metrics:
get:
tags: [audit]
operationId: getMetrics
summary: Runtime counters and recovery metrics.
responses:
"200":
description: Metrics packet.
content:
application/json:
schema:
$ref: "#/components/schemas/MetricsResponse"
/immune:
get:
tags: [runtime]
operationId: getImmune
summary: Risk-blocking immune and circuit-breaker state.
responses:
"200":
description: Immune breaker packet.
content:
application/json:
schema:
$ref: "#/components/schemas/ImmuneResponse"
/audit/export:
get:
tags: [audit]
operationId: getAuditExport
summary: Structured audit export for a paper session.
parameters:
- $ref: "#/components/parameters/LimitQuery"
responses:
"200":
description: Audit export.
content:
application/json:
schema:
$ref: "#/components/schemas/AuditExportResponse"
/deployment/claim:
get:
tags: [network]
operationId: getDeploymentClaim
summary: Public-safe local deployment identity claim.
responses:
"200":
description: Signature-ready deployment claim packet.
content:
application/json:
schema:
$ref: "#/components/schemas/DeploymentClaimResponse"
/deployment/heartbeat:
get:
tags: [network]
operationId: getDeploymentHeartbeat
summary: Public-safe local deployment heartbeat and liveness packet.
responses:
"200":
description: Signature-ready deployment heartbeat packet.
content:
application/json:
schema:
$ref: "#/components/schemas/DeploymentHeartbeatResponse"
/network/profile:
get:
tags: [network]
operationId: getNetworkProfile
summary: Public-safe local ZERO Network profile packet.
responses:
"200":
description: Public profile packet.
content:
application/json:
schema:
$ref: "#/components/schemas/NetworkProfileResponse"
/network/leaderboard:
get:
tags: [network]
operationId: getNetworkLeaderboard
summary: Public-safe local leaderboard row.
responses:
"200":
description: Local leaderboard packet.
content:
application/json:
schema:
$ref: "#/components/schemas/NetworkLeaderboardResponse"
/network/publish:
post:
tags: [network]
operationId: publishNetworkProfile
summary: Append a redacted profile packet to a local proof log.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NetworkPublishRequest"
responses:
"200":
description: Publish result.
content:
application/json:
schema:
$ref: "#/components/schemas/LocalExportResponse"
"400":
$ref: "#/components/responses/BadRequest"
/network/ingest:
post:
tags: [network]
operationId: ingestNetworkProfiles
summary: Validate redacted profile packets with hosted-style anti-gaming rules.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NetworkIngestRequest"
responses:
"200":
description: Ingestion decision packet.
content:
application/json:
schema:
$ref: "#/components/schemas/NetworkIngestionResponse"
"400":
$ref: "#/components/responses/BadRequest"
/intelligence/snapshot:
get:
tags: [intelligence]
operationId: getIntelligenceSnapshot
summary: Delayed public ZERO Intelligence snapshot.
responses:
"200":
description: Delayed aggregate intelligence packet.
content:
application/json:
schema:
$ref: "#/components/schemas/IntelligenceSnapshotResponse"
/intelligence/catalog:
get:
tags: [intelligence]
operationId: getIntelligenceCatalog
summary: Public catalog for commercial ZERO Intelligence surfaces.
responses:
"200":
description: Intelligence catalog.
content:
application/json:
schema:
$ref: "#/components/schemas/IntelligenceCatalogResponse"
/intelligence/commercial:
get:
tags: [intelligence]
operationId: getIntelligenceCommercial
summary: Billing-ready commercial ZERO Intelligence API contract.
responses:
"200":
description: Commercial API boundary, scopes, plans, usage events, and privacy contract.
content:
application/json:
schema:
$ref: "#/components/schemas/IntelligenceCommercialResponse"
/intelligence/model-gateway:
get:
tags: [intelligence]
operationId: getIntelligenceModelGateway
summary: Public-safe model gateway provider and fail-closed routing status.
responses:
"200":
description: Model gateway status.
content:
application/json:
schema:
$ref: "#/components/schemas/ModelGatewayStatusResponse"
/intelligence/model-gateway/health:
get:
tags: [intelligence]
operationId: getIntelligenceModelGatewayHealth
summary: Public-safe model gateway health probe.
parameters:
- name: network
in: query
required: false
description: Run an explicit provider network probe when true.
schema:
type: boolean
default: false
responses:
"200":
description: Model gateway health packet.
content:
application/json:
schema:
$ref: "#/components/schemas/ModelGatewayHealthResponse"
/intelligence/model-gateway/audit:
get:
tags: [intelligence]
operationId: getIntelligenceModelGatewayAudit
summary: Public-safe model gateway audit bundle.
responses:
"200":
description: Model gateway audit bundle.
content:
application/json:
schema:
$ref: "#/components/schemas/ModelGatewayAuditResponse"
/intelligence/export:
post:
tags: [intelligence]
operationId: exportIntelligenceSnapshot
summary: Append a delayed intelligence snapshot to a local export log.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ConsentRequest"
responses:
"200":
description: Export result.
content:
application/json:
schema:
$ref: "#/components/schemas/LocalExportResponse"
/v1/intelligence/snapshots:
get:
tags: [intelligence]
operationId: getHostedIntelligenceSnapshots
summary: Hosted-compatible snapshot feed with public delayed access and paid realtime scope.
parameters:
- name: freshness
in: query
required: false
schema:
type: string
enum: [delayed, realtime]
default: delayed
responses:
"200":
description: Hosted-compatible snapshot feed response.
headers:
x-zero-ratelimit-limit:
schema: { type: string }
x-zero-ratelimit-remaining:
schema: { type: string }
x-zero-ratelimit-reset:
schema: { type: string }
x-zero-ratelimit-policy:
schema: { type: string }
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceResponse"
"401":
description: Missing or invalid token for paid freshness.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
"403":
description: Token does not grant the requested scope.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
/v1/intelligence/history:
get:
tags: [intelligence]
operationId: getHostedIntelligenceHistory
summary: Hosted-compatible historical intelligence query.
responses:
"200":
description: Hosted-compatible history response.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceResponse"
"401":
description: Missing or invalid token.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
"403":
description: Token does not grant the requested scope.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
/v1/intelligence/cohorts:
get:
tags: [intelligence]
operationId: getHostedIntelligenceCohorts
summary: Hosted-compatible cohort analytics query.
responses:
"200":
description: Hosted-compatible cohort response.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceResponse"
"401":
description: Missing or invalid token.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
"403":
description: Token does not grant the requested scope.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
/v1/intelligence/benchmarks:
get:
tags: [intelligence]
operationId: getHostedIntelligenceBenchmarks
summary: Hosted-compatible benchmark analytics query.
responses:
"200":
description: Hosted-compatible benchmark response.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceResponse"
"401":
description: Missing or invalid token.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
"403":
description: Token does not grant the requested scope.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
/v1/intelligence/webhooks:
post:
tags: [intelligence]
operationId: createHostedIntelligenceWebhook
summary: Hosted-compatible webhook subscription and signature fixture.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceWriteRequest"
responses:
"200":
description: Hosted-compatible webhook subscription response.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceResponse"
"401":
description: Missing or invalid token.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
"403":
description: Token does not grant the requested scope.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
/v1/intelligence/exports:
post:
tags: [intelligence]
operationId: createHostedIntelligenceExport
summary: Hosted-compatible bulk export job.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceWriteRequest"
responses:
"200":
description: Hosted-compatible export job response.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceResponse"
"401":
description: Missing or invalid token.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
"403":
description: Token does not grant the requested scope.
content:
application/json:
schema:
$ref: "#/components/schemas/HostedIntelligenceErrorResponse"
/hl/status:
get:
tags: [market]
operationId: getHyperliquidStatus
summary: Hyperliquid read-only market status.
parameters:
- name: symbol
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
responses:
"200":
description: Disabled metadata or read-only Hyperliquid status.
content:
application/json:
schema:
$ref: "#/components/schemas/HyperliquidStatusResponse"
/hl/account:
get:
tags: [market]
operationId: getHyperliquidAccount
summary: Hyperliquid read-only account snapshot.
responses:
"200":
description: Normalized read-only account truth.
content:
application/json:
schema:
$ref: "#/components/schemas/HyperliquidAccountResponse"
"400":
$ref: "#/components/responses/BadRequest"
/hl/reconcile:
get:
tags: [market]
operationId: getHyperliquidReconciliation
summary: Local runtime versus Hyperliquid account reconciliation.
responses:
"200":
description: Reconciliation packet used by live risk gates.
content:
application/json:
schema:
$ref: "#/components/schemas/HyperliquidReconciliationResponse"
/market/quote:
get:
tags: [market]
operationId: getMarketQuote
summary: Active quote source used by paper execution.
parameters:
- name: symbol
in: query
required: true
schema:
type: string
example: BTC
responses:
"200":
description: Quote packet.
content:
application/json:
schema:
$ref: "#/components/schemas/MarketQuoteResponse"
"400":
$ref: "#/components/responses/BadRequest"
"503":
$ref: "#/components/responses/Unavailable"
/operator/state:
get:
tags: [operator]
operationId: getOperatorState
summary: Operator friction state consumed by the terminal.
responses:
"200":
description: Operator state packet.
content:
application/json:
schema:
$ref: "#/components/schemas/OperatorStateResponse"
/operator/context:
get:
tags: [operator]
operationId: getOperatorContext
summary: Current operator audit identity.
parameters:
- name: X-Zero-Operator-Id
in: header
required: false
schema:
type: string
- name: X-Zero-Operator-Handle
in: header
required: false
schema:
type: string
- name: X-Zero-Operator-Role
in: header
required: false
schema:
type: string
- name: X-Zero-Operator-Scope
in: header
required: false
schema:
type: string
responses:
"200":
description: Operator context packet.
content:
application/json:
schema:
$ref: "#/components/schemas/OperatorContextResponse"
/operator/events:
post:
tags: [operator]
operationId: postOperatorEvents
summary: Submit local operator events.
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
responses:
"200":
description: Accepted event count and current operator snapshot.
content:
application/json:
schema:
$ref: "#/components/schemas/OperatorEventsResponse"
/execute:
post:
tags: [paper, live]
operationId: postExecute
summary: Submit a paper order, or live order when X-Zero-Mode is live.
parameters:
- name: X-Zero-Mode
in: header
required: false
schema:
type: string
enum: [paper, live]
default: paper
- name: X-Zero-Expose-Trace
in: header
required: false
schema:
type: string
enum: ["true", "false"]
default: "false"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ExecuteRequest"
responses:
"200":
description: Paper fill/refusal or live submission/refusal.
headers:
X-Zero-Trace-Id:
$ref: "#/components/headers/TraceId"
content:
application/json:
schema:
$ref: "#/components/schemas/ExecuteResponse"
"400":
$ref: "#/components/responses/BadRequest"
"503":
$ref: "#/components/responses/Unavailable"
/auto/toggle:
post:
tags: [operator]
operationId: postAutoToggle
summary: Toggle local simulated automation state.
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [enabled]
properties:
enabled:
type: boolean
additionalProperties: false
responses:
"200":
description: Toggle result.
content:
application/json:
schema:
$ref: "#/components/schemas/AutoToggleResponse"
/live/preflight:
get:
tags: [live]
operationId: getLivePreflight
summary: Non-secret local live-readiness gate.
responses:
"200":
description: Live preflight packet.
content:
application/json:
schema:
$ref: "#/components/schemas/LivePreflightResponse"
/live/cockpit:
get:
tags: [live]
operationId: getLiveCockpit
summary: Consolidated read-only live operator cockpit packet.
responses:
"200":
description: Live cockpit packet.
content:
application/json:
schema:
$ref: "#/components/schemas/LiveCockpitResponse"
/live/canary-policy:
get:
tags: [live]
operationId: getLiveCanaryPolicy
summary: Read-only live canary policy lifecycle and next-step recommendation.
responses:
"200":
description: Canary policy lifecycle packet.
content:
application/json:
schema:
$ref: "#/components/schemas/LiveCanaryPolicyResponse"
/live/certification:
get:
tags: [live]
operationId: getLiveCertification
summary: Dry-run live execution certification harness.
responses:
"200":
description: Certification drills and evidence requirements.
content:
application/json:
schema:
$ref: "#/components/schemas/LiveCertificationResponse"
/live/receipts:
get:
tags: [live]
operationId: getLiveReceipts
summary: Public-safe local live execution receipt bundle.
responses:
"200":
description: Execution receipts with hashed local tokens and venue acknowledgement.
content:
application/json:
schema:
$ref: "#/components/schemas/LiveExecutionReceiptsResponse"
/live/evidence:
get:
tags: [live]
operationId: getLiveEvidence
summary: Public-safe signed live-readiness evidence packet.
responses:
"200":
description: Hash-only canary evidence bundle.
content:
application/json:
schema:
$ref: "#/components/schemas/LiveEvidenceResponse"
/live/heartbeat:
post:
tags: [live]
operationId: postLiveHeartbeat
summary: Refresh local live dead-man heartbeat.
responses:
"200":
$ref: "#/components/responses/LiveControl"
/live/pause:
post:
tags: [live]
operationId: postLivePause
summary: Pause local live entry control.
responses:
"200":
$ref: "#/components/responses/LiveControl"
/live/resume:
post:
tags: [live]
operationId: postLiveResume
summary: Resume local live entry control.
responses:
"200":
$ref: "#/components/responses/LiveControl"
/live/kill:
post:
tags: [live]
operationId: postLiveKill
summary: Engage local live kill switch and cancel open orders.
responses:
"200":
$ref: "#/components/responses/LiveControl"
/live/flatten:
post:
tags: [live]
operationId: postLiveFlatten
summary: Submit reduce-only flatten orders for local live positions.
responses:
"200":
description: Flatten result.
content:
application/json:
schema:
$ref: "#/components/schemas/LiveFlattenResponse"
components:
parameters:
CoinQuery:
name: coin
in: query
required: false
schema:
type: string
example: BTC
LimitQuery:
name: limit
in: query
required: false