Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1842 lines (1787 loc) · 48.2 KB
/
Copy pathopenapi.yaml
File metadata and controls
1842 lines (1787 loc) · 48.2 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.0.0
info:
title: Lens API
description: Unified Stellar price API aggregating SDEX + AMM prices.
version: 0.1.0
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: http://localhost:4000
description: Local development server
paths:
/status:
get:
operationId: getStatus
summary: Get API status and indexer state
security: []
parameters:
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: API status
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
network:
type: string
enum: [testnet, mainnet]
watchedPairs:
type: array
items:
type: string
lastIndexedLedger:
type: integer
nullable: true
lastProcessedAt:
type: string
format: date-time
nullable: true
ingestLagSeconds:
type: integer
nullable: true
'429':
$ref: '#/components/responses/TooManyRequests'
/price/{assetA}/{assetB}:
get:
operationId: getPrice
summary: Get aggregated price for a pair
security:
- x402: []
parameters:
- name: assetA
in: path
required: true
schema:
type: string
example: XLM
- name: assetB
in: path
required: true
schema:
type: string
example: USDC
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Aggregated price data
content:
application/json:
schema:
$ref: '#/components/schemas/AggregatedPrice'
'402':
$ref: '#/components/responses/PaymentRequired'
'404':
description: Pair not watched
'429':
$ref: '#/components/responses/TooManyRequests'
/price/{assetA}/{assetB}/route:
get:
operationId: getBestRoute
summary: Get best swap route for a pair and amount
security:
- x402: []
parameters:
- name: assetA
in: path
required: true
schema:
type: string
- name: assetB
in: path
required: true
schema:
type: string
- name: amount
in: query
required: false
schema:
type: number
default: 1000
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Best route information
content:
application/json:
schema:
$ref: '#/components/schemas/RouteInfo'
'402':
$ref: '#/components/responses/PaymentRequired'
'429':
$ref: '#/components/responses/TooManyRequests'
/price/{assetA}/{assetB}/history:
get:
operationId: getPriceHistory
summary: Get price history buckets
security: []
parameters:
- name: assetA
in: path
required: true
schema:
type: string
- name: assetB
in: path
required: true
schema:
type: string
- name: window
in: query
required: false
schema:
type: string
enum: [1m, 5m, 1h, 24h]
default: 1h
- name: limit
in: query
required: false
schema:
type: integer
default: 100
maximum: 1000
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Price history
content:
application/json:
schema:
type: object
properties:
pairKey:
type: string
network:
type: string
enum: [testnet, mainnet]
window:
type: string
buckets:
type: array
items:
$ref: '#/components/schemas/PriceBucket'
'400':
description: Invalid parameters
'429':
$ref: '#/components/responses/TooManyRequests'
/pools:
get:
operationId: getPools
summary: Get AMM liquidity pool reserves and spot prices
security:
- x402: []
parameters:
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: List of pools
content:
application/json:
schema:
type: object
properties:
pools:
type: array
items:
type: object
properties:
pool_id:
type: string
asset_a:
type: string
asset_b:
type: string
reserve_a:
type: number
reserve_b:
type: number
spot_price:
type: number
fee_bp:
type: integer
timestamp:
type: string
format: date-time
'402':
$ref: '#/components/responses/PaymentRequired'
'429':
$ref: '#/components/responses/TooManyRequests'
/candles/{assetA}/{assetB}:
get:
operationId: getCandles
summary: Get OHLCV candle data
security:
- x402: []
parameters:
- name: assetA
in: path
required: true
schema:
type: string
- name: assetB
in: path
required: true
schema:
type: string
- name: interval
in: query
required: false
schema:
type: string
enum: [1m, 5m, 15m, 1h, 4h, 1d]
default: 1h
- name: from
in: query
required: false
schema:
type: string
format: date-time
- name: to
in: query
required: false
schema:
type: string
format: date-time
responses:
'200':
description: Candle data
content:
application/json:
schema:
type: object
properties:
pairKey:
type: string
interval:
type: string
from:
type: string
to:
type: string
candles:
type: array
items:
type: object
properties:
time:
type: string
format: date-time
open:
type: number
high:
type: number
low:
type: number
close:
type: number
volume:
type: number
'400':
description: Invalid parameters
'402':
$ref: '#/components/responses/PaymentRequired'
'429':
$ref: '#/components/responses/TooManyRequests'
/prices/history:
get:
operationId: getPriceSnapshots
summary: Get historical 1-minute price snapshots
description: >-
Returns minute-resolution price snapshots for a pair over [from, to],
optionally aggregated into 5m or 1h buckets. Snapshots are retained for
~30 days. Gated by x402 (matches the /price prefix).
security:
- x402: []
parameters:
- name: pair
in: query
required: true
schema:
type: string
example: XLM/USDC
- name: interval
in: query
required: false
schema:
type: string
enum: [1m, 5m, 1h]
default: 1m
- name: from
in: query
required: false
schema:
type: string
format: date-time
- name: to
in: query
required: false
schema:
type: string
format: date-time
- name: format
in: query
required: false
description: >-
Response encoding. `csv` returns a text/csv body holding a
`ts,price,volume` table (RFC 4180 quoting, LF line endings, one
trailing newline); `json` is the default.
schema:
type: string
enum: [json, csv]
default: json
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Historical price snapshots
content:
text/csv:
schema:
type: string
example: "ts,price,volume\n2025-01-01T00:00:00.000Z,1.25,500\n"
application/json:
schema:
type: object
properties:
pair:
type: string
network:
type: string
enum: [testnet, mainnet]
interval:
type: string
from:
type: string
format: date-time
to:
type: string
format: date-time
count:
type: integer
points:
type: array
items:
type: object
properties:
ts:
type: string
format: date-time
price:
type: number
volume:
type: number
'400':
description: Invalid parameters
'402':
$ref: '#/components/responses/PaymentRequired'
'429':
$ref: '#/components/responses/TooManyRequests'
/pairs:
get:
operationId: listPairs
summary: List all active trading pairs
security: []
parameters:
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: List of pairs
content:
application/json:
schema:
type: object
properties:
pairs:
type: array
items:
type: object
properties:
pairKey:
type: string
assetA:
$ref: '#/components/schemas/Asset'
assetB:
$ref: '#/components/schemas/Asset'
latestPrice:
type: number
nullable: true
lastUpdated:
type: string
format: date-time
nullable: true
'429':
$ref: '#/components/responses/TooManyRequests'
post:
operationId: addPair
summary: Add a new trading pair (Admin only)
security:
- adminAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
assetA:
type: string
example: XLM
assetB:
type: string
example: USDC:GBBD47...
responses:
'201':
description: Pair added
'400':
description: Invalid input
'401':
description: Unauthorized
'409':
description: Pair already exists
'429':
$ref: '#/components/responses/TooManyRequests'
/price/{assetA}/{assetB}/depth:
get:
operationId: getDepth
summary: Get order-book depth and execution slippage for a pair
description: >-
Simulates an order of `amount` units of assetA and returns the price
ladder plus the execution price and slippage versus the spot price.
security:
- x402: []
parameters:
- name: assetA
in: path
required: true
schema:
type: string
example: XLM
- name: assetB
in: path
required: true
schema:
type: string
example: USDC
- name: amount
in: query
required: false
schema:
type: number
default: 1000
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Depth ladder
content:
application/json:
schema:
$ref: '#/components/schemas/DepthResponse'
'400':
description: Invalid amount
'402':
$ref: '#/components/responses/PaymentRequired'
'404':
description: Pair not watched
'429':
$ref: '#/components/responses/TooManyRequests'
/price/twap/{assetA}/{assetB}:
get:
operationId: getTwap
summary: Get a manipulation-resistant time-weighted average price
security:
- x402: []
parameters:
- name: assetA
in: path
required: true
schema:
type: string
- name: assetB
in: path
required: true
schema:
type: string
- name: window
in: query
required: false
description: Lookback window in minutes.
schema:
type: integer
minimum: 1
maximum: 1440
default: 60
- name: sampleInterval
in: query
required: false
description: Sampling grid width in seconds.
schema:
type: integer
minimum: 1
maximum: 3600
default: 60
- name: method
in: query
required: false
schema:
type: string
enum: [iqr, modified_zscore]
default: iqr
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: TWAP result
content:
application/json:
schema:
$ref: '#/components/schemas/TwapResponse'
'400':
description: Invalid parameters
'402':
$ref: '#/components/responses/PaymentRequired'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
description: TWAP computation failed
/price/vwap/{assetA}/{assetB}:
get:
operationId: getVwap
summary: Get a volume-weighted average price
security:
- x402: []
parameters:
- name: assetA
in: path
required: true
schema:
type: string
- name: assetB
in: path
required: true
schema:
type: string
- name: window
in: query
required: false
description: Lookback window in minutes.
schema:
type: integer
minimum: 1
maximum: 1440
default: 60
- name: source
in: query
required: false
description: Restrict to a single venue (omitted pools every venue).
schema:
type: string
enum: [SDEX, AMM]
- name: method
in: query
required: false
schema:
type: string
enum: [iqr, modified_zscore]
default: iqr
responses:
'200':
description: VWAP result
content:
application/json:
schema:
$ref: '#/components/schemas/VwapResponse'
'400':
description: Invalid parameters
'402':
$ref: '#/components/responses/PaymentRequired'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
description: VWAP computation failed
/volumes/{asset}:
get:
operationId: getVolumes
summary: Get cross-venue traded volume for an asset
description: >-
Sums traded volume for `asset` across every pair and venue it appears
in, measured in the asset's own units, with a per-venue breakdown.
security: []
parameters:
- name: asset
in: path
required: true
schema:
type: string
example: XLM
- name: window
in: query
required: false
schema:
type: string
enum: [24h, 7d, 30d]
default: 24h
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Aggregated volume
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeResponse'
'400':
description: Invalid window
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
description: Volume aggregation failed
/spreads/{asset}:
get:
operationId: getSpreads
summary: Get the tightest per-venue bid/ask spread for an asset
description: >-
Reports, for every (venue, pair) that quoted `asset` inside the window,
the observed low, high and spread in basis points, tightest first.
The spread is the dispersion of recent prints, not a resting order
book's top-of-book gap.
security: []
parameters:
- name: asset
in: path
required: true
schema:
type: string
example: XLM
- name: window
in: query
required: false
schema:
type: string
enum: [5m, 15m, 1h, 24h]
default: 5m
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Per-venue spreads
content:
application/json:
schema:
$ref: '#/components/schemas/SpreadResponse'
'400':
description: Invalid window or network
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
description: Spread aggregation failed
/compare/{asset}:
get:
operationId: compareAsset
summary: Compare Lens prices with every configured external oracle
security: []
parameters:
- name: asset
in: path
required: true
schema:
type: string
example: XLM
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Price comparison
content:
application/json:
schema:
$ref: '#/components/schemas/CompareResponse'
'404':
description: No price data found for the asset
'429':
$ref: '#/components/responses/TooManyRequests'
/screener:
get:
operationId: screenPairs
summary: Screen pairs by volume, change, liquidity and price
security: []
parameters:
- name: volume
in: query
required: false
schema:
type: number
- name: change_24h_min
in: query
required: false
schema:
type: number
- name: change_24h_max
in: query
required: false
schema:
type: number
- name: price_min
in: query
required: false
schema:
type: number
- name: price_max
in: query
required: false
schema:
type: number
- name: liquidity
in: query
required: false
schema:
type: number
- name: sortBy
in: query
required: false
schema:
type: string
enum: [volume, change_24h, price, liquidity]
default: volume
- name: order
in: query
required: false
schema:
type: string
enum: [asc, desc]
default: desc
- name: cursor
in: query
required: false
description: Opaque cursor returned as `nextCursor` by the previous page.
schema:
type: string
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 20
- $ref: '#/components/parameters/NetworkQuery'
responses:
'200':
description: Screened pairs
content:
application/json:
schema:
$ref: '#/components/schemas/ScreenerResponse'
'400':
description: Invalid filter, sort or cursor
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
description: Internal server error
/benchmark/{asset}:
get:
operationId: getBenchmark
summary: Get peg-deviation statistics for an asset against a target
security: []
parameters:
- name: asset
in: path
required: true
schema:
type: string
example: USDC
- name: target
in: query
required: false
schema:
type: string
default: USD
responses:
'200':
description: Benchmark statistics
content:
application/json:
schema:
$ref: '#/components/schemas/BenchmarkResponse'
'404':
description: Pair not watched
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
description: Benchmark computation failed
/basket:
get:
operationId: getBasket
summary: Compute the weighted price of a basket of assets
security: []
parameters:
- name: asset
in: query
required: true
description: Asset code; repeat for each basket member (at least two).
schema:
type: array
items:
type: string
style: form
explode: true
example: [XLM, USDC]
- name: weight
in: query
required: true
description: Relative weight for each `asset`, in the same order.
schema:
type: array
items:
type: number
style: form
explode: true
example: [0.6, 0.4]
responses:
'200':
description: Basket price
content:
application/json:
schema:
$ref: '#/components/schemas/BasketResponse'
'400':
description: Missing assets or mismatched/invalid weights
'404':
description: No price data for one or more assets
'429':
$ref: '#/components/responses/TooManyRequests'
/discovery/resources:
get:
operationId: listDiscoveryResources
summary: Browse the x402 Bazaar catalog of discoverable resources
security: []
parameters:
- name: type
in: query
required: false
schema:
type: string
enum: [http, mcp]
- name: payTo
in: query
required: false
schema:
type: string
- name: network
in: query
required: false
description: >-
Catalog filter matching the resource's payment network. Accepts
either the Lens network name (`mainnet`/`testnet`) or the CAIP-2 id
(`stellar:pubnet`/`stellar:testnet`).
schema:
type: string
- name: extensions
in: query
required: false
description: Filter to resources declaring this extension (e.g. `bazaar`).
schema:
type: string
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 200
default: 50
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
responses:
'200':
description: Paginated catalog page
content:
application/json:
schema:
$ref: '#/components/schemas/DiscoveryResponse'
'429':
$ref: '#/components/responses/TooManyRequests'
/webhooks:
post:
operationId: createWebhook
summary: Subscribe to a price-threshold webhook
description: >-
Registers an HTTPS endpoint to be called when the pair's price crosses
`threshold` in the given `direction`. The response contains the signing
secret exactly once.
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [url, assetA, assetB, threshold, direction]
properties:
url:
type: string
format: uri
description: HTTPS endpoint to deliver events to.
assetA:
type: string
example: XLM
assetB:
type: string
example: USDC
threshold:
type: number
direction:
type: string
enum: [above, below]
responses:
'201':
description: Webhook created
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookCreatedResponse'
'400':
description: Invalid webhook definition
'429':
$ref: '#/components/responses/TooManyRequests'
/webhooks/{id}:
delete:
operationId: deleteWebhook
summary: Delete a webhook subscription
security: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: Webhook deleted (idempotent — a missing id also returns 204)
'429':
$ref: '#/components/responses/TooManyRequests'
/usage/me:
get:
operationId: getMyUsage
summary: Get usage and quota for the calling API key
security:
- apiKeyAuth: []
responses:
'200':
description: Usage summary for the authenticated key
content:
application/json:
schema:
$ref: '#/components/schemas/UsageResponse'