Lighter candlestick API
The candlestick API from Lighter — 2 operation(s) for candlestick.
OpenAPI Specification
openapi: 3.0.0
info:
title: Lighter account candlestick API
version: ''
servers:
- url: https://mainnet.zklighter.elliot.ai
tags:
- name: candlestick
paths:
/api/v1/candles:
get:
summary: candles
operationId: candles
tags:
- candlestick
description: Get candles data. Returns at most 500 candles per call. Zero values are omitted from the response.
parameters:
- name: market_id
in: query
required: true
schema:
type: integer
format: int16
- name: resolution
in: query
required: true
schema:
type: string
enum:
- 1m
- 5m
- 15m
- 30m
- 1h
- 4h
- 12h
- 1d
- 1w
- name: start_timestamp
in: query
required: true
schema:
type: integer
format: int64
minimum: 0
maximum: 5000000000000
- name: end_timestamp
in: query
required: true
schema:
type: integer
format: int64
minimum: 0
maximum: 5000000000000
- name: count_back
in: query
required: true
schema:
type: integer
format: int64
- name: set_timestamp_to_end
in: query
required: false
schema:
type: boolean
format: boolean
default: 'false'
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/Candles'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultCode'
/api/v1/fundings:
get:
summary: fundings
operationId: fundings
tags:
- candlestick
description: Get fundings
parameters:
- name: market_id
in: query
required: true
schema:
type: integer
format: int16
- name: resolution
in: query
required: true
schema:
type: string
enum:
- 1h
- 1d
- name: start_timestamp
in: query
required: true
schema:
type: integer
format: int64
minimum: 0
maximum: 5000000000000
- name: end_timestamp
in: query
required: true
schema:
type: integer
format: int64
minimum: 0
maximum: 5000000000000
- name: count_back
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/Fundings'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultCode'
components:
schemas:
Candle:
type: object
properties:
t:
type: integer
format: int64
example: 1767700500000
description: Timestamp
o:
type: number
format: double
example: 3236.86
description: Open price
h:
type: number
format: double
example: 3237.78
description: High price
l:
type: number
format: double
example: 3235.36
description: Low price
c:
type: number
format: double
example: 3235.39
description: Close price
v:
type: number
format: double
example: 55.1632
description: Base token volume (volume0)
V:
type: number
format: double
example: 178530.793575
description: Quote token volume (volume1)
i:
type: integer
format: int64
example: 779870452
description: Last trade ID
C:
type: number
format: double
example: '3024.66'
description: ' close_raw'
H:
type: number
format: double
example: '3034.66'
description: ' high_raw'
L:
type: number
format: double
example: '3014.66'
description: ' low_raw'
O:
type: number
format: double
example: '3024.66'
description: ' open_raw'
title: Candle
description: Abbreviated candle format. Zero values are omitted.
required:
- t
- o
- h
- l
- c
- v
- V
- i
ResultCode:
type: object
properties:
code:
type: integer
format: int32
example: '200'
message:
type: string
title: ResultCode
required:
- code
Funding:
type: object
properties:
timestamp:
type: integer
format: int64
example: '1640995200'
value:
type: string
example: '0.0001'
rate:
type: string
example: '0.0001'
direction:
type: string
example: long
title: Funding
required:
- timestamp
- value
- rate
- direction
Fundings:
type: object
properties:
code:
type: integer
format: int32
example: '200'
message:
type: string
resolution:
type: string
example: 1h
fundings:
type: array
items:
$ref: '#/components/schemas/Funding'
title: Fundings
required:
- code
- resolution
- fundings
Candles:
type: object
properties:
code:
type: integer
format: int32
example: 200
r:
type: string
example: 1m
description: Resolution
c:
type: array
items:
$ref: '#/components/schemas/Candle'
description: Array of candles (max 500 per call)
message:
type: string
title: Candles
required:
- code
- r
- c
securitySchemes:
apiKey:
type: apiKey
description: Enter JWT Bearer token **_only_**
name: Authorization
in: header