lighter-rust 0.1.0

A comprehensive Rust SDK for the Lighter trading platform with async/await, WebSocket support, and Ethereum wallet integration
Documentation
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
openapi: 3.0.3
info:
  title: Lighter API
  description: REST API for Lighter trading platform
  version: 2.0.0
  contact:
    name: Lighter Support
    url: https://lighter.xyz
servers:
  - url: https://api.lighter.xyz
    description: Production server
  - url: https://api-testnet.lighter.xyz
    description: Testnet server
paths:
  /account:
    get:
      tags:
        - Account
      summary: Get account information
      operationId: getAccount
      security:
        - ApiKeyAuth: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/RateLimitError'
  
  /account/stats:
    get:
      tags:
        - Account
      summary: Get account statistics
      operationId: getAccountStats
      security:
        - ApiKeyAuth: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountStatsResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
  
  /account/change-tier:
    post:
      tags:
        - Account
      summary: Change account tier
      operationId: changeAccountTier
      security:
        - ApiKeyAuth: []
        - SignatureAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountTierSwitchRequest'
      responses:
        '200':
          description: Tier changed successfully
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
  
  /orders:
    get:
      tags:
        - Orders
      summary: Get orders with filters
      operationId: getOrders
      security:
        - ApiKeyAuth: []
      parameters:
        - name: symbol
          in: query
          schema:
            type: string
          description: Trading pair symbol
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/OrderStatus'
        - name: side
          in: query
          schema:
            $ref: '#/components/schemas/Side'
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            maximum: 500
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrdersResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
    
    post:
      tags:
        - Orders
      summary: Create a new order
      operationId: createOrder
      security:
        - ApiKeyAuth: []
        - SignatureAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderRequest'
      responses:
        '201':
          description: Order created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
  
  /orders/{orderId}:
    get:
      tags:
        - Orders
      summary: Get order by ID
      operationId: getOrder
      security:
        - ApiKeyAuth: []
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderResponse'
        '404':
          $ref: '#/components/responses/NotFoundError'
  
  /orders/cancel:
    post:
      tags:
        - Orders
      summary: Cancel an order
      operationId: cancelOrder
      security:
        - ApiKeyAuth: []
        - SignatureAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOrderRequest'
      responses:
        '200':
          description: Order cancelled successfully
        '400':
          $ref: '#/components/responses/BadRequestError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  
  /candlesticks:
    get:
      tags:
        - Market Data
      summary: Get candlestick data
      operationId: getCandlesticks
      parameters:
        - name: symbol
          in: query
          required: true
          schema:
            type: string
        - name: interval
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/CandlestickInterval'
        - name: startTime
          in: query
          schema:
            type: integer
            format: int64
        - name: endTime
          in: query
          schema:
            type: integer
            format: int64
        - name: limit
          in: query
          schema:
            type: integer
            default: 500
            maximum: 1000
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Candlestick'
  
  /orderbook/{symbol}:
    get:
      tags:
        - Market Data
      summary: Get order book
      operationId: getOrderBook
      parameters:
        - name: symbol
          in: path
          required: true
          schema:
            type: string
        - name: depth
          in: query
          schema:
            type: integer
            default: 20
            maximum: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderBook'

