lighter.AccountApi

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

Method	HTTP request	Description
account	GET /api/v1/account	account
account_limits	GET /api/v1/accountLimits	accountLimits
account_metadata	GET /api/v1/accountMetadata	accountMetadata
accounts_by_l1_address	GET /api/v1/accountsByL1Address	accountsByL1Address
apikeys	GET /api/v1/apikeys	apikeys
change_account_tier	POST /api/v1/changeAccountTier	changeAccountTier
faucet	GET /api/v1/faucet	faucet
l1_metadata	GET /api/v1/l1Metadata	l1Metadata
liquidations	GET /api/v1/liquidations	liquidations
pnl	GET /api/v1/pnl	pnl
position_funding	GET /api/v1/positionFunding	positionFunding
public_pools_metadata	GET /api/v1/publicPoolsMetadata	publicPoolsMetadata
tokens	GET /api/v1/tokens	tokens
tokens_create	POST /api/v1/tokens/create	tokens_create
tokens_revoke	POST /api/v1/tokens/revoke	tokens_revoke

account

DetailedAccounts account(by, value)

account

Get account by account's index.
More details about account index: Account Index

Response Description:

1) Status: 1 is active 0 is inactive.
2) Collateral: The amount of collateral in the account.

Position Details Description:
1) OOC: Open order count in that market.
2) Sign: 1 for Long, -1 for Short.
3) Position: The amount of position in that market.
4) Avg Entry Price: The average entry price of the position.
5) Position Value: The value of the position.
6) Unrealized PnL: The unrealized profit and loss of the position.
7) Realized PnL: The realized profit and loss of the position.

Example

import lighter
from lighter.models.detailed_accounts import DetailedAccounts
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.AccountApi(api_client)
    by = 'by_example' # str | 
    value = 'value_example' # str | 

    try:
        # account
        api_response = await api_instance.account(by, value)
        print("The response of AccountApi->account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->account: %s\n" % e)

Parameters

Name	Type	Description	Notes
by	str
value	str

Return type

DetailedAccounts

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]

account_limits

AccountLimits account_limits(account_index, authorization=authorization, auth=auth)

accountLimits

Get account limits

Example

import lighter
from lighter.models.account_limits import AccountLimits
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.AccountApi(api_client)
    account_index = 56 # int | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)
    auth = 'auth_example' # str |  made optional to support header auth clients (optional)

    try:
        # accountLimits
        api_response = await api_instance.account_limits(account_index, authorization=authorization, auth=auth)
        print("The response of AccountApi->account_limits:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->account_limits: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_index	int
authorization	str	make required after integ is done	[optional]
auth	str	made optional to support header auth clients	[optional]

Return type

AccountLimits

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]

account_metadata

AccountMetadatas account_metadata(by, value, authorization=authorization, auth=auth)

accountMetadata

Get account metadatas

Example

import lighter
from lighter.models.account_metadatas import AccountMetadatas
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.AccountApi(api_client)
    by = 'by_example' # str | 
    value = 'value_example' # str | 
    authorization = 'authorization_example' # str |  (optional)
    auth = 'auth_example' # str |  (optional)

    try:
        # accountMetadata
        api_response = await api_instance.account_metadata(by, value, authorization=authorization, auth=auth)
        print("The response of AccountApi->account_metadata:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->account_metadata: %s\n" % e)

Parameters

Name	Type	Notes
by	str
value	str
authorization	str	[optional]
auth	str	[optional]

Return type

AccountMetadatas

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]

accounts_by_l1_address

SubAccounts accounts_by_l1_address(l1_address)

accountsByL1Address

Get accounts by l1_address returns all accounts associated with the given L1 address

Example

import lighter
from lighter.models.sub_accounts import SubAccounts
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.AccountApi(api_client)
    l1_address = 'l1_address_example' # str | 

    try:
        # accountsByL1Address
        api_response = await api_instance.accounts_by_l1_address(l1_address)
        print("The response of AccountApi->accounts_by_l1_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->accounts_by_l1_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
l1_address	str

Return type

SubAccounts

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]

apikeys

AccountApiKeys apikeys(account_index, api_key_index=api_key_index)

apikeys

Get account api key. Set api_key_index to 255 to retrieve all api keys associated with the account.

Example

import lighter
from lighter.models.account_api_keys import AccountApiKeys
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.AccountApi(api_client)
    account_index = 56 # int | 
    api_key_index = 255 # int |  (optional) (default to 255)

    try:
        # apikeys
        api_response = await api_instance.apikeys(account_index, api_key_index=api_key_index)
        print("The response of AccountApi->apikeys:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->apikeys: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_index	int
api_key_index	int		[optional] [default to 255]

Return type

AccountApiKeys

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]

