# Lighter API Documentation Documentation

> Welcome to the API Docs for Lighter! Here you can find the available endpoints, all the details about requests, responses, and more!

## Guides
- [Get Started](https://apidocs.lighter.xyz/docs/get-started.md)
- [SDK](https://apidocs.lighter.xyz/docs/repos.md)
- [API keys](https://apidocs.lighter.xyz/docs/api-keys.md)
- [Rate Limits](https://apidocs.lighter.xyz/docs/rate-limits.md)
- [Account Types](https://apidocs.lighter.xyz/docs/account-types.md): Lighter API users can operate under a Standard or Premium account.
- [Volume Quota](https://apidocs.lighter.xyz/docs/volume-quota-program.md)
- [Signing Transactions](https://apidocs.lighter.xyz/docs/trading.md)
- [WebSocket](https://apidocs.lighter.xyz/docs/websocket-reference.md): This page will help you get started with zkLighter WebSocket server.
- [Historical Data](https://apidocs.lighter.xyz/docs/historical-data.md)
- [Partner Attribution](https://apidocs.lighter.xyz/docs/partner-integration.md)
- [Manage Referrals](https://apidocs.lighter.xyz/docs/referrals.md)
- [Priority Transactions](https://apidocs.lighter.xyz/docs/priority-transactions.md)
- [Manage Public Pools](https://apidocs.lighter.xyz/docs/manage-public-pools-shares.md)
- [Multi-signature and smart wallets](https://apidocs.lighter.xyz/docs/multi-signature-wallets.md)
- [Create accounts programmatically](https://apidocs.lighter.xyz/docs/create-accounts-programmatically.md)
- [Deposits, Transfers and Withdrawals](https://apidocs.lighter.xyz/docs/deposits-transfers-and-withdrawals.md)
- [Data Structures, Constants and Errors](https://apidocs.lighter.xyz/docs/data-structures-constants-and-errors.md)

## API Reference
- [systemConfig](https://apidocs.lighter.xyz/reference/systemconfig.md): Get system config
- [status](https://apidocs.lighter.xyz/reference/status.md): Get status of zklighter
- [info](https://apidocs.lighter.xyz/reference/info-1.md): Get info of zklighter
- [layer1BasicInfo](https://apidocs.lighter.xyz/reference/layer1basicinfo.md): Get zklighter l1 general info, including contract address and rpc info
- [account](https://apidocs.lighter.xyz/reference/account-1.md): Get account by an account's index, or L1 address
- [accountsByL1Address](https://apidocs.lighter.xyz/reference/accountsbyl1address.md): Returns all accounts associated with the given L1 address
- [accountLimits](https://apidocs.lighter.xyz/reference/accountlimits.md): Get account limits. For more details on account types, see this page: https://apidocs.lighter.xyz/docs/account-types
- [accountMetadata](https://apidocs.lighter.xyz/reference/accountmetadata.md): Get account metadatas
- [pnl](https://apidocs.lighter.xyz/reference/pnl.md): Get account PnL chart
- [l1Metadata](https://apidocs.lighter.xyz/reference/l1metadata.md): Get L1 metadata
- [changeAccountTier](https://apidocs.lighter.xyz/reference/changeaccounttier.md): Change account tier. You can only perform this action once every 24 hours, and with no orders or positions open.
- [liquidations](https://apidocs.lighter.xyz/reference/liquidations.md): Get liquidation infos
- [positionFunding](https://apidocs.lighter.xyz/reference/positionfunding.md): Get accounts position fundings
- [publicPoolsMetadata](https://apidocs.lighter.xyz/reference/publicpoolsmetadata.md): Get public pools metadata. `auth` is required in case you specify an account_index. You will see public pools with an index that starts an n-1 of the one you specify. To see staking pools, use `filter=stake`
- [accountActiveOrders](https://apidocs.lighter.xyz/reference/accountactiveorders.md): Get account active orders. `auth` can be generated using the SDK.
- [accountInactiveOrders](https://apidocs.lighter.xyz/reference/accountinactiveorders.md): Get account inactive orders. `auth` can be generated using the SDK.
- [export](https://apidocs.lighter.xyz/reference/export.md): Export trades and funding payments, limited to 12 months or 1M trades. END_TS_IN_MS - START_TS_IN_MS should not be larger than 12 months in milliseconds, both timestamps should be greater than or equal to 17 January 2025 00:00:00 UTC (lighter's mainnet genesis)
- [assetDetails](https://apidocs.lighter.xyz/reference/assetdetails.md): Get asset details for a specific asset or all assets
- [exchangeStats](https://apidocs.lighter.xyz/reference/exchangestats.md): Get exchange stats
- [orderBookDetails](https://apidocs.lighter.xyz/reference/orderbookdetails.md): Get order books metadata
- [orderBookOrders](https://apidocs.lighter.xyz/reference/orderbookorders.md): Get order book orders
- [orderBooks](https://apidocs.lighter.xyz/reference/orderbooks.md): Get order books metadata.<hr>**Response Description:**<br><br>1) **Taker and maker fees** are in percentage.<br>2) **Min base amount:** The amount of base token that can be traded in a single order.<br>3) **Min quote amount:** The amount of quote token that can be traded in a single order.<br>4) **Supported size decimals:** The number of decimal places that can be used for the size of the order.<br>5) **Supported price decimals:** The number of decimal places that can be used for the price of the order.<br>6) **Supported quote decimals:** Size Decimals + Quote Decimals.
- [recentTrades](https://apidocs.lighter.xyz/reference/recenttrades.md): Get recent trades
- [trades](https://apidocs.lighter.xyz/reference/trades.md): Get trades for lighter accounts, including sub-accounts and public pools. `auth` is required for master accounts and sub accounts.
- [sendTx](https://apidocs.lighter.xyz/reference/sendtx.md): You need to sign the transaction body before sending it to the server. More details can be found here: https://apidocs.lighter.xyz/docs/get-started
- [sendTxBatch](https://apidocs.lighter.xyz/reference/sendtxbatch.md): You need to sign the transaction body before sending it to the server. More details can be found here: https://apidocs.lighter.xyz/docs/get-started
- [tx](https://apidocs.lighter.xyz/reference/tx.md): Get transaction by hash or sequence index
- [txFromL1TxHash](https://apidocs.lighter.xyz/reference/txfroml1txhash.md): Get L1 transaction by L1 transaction hash
- [deposit_history](https://apidocs.lighter.xyz/reference/deposit_history.md): Get deposit history
- [transfer_history](https://apidocs.lighter.xyz/reference/transfer_history.md): Get transfer history. To fetch an account index, you will need to `auth` the request, unless it's a public pool.
- [withdraw_history](https://apidocs.lighter.xyz/reference/withdraw_history.md): Get withdraw history. Secure withdrawals are only set to `claimable` when ready. You should only expect the `completed` status on fast withdrawals via Arbitrum.
- [announcement](https://apidocs.lighter.xyz/reference/announcement-1.md): Get announcements
- [apikeys](https://apidocs.lighter.xyz/reference/apikeys.md): Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account.
- [nextNonce](https://apidocs.lighter.xyz/reference/nextnonce.md): Get next nonce for a specific account and api key
- [tokens_create](https://apidocs.lighter.xyz/reference/tokens_create.md): Create an API token for read-only access
- [tokens_revoke](https://apidocs.lighter.xyz/reference/tokens_revoke.md): Revoke read only auth token for an account
- [tokens](https://apidocs.lighter.xyz/reference/tokens.md): Get read only auth tokens for an account
- [setMakerOnlyApiKeys](https://apidocs.lighter.xyz/reference/setmakeronlyapikeys.md): Set maker-only API key indexes. This replaces the current list; pass all indexes you want marked as maker-only. Pass [] to clear all maker-only restrictions.
- [getMakerOnlyApiKeys](https://apidocs.lighter.xyz/reference/getmakeronlyapikeys.md): Get maker-only API key indexes
- [markPriceCandles](https://apidocs.lighter.xyz/reference/markpricecandles.md): Get mark price candles
- [candles](https://apidocs.lighter.xyz/reference/candles.md): Get candles data. Returns at most 500 candles per call. Zero values are omitted from the response.
- [createIntentAddress](https://apidocs.lighter.xyz/reference/createintentaddress.md): Create a bridge intent address for CCTP bridge
- [fastbridge_info](https://apidocs.lighter.xyz/reference/fastbridge_info.md): Get fast bridge info
- [deposit_latest](https://apidocs.lighter.xyz/reference/deposit_latest.md): Get most recent deposit for given l1 address
- [deposit_networks](https://apidocs.lighter.xyz/reference/deposit_networks.md): Get networks that support deposits via intent address
- [fundings](https://apidocs.lighter.xyz/reference/fundings.md): 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.
- [funding-rates](https://apidocs.lighter.xyz/reference/funding-rates.md): Get funding rates
- [notification_ack](https://apidocs.lighter.xyz/reference/notification_ack.md): Ack notification
- [exchangeMetrics](https://apidocs.lighter.xyz/reference/exchangemetrics.md): Get exchange metrics. When filtering by market, use the market symbol as a value.
- [partnerStats](https://apidocs.lighter.xyz/reference/partnerstats.md): Get partner stats. If timestamps are not provided, all-time stats will be returned.
- [executeStats](https://apidocs.lighter.xyz/reference/executestats.md): Get execute stats
- [transferFeeInfo](https://apidocs.lighter.xyz/reference/transferfeeinfo.md): Transfer fee info
- [withdrawalDelay](https://apidocs.lighter.xyz/reference/withdrawaldelay.md): Withdrawal delay in seconds
- [fastwithdraw](https://apidocs.lighter.xyz/reference/fastwithdraw.md): Fast withdraw
- [fastwithdraw_info](https://apidocs.lighter.xyz/reference/fastwithdraw_info.md): Get fast withdraw info
- [tokenlist](https://apidocs.lighter.xyz/reference/tokenlist-1.md): Get token list and their metadata
- [syntheticSpotInfo](https://apidocs.lighter.xyz/reference/syntheticspotinfo.md): Get synthetic spot info for a symbol. For complete details see: https://docs.lighter.xyz/trading/real-world-assets-rwas/us-equity-indices
- [referral_create](https://apidocs.lighter.xyz/reference/referral_create.md): Create referral code
- [referral_get](https://apidocs.lighter.xyz/reference/referral_get.md): Get referral code
- [referral_kickback_update](https://apidocs.lighter.xyz/reference/referral_kickback_update.md): Update kickback percentage for referral rewards (allowed once per day)
- [referral_update](https://apidocs.lighter.xyz/reference/referral_update.md): Update referral code (allowed once per account)
- [referral_use](https://apidocs.lighter.xyz/reference/referral_use.md): Use a referral code. You can change this at a later time.
- [userReferrals](https://apidocs.lighter.xyz/reference/referral_userreferrals.md): Get user referrals
- [leaseOptions](https://apidocs.lighter.xyz/reference/leaseoptions.md): Returns available lease duration/rate tiers, sorted by duration descending.
- [leases](https://apidocs.lighter.xyz/reference/leases.md): Returns paginated lease entries for an account, most recent first. Supports read-only auth via signature/account_index/timestamp query params.
- [litLease](https://apidocs.lighter.xyz/reference/litlease.md): Submit a LIT lease transfer. The server calculates the required fee based on lease_amount and duration_days, then executes the transfer. Fee formula (integer arithmetic): fee = lease_amount × (annual_rate × 100) × duration_days / (360 × 10000).
- [rfq_create](https://apidocs.lighter.xyz/reference/rfq_create.md): Create RFQ. Makers have up to 1 minute to answer an RFQ, after which the user has up to 2 minutes to execute the trade. Quotes are not locked. Makers place orders directly into the order book and can dynamically adjust pricing.
- [rfq_respond](https://apidocs.lighter.xyz/reference/rfq_respond.md): Respond to RFQ. Makers have up to 1 minute to answer an RFQ, after which the user has up to 2 minutes to execute the trade. Quotes are not locked. Makers place orders directly into the order book and can dynamically adjust pricing.
- [rfq_update](https://apidocs.lighter.xyz/reference/rfq_update.md): Update RFQ status
- [rfq_get](https://apidocs.lighter.xyz/reference/rfq_get.md): Get RFQ by ID
- [rfq_list](https://apidocs.lighter.xyz/reference/rfq_list.md): List RFQs
- [logs](https://apidocs.lighter.xyz/reference/get_accounts-param-logs.md): Get logs by address or account_index
- [positions](https://apidocs.lighter.xyz/reference/get_accounts-param-positions.md): Get positions by address or account_index
- [assets](https://apidocs.lighter.xyz/reference/get_accounts-param-assets.md)
- [batches](https://apidocs.lighter.xyz/reference/get_batches.md): Get recent batches
- [batchId](https://apidocs.lighter.xyz/reference/get_batches-batchid.md): Get batch by id
- [blocks](https://apidocs.lighter.xyz/reference/get_blocks.md): Get recent blocks
- [blockId](https://apidocs.lighter.xyz/reference/get_blocks-blockid.md): Get block by id
- [hash](https://apidocs.lighter.xyz/reference/get_logs-hash.md): Get log by tx hash
- [markets](https://apidocs.lighter.xyz/reference/get_markets.md): List all markets
- [logs](https://apidocs.lighter.xyz/reference/get_markets-symbol-logs.md): Get Market Latest Logs. To query perpetual markets, use the symbol alone. For spot markets, use symbol-quote e.g. eth-usdc.
- [search](https://apidocs.lighter.xyz/reference/get_search.md): Search for blocks, batches, transactions, or accounts
- [tx](https://apidocs.lighter.xyz/reference/get_stats-tx.md): Get tx stats
- [total](https://apidocs.lighter.xyz/reference/get_total.md)