components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Bearer token authentication
    SignatureAuth:
      type: apiKey
      in: header
      name: X-Signature
      description: Request signature for write operations
  
  schemas:
    Account:
      type: object
      required:
        - id
        - address
        - tier
        - createdAt
        - updatedAt
        - balances
        - positions
      properties:
        id:
          type: string
        address:
          type: string
        tier:
          $ref: '#/components/schemas/AccountTier'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        balances:
          type: array
          items:
            $ref: '#/components/schemas/Balance'
        positions:
          type: array
          items:
            $ref: '#/components/schemas/Position'
        tierSwitchAllowedAt:
          type: string
          format: date-time
          nullable: true
    
    Balance:
      type: object
      required:
        - asset
        - total
        - available
        - locked
      properties:
        asset:
          type: string
        total:
          type: string
        available:
          type: string
        locked:
          type: string
    
    Position:
      type: object
      required:
        - symbol
        - side
        - size
        - entryPrice
        - markPrice
        - unrealizedPnl
        - marginType
        - leverage
      properties:
        symbol:
          type: string
        side:
          $ref: '#/components/schemas/Side'
        size:
          type: string
        entryPrice:
          type: string
        markPrice:
          type: string
        unrealizedPnl:
          type: string
        marginType:
          $ref: '#/components/schemas/MarginType'
        leverage:
          type: string
    
    Order:
      type: object
      required:
        - id
        - symbol
        - side
        - orderType
        - status
        - quantity
        - filledQuantity
        - remainingQuantity
        - timeInForce
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        clientOrderId:
          type: string
          nullable: true
        symbol:
          type: string
        side:
          $ref: '#/components/schemas/Side'
        orderType:
          $ref: '#/components/schemas/OrderType'
        status:
          $ref: '#/components/schemas/OrderStatus'
        quantity:
          type: string
        price:
          type: string
          nullable: true
        stopPrice:
          type: string
          nullable: true
        filledQuantity:
          type: string
        remainingQuantity:
          type: string
        averageFillPrice:
          type: string
          nullable: true
        fee:
          type: string
          nullable: true
        timeInForce:
          $ref: '#/components/schemas/TimeInForce'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    
    CreateOrderRequest:
      type: object
      required:
        - symbol
        - side
        - orderType
        - quantity
        - signature
        - nonce
      properties:
        symbol:
          type: string
        side:
          $ref: '#/components/schemas/Side'
        orderType:
          $ref: '#/components/schemas/OrderType'
        quantity:
          type: string
        price:
          type: string
          nullable: true
        clientOrderId:
          type: string
          nullable: true
        timeInForce:
          $ref: '#/components/schemas/TimeInForce'
          default: GTC
        postOnly:
          type: boolean
          default: false
        reduceOnly:
          type: boolean
          default: false
        signature:
          type: string
        nonce:
          type: integer
          format: int64
    
    CancelOrderRequest:
      type: object
      required:
        - signature
        - nonce
      properties:
        orderId:
          type: string
          nullable: true
        clientOrderId:
          type: string
          nullable: true
        symbol:
          type: string
          nullable: true
        signature:
          type: string
        nonce:
          type: integer
          format: int64
    
    Candlestick:
      type: object
      required:
        - openTime
        - closeTime
        - open
        - high
        - low
        - close
        - volume
        - quoteVolume
        - tradeCount
      properties:
        openTime:
          type: string
          format: date-time
        closeTime:
          type: string
          format: date-time
        open:
          type: string
        high:
          type: string
        low:
          type: string
        close:
          type: string
        volume:
          type: string
        quoteVolume:
          type: string
        tradeCount:
          type: integer
    
    OrderBook:
      type: object
      required:
        - bids
        - asks
        - timestamp
      properties:
        bids:
          type: array
          items:
            $ref: '#/components/schemas/PriceLevel'
        asks:
          type: array
          items:
            $ref: '#/components/schemas/PriceLevel'
        timestamp:
          type: string
          format: date-time
    
    PriceLevel:
      type: object
      required:
        - price
        - quantity
      properties:
        price:
          type: string
        quantity:
          type: string
    
    AccountTier:
      type: string
      enum:
        - STANDARD
        - PREMIUM
    
    Side:
      type: string
      enum:
        - BUY
        - SELL
    
    OrderType:
      type: string
      enum:
        - MARKET
        - LIMIT
        - STOP_LOSS
        - TAKE_PROFIT
    
    OrderStatus:
      type: string
      enum:
        - PENDING
        - OPEN
        - PARTIALLY_FILLED
        - FILLED
        - CANCELLED
        - REJECTED
    
    TimeInForce:
      type: string
      enum:
        - GTC
        - IOC
        - FOK
        - DAY
    
    MarginType:
      type: string
      enum:
        - CROSS
        - ISOLATED
    
    CandlestickInterval:
      type: string
      enum:
        - 1m
        - 5m
        - 15m
        - 30m
        - 1h
        - 4h
        - 1d
        - 1w
    
    ApiResponse:
      type: object
      required:
        - success
        - timestamp
      properties:
        success:
          type: boolean
        data:
          type: object
        error:
          type: string
          nullable: true
        timestamp:
          type: string
          format: date-time
    
    AccountResponse:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/Account'
    
    OrderResponse:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/Order'
    
    OrdersResponse:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
        - type: object
          properties:
            data:
              type: object
              properties:
                orders:
                  type: array
                  items:
                    $ref: '#/components/schemas/Order'
                pagination:
                  $ref: '#/components/schemas/Pagination'
    
    AccountStatsResponse:
      allOf:
        - $ref: '#/components/schemas/ApiResponse'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/AccountStats'
    
    AccountStats:
      type: object
      properties:
        totalVolume:
          type: string
        makerVolume:
          type: string
        takerVolume:
          type: string
        totalFeesPaid:
          type: string
        totalTrades:
          type: integer
        winRate:
          type: string
        pnl:
          type: string
    
    AccountTierSwitchRequest:
      type: object
      required:
        - targetTier
        - signature
        - nonce
      properties:
        targetTier:
          $ref: '#/components/schemas/AccountTier'
        signature:
          type: string
        nonce:
          type: integer
          format: int64
    
    Pagination:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        hasNext:
          type: boolean
    
    ErrorResponse:
      type: object
      required:
        - success
        - error
        - timestamp
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        timestamp:
          type: string
          format: date-time
  
  responses:
    UnauthorizedError:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    
    BadRequestError:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    
    RateLimitError:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'