change_account_tier

RespChangeAccountTier change_account_tier(account_index, new_tier, authorization=authorization, auth=auth)

changeAccountTier

Change account tier

Example

import lighter
from lighter.models.resp_change_account_tier import RespChangeAccountTier
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.AccountApi(api_client)
    account_index = 56 # int | 
    new_tier = 'new_tier_example' # str | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)
    auth = 'auth_example' # str |  made optional to support header auth clients (optional)

    try:
        # changeAccountTier
        api_response = await api_instance.change_account_tier(account_index, new_tier, authorization=authorization, auth=auth)
        print("The response of AccountApi->change_account_tier:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->change_account_tier: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_index	int
new_tier	str
authorization	str	make required after integ is done	[optional]
auth	str	made optional to support header auth clients	[optional]

Return type

RespChangeAccountTier

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
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]

faucet

ResultCode faucet(l1_address, do_l1_transfer)

faucet

Request funds from faucet

Example

import lighter
from lighter.models.result_code import ResultCode
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.AccountApi(api_client)
    l1_address = 'l1_address_example' # str | 
    do_l1_transfer = False # bool |  (default to False)

    try:
        # faucet
        api_response = await api_instance.faucet(l1_address, do_l1_transfer)
        print("The response of AccountApi->faucet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->faucet: %s\n" % e)

Parameters

Name	Type	Description	Notes
l1_address	str
do_l1_transfer	bool		[default to False]

Return type

ResultCode

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]

l1_metadata

L1Metadata l1_metadata(l1_address, authorization=authorization, auth=auth)

l1Metadata

Get L1 metadata

Example

import lighter
from lighter.models.l1_metadata import L1Metadata
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.AccountApi(api_client)
    l1_address = 'l1_address_example' # str | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)
    auth = 'auth_example' # str |  made optional to support header auth clients (optional)

    try:
        # l1Metadata
        api_response = await api_instance.l1_metadata(l1_address, authorization=authorization, auth=auth)
        print("The response of AccountApi->l1_metadata:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->l1_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
l1_address	str
authorization	str	make required after integ is done	[optional]
auth	str	made optional to support header auth clients	[optional]

Return type

L1Metadata

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]

liquidations

LiquidationInfos liquidations(account_index, limit, authorization=authorization, auth=auth, market_id=market_id, cursor=cursor)

liquidations

Get liquidation infos

Example

import lighter
from lighter.models.liquidation_infos import LiquidationInfos
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.AccountApi(api_client)
    account_index = 56 # int | 
    limit = 56 # int | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)
    auth = 'auth_example' # str |  made optional to support header auth clients (optional)
    market_id = 255 # int |  (optional) (default to 255)
    cursor = 'cursor_example' # str |  (optional)

    try:
        # liquidations
        api_response = await api_instance.liquidations(account_index, limit, authorization=authorization, auth=auth, market_id=market_id, cursor=cursor)
        print("The response of AccountApi->liquidations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->liquidations: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_index	int
limit	int
authorization	str	make required after integ is done	[optional]
auth	str	made optional to support header auth clients	[optional]
market_id	int		[optional] [default to 255]
cursor	str		[optional]

Return type

LiquidationInfos

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]

pnl

AccountPnL pnl(by, value, resolution, start_timestamp, end_timestamp, count_back, authorization=authorization, auth=auth, ignore_transfers=ignore_transfers)

pnl

Get account PnL chart

Example

import lighter
from lighter.models.account_pn_l import AccountPnL
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.AccountApi(api_client)
    by = 'by_example' # str | 
    value = 'value_example' # str | 
    resolution = 'resolution_example' # str | 
    start_timestamp = 56 # int | 
    end_timestamp = 56 # int | 
    count_back = 56 # int | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)
    auth = 'auth_example' # str |  made optional to support header auth clients (optional)
    ignore_transfers = False # bool |  (optional) (default to False)

    try:
        # pnl
        api_response = await api_instance.pnl(by, value, resolution, start_timestamp, end_timestamp, count_back, authorization=authorization, auth=auth, ignore_transfers=ignore_transfers)
        print("The response of AccountApi->pnl:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->pnl: %s\n" % e)

Parameters

Name	Type	Description	Notes
by	str
value	str
resolution	str
start_timestamp	int
end_timestamp	int
count_back	int
authorization	str	make required after integ is done	[optional]
auth	str	made optional to support header auth clients	[optional]
ignore_transfers	bool		[optional] [default to False]

Return type

AccountPnL

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]

position_funding

PositionFundings position_funding(account_index, limit, authorization=authorization, auth=auth, market_id=market_id, cursor=cursor, side=side)

positionFunding

Get accounts position fundings

Example

import lighter
from lighter.models.position_fundings import PositionFundings
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.AccountApi(api_client)
    account_index = 56 # int | 
    limit = 56 # int | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)
    auth = 'auth_example' # str |  made optional to support header auth clients (optional)
    market_id = 255 # int |  (optional) (default to 255)
    cursor = 'cursor_example' # str |  (optional)
    side = all # str |  (optional) (default to all)

    try:
        # positionFunding
        api_response = await api_instance.position_funding(account_index, limit, authorization=authorization, auth=auth, market_id=market_id, cursor=cursor, side=side)
        print("The response of AccountApi->position_funding:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->position_funding: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_index	int
limit	int
authorization	str	make required after integ is done	[optional]
auth	str	made optional to support header auth clients	[optional]
market_id	int		[optional] [default to 255]
cursor	str		[optional]
side	str		[optional] [default to all]

Return type

PositionFundings

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]

public_pools_metadata

RespPublicPoolsMetadata public_pools_metadata(index, limit, authorization=authorization, auth=auth, filter=filter, account_index=account_index)

publicPoolsMetadata

Get public pools metadata

Example

import lighter
from lighter.models.resp_public_pools_metadata import RespPublicPoolsMetadata
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.AccountApi(api_client)
    index = 56 # int | 
    limit = 56 # int | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)
    auth = 'auth_example' # str |  made optional to support header auth clients (optional)
    filter = 'filter_example' # str |  (optional)
    account_index = 56 # int |  (optional)

    try:
        # publicPoolsMetadata
        api_response = await api_instance.public_pools_metadata(index, limit, authorization=authorization, auth=auth, filter=filter, account_index=account_index)
        print("The response of AccountApi->public_pools_metadata:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->public_pools_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
index	int
limit	int
authorization	str	make required after integ is done	[optional]
auth	str	made optional to support header auth clients	[optional]
filter	str		[optional]
account_index	int		[optional]

Return type

RespPublicPoolsMetadata

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]

tokens

RespGetApiTokens tokens(account_index, authorization=authorization)

tokens

Get api tokens of an account

Example

import lighter
from lighter.models.resp_get_api_tokens import RespGetApiTokens
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.AccountApi(api_client)
    account_index = 56 # int | 
    authorization = 'authorization_example' # str |  make required after integ is done (optional)

    try:
        # tokens
        api_response = await api_instance.tokens(account_index, authorization=authorization)
        print("The response of AccountApi->tokens:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->tokens: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_index	int
authorization	str	make required after integ is done	[optional]

Return type

RespGetApiTokens

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]

tokens_create

RespPostApiToken tokens_create(name, account_index, expiry, sub_account_access, authorization=authorization, scopes=scopes)

tokens_create

Create api token

Example

import lighter
from lighter.models.resp_post_api_token import RespPostApiToken
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.AccountApi(api_client)
    name = 'name_example' # str | 
    account_index = 56 # int | 
    expiry = 56 # int | 
    sub_account_access = True # bool | 
    authorization = 'authorization_example' # str |  (optional)
    scopes = 'read.*' # str |  (optional) (default to 'read.*')

    try:
        # tokens_create
        api_response = await api_instance.tokens_create(name, account_index, expiry, sub_account_access, authorization=authorization, scopes=scopes)
        print("The response of AccountApi->tokens_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->tokens_create: %s\n" % e)

Parameters

Name	Type	Notes
name	str
account_index	int
expiry	int
sub_account_access	bool
authorization	str	[optional]
scopes	str	[optional] [default to 'read.*']

Return type

RespPostApiToken

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
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]

tokens_revoke

RespRevokeApiToken tokens_revoke(token_id, account_index, authorization=authorization)

tokens_revoke

Revoke api token

Example

import lighter
from lighter.models.resp_revoke_api_token import RespRevokeApiToken
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.AccountApi(api_client)
    token_id = 56 # int | 
    account_index = 56 # int | 
    authorization = 'authorization_example' # str |  (optional)

    try:
        # tokens_revoke
        api_response = await api_instance.tokens_revoke(token_id, account_index, authorization=authorization)
        print("The response of AccountApi->tokens_revoke:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AccountApi->tokens_revoke: %s\n" % e)

Parameters

Name	Type	Notes
token_id	int
account_index	int
authorization	str	[optional]

Return type

RespRevokeApiToken

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
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]

FilesExpand file tree

AccountApi.md

Latest commit

History

AccountApi.md

File metadata and controls

lighter.AccountApi

account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

account_limits

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

account_metadata

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

accounts_by_l1_address

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apikeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

change_account_tier

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

faucet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

l1_metadata

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

liquidations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pnl

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

position_funding

Example

Parameters