Skip to content

CandlestickApi.md

Latest commit

 

History

History
314 lines (214 loc) · 9.23 KB

CandlestickApi.md

File metadata and controls

314 lines (214 loc) · 9.23 KB
Raw

lighter.CandlestickApi

All URIs are relative to https://mainnet.zklighter.elliot.ai

Method HTTP request Description
candles GET /api/v1/candles candles
fundings GET /api/v1/fundings fundings
mark_price_candles GET /api/v1/markPriceCandles markPriceCandles
market_price_charts GET /api/v1/marketPriceCharts marketPriceCharts

candles

Candles candles(market_id, resolution, start_timestamp, end_timestamp, count_back, set_timestamp_to_end=set_timestamp_to_end)

candles

Get candles data. Returns at most 500 candles per call. Zero values are omitted from the response.

Example

import lighter
from lighter.models.candles import Candles
from lighter.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
    host = "https://mainnet.zklighter.elliot.ai"
)


# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lighter.CandlestickApi(api_client)
    market_id = 56 # int | 
    resolution = 'resolution_example' # str | 
    start_timestamp = 56 # int | 
    end_timestamp = 56 # int | 
    count_back = 56 # int | 
    set_timestamp_to_end = False # bool |  (optional) (default to False)

    try:
        # candles
        api_response = await api_instance.candles(market_id, resolution, start_timestamp, end_timestamp, count_back, set_timestamp_to_end=set_timestamp_to_end)
        print("The response of CandlestickApi->candles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CandlestickApi->candles: %s\n" % e)

Parameters

Name Type Description Notes
market_id int
resolution str
start_timestamp int
end_timestamp int
count_back int
set_timestamp_to_end bool [optional] [default to False]

Return type

Candles

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fundings

Fundings fundings(market_id, resolution, start_timestamp, end_timestamp, count_back)

fundings

Get fundings. Maximum 750 fundings will be returned per call. count_back indicates the number of fundings you would like to be returned, starting from start_timestamp, if set to 0, all fundings will be returned.

Example

import lighter
from lighter.models.fundings import Fundings
from lighter.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
    host = "https://mainnet.zklighter.elliot.ai"
)


# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lighter.CandlestickApi(api_client)
    market_id = 56 # int | 
    resolution = 'resolution_example' # str | 
    start_timestamp = 56 # int | 
    end_timestamp = 56 # int | 
    count_back = 56 # int | 

    try:
        # fundings
        api_response = await api_instance.fundings(market_id, resolution, start_timestamp, end_timestamp, count_back)
        print("The response of CandlestickApi->fundings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CandlestickApi->fundings: %s\n" % e)

Parameters

Name Type Description Notes
market_id int
resolution str
start_timestamp int
end_timestamp int
count_back int

Return type

Fundings

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mark_price_candles

MarkPriceCandles mark_price_candles(market_id, resolution, start_timestamp, end_timestamp, count_back)

markPriceCandles

Get mark price candles

Example

import lighter
from lighter.models.mark_price_candles import MarkPriceCandles
from lighter.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
    host = "https://mainnet.zklighter.elliot.ai"
)


# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lighter.CandlestickApi(api_client)
    market_id = 56 # int | 
    resolution = 'resolution_example' # str | 
    start_timestamp = 56 # int | 
    end_timestamp = 56 # int | 
    count_back = 56 # int | 

    try:
        # markPriceCandles
        api_response = await api_instance.mark_price_candles(market_id, resolution, start_timestamp, end_timestamp, count_back)
        print("The response of CandlestickApi->mark_price_candles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CandlestickApi->mark_price_candles: %s\n" % e)

Parameters

Name Type Description Notes
market_id int
resolution str
start_timestamp int
end_timestamp int
count_back int

Return type

MarkPriceCandles

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

market_price_charts

MarketPriceCharts market_price_charts(market_ids=market_ids)

marketPriceCharts

Get last 24h hourly prices for all markets (mark price for perps, index price for spot)

Example

import lighter
from lighter.models.market_price_charts import MarketPriceCharts
from lighter.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
    host = "https://mainnet.zklighter.elliot.ai"
)


# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lighter.CandlestickApi(api_client)
    market_ids = [56] # List[int] |  (optional)

    try:
        # marketPriceCharts
        api_response = await api_instance.market_price_charts(market_ids=market_ids)
        print("The response of CandlestickApi->market_price_charts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CandlestickApi->market_price_charts: %s\n" % e)

Parameters

Name Type Description Notes
market_ids List[int] [optional]

Return type

MarketPriceCharts

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -

[Back to top] [Back to API list] [Back to Model list] [Back to README]