Binary Options Example + API

.openapi-generator/FILES

@@ -16,9 +16,12 @@ docs/ApiToken.md
 docs/ApprovedIntegrator.md
 docs/Asset.md
 docs/AssetDetails.md
+docs/BinaryOptionMarketStats.md
 docs/Block.md
 docs/BlockApi.md
 docs/Blocks.md
+docs/BoEventPnL.md
+docs/BoOutcomePnL.md
 docs/BridgeApi.md
 docs/BridgeSupportedNetwork.md
 docs/BridgeSupportedNetworks.md
@@ -35,6 +38,9 @@ docs/DepositHistoryItem.md
 docs/DetailedAccount.md
 docs/DetailedAccounts.md
 docs/EnrichedTx.md
+docs/EventApi.md
+docs/EventDetail.md
+docs/EventOrderBookEntry.md
 docs/ExchangeMetric.md
 docs/ExchangeStats.md
 docs/ExecuteStat.md
@@ -80,8 +86,11 @@ docs/PerpsOrderBookDetail.md
 docs/PnLEntry.md
 docs/PnlLeaderboard.md
 docs/PnlLeaderboardEntry.md
+docs/PortfolioApi.md
 docs/PositionFunding.md
 docs/PositionFundings.md
+docs/PriceOracleMarket.md
+docs/PriceOraclePrice.md
 docs/PublicPoolInfo.md
 docs/PublicPoolMetadata.md
 docs/PublicPoolShare.md
@@ -101,6 +110,8 @@ docs/ReqSetAccountMetadata.md
 docs/RespChangeAccountTier.md
 docs/RespCreateRFQ.md
 docs/RespGetApiTokens.md
+docs/RespGetBoPnL.md
+docs/RespGetEvents.md
 docs/RespGetExchangeMetrics.md
 docs/RespGetExecuteStats.md
 docs/RespGetFastBridgeInfo.md
@@ -109,8 +120,10 @@ docs/RespGetLeaseOptions.md
 docs/RespGetLeases.md
 docs/RespGetMakerOnlyApiKeys.md
 docs/RespGetRFQ.md
+docs/RespGetUpDownCandles.md
 docs/RespListRFQs.md
 docs/RespPostApiToken.md
+docs/RespPriceOracleInfo.md
 docs/RespPublicPoolsMetadata.md
 docs/RespRespondToRFQ.md
 docs/RespRevokeApiToken.md
@@ -148,6 +161,8 @@ docs/TransferHistoryItem.md
 docs/Tx.md
 docs/TxHash.md
 docs/Txs.md
+docs/UpDownCandle.md
+docs/UpdownApi.md
 docs/UserReferrals.md
 docs/ValidatorInfo.md
 docs/WithdrawHistory.md
@@ -160,15 +175,18 @@ lighter/api/announcement_api.py
 lighter/api/block_api.py
 lighter/api/bridge_api.py
 lighter/api/candlestick_api.py
+lighter/api/event_api.py
 lighter/api/funding_api.py
 lighter/api/info_api.py
 lighter/api/livepoints_api.py
 lighter/api/notification_api.py
 lighter/api/order_api.py
+lighter/api/portfolio_api.py
 lighter/api/referral_api.py
 lighter/api/root_api.py
 lighter/api/tokenlist_api.py
 lighter/api/transaction_api.py
+lighter/api/updown_api.py
 lighter/api_client.py
 lighter/api_response.py
 lighter/configuration.py
@@ -189,8 +207,11 @@ lighter/models/api_token.py
 lighter/models/approved_integrator.py
 lighter/models/asset.py
 lighter/models/asset_details.py
+lighter/models/binary_option_market_stats.py
 lighter/models/block.py
 lighter/models/blocks.py
+lighter/models/bo_event_pn_l.py
+lighter/models/bo_outcome_pn_l.py
 lighter/models/bridge_supported_network.py
 lighter/models/bridge_supported_networks.py
 lighter/models/candle.py
@@ -205,6 +226,8 @@ lighter/models/deposit_history_item.py
 lighter/models/detailed_account.py
 lighter/models/detailed_accounts.py
 lighter/models/enriched_tx.py
+lighter/models/event_detail.py
+lighter/models/event_order_book_entry.py
 lighter/models/exchange_metric.py
 lighter/models/exchange_stats.py
 lighter/models/execute_stat.py
@@ -247,6 +270,8 @@ lighter/models/pnl_leaderboard.py
 lighter/models/pnl_leaderboard_entry.py
 lighter/models/position_funding.py
 lighter/models/position_fundings.py
+lighter/models/price_oracle_market.py
+lighter/models/price_oracle_price.py
 lighter/models/public_pool_info.py
 lighter/models/public_pool_metadata.py
 lighter/models/public_pool_share.py
@@ -262,6 +287,8 @@ lighter/models/req_set_account_metadata.py
 lighter/models/resp_change_account_tier.py
 lighter/models/resp_create_rfq.py
 lighter/models/resp_get_api_tokens.py
+lighter/models/resp_get_bo_pn_l.py
+lighter/models/resp_get_events.py
 lighter/models/resp_get_exchange_metrics.py
 lighter/models/resp_get_execute_stats.py
 lighter/models/resp_get_fast_bridge_info.py
@@ -270,8 +297,10 @@ lighter/models/resp_get_lease_options.py
 lighter/models/resp_get_leases.py
 lighter/models/resp_get_maker_only_api_keys.py
 lighter/models/resp_get_rfq.py
+lighter/models/resp_get_up_down_candles.py
 lighter/models/resp_list_rfqs.py
 lighter/models/resp_post_api_token.py
+lighter/models/resp_price_oracle_info.py
 lighter/models/resp_public_pools_metadata.py
 lighter/models/resp_respond_to_rfq.py
 lighter/models/resp_revoke_api_token.py
@@ -309,6 +338,7 @@ lighter/models/transfer_history_item.py
 lighter/models/tx.py
 lighter/models/tx_hash.py
 lighter/models/txs.py
+lighter/models/up_down_candle.py
 lighter/models/user_referrals.py
 lighter/models/validator_info.py
 lighter/models/withdraw_history.py

README.md

@@ -97,8 +97,10 @@ Class | Method | HTTP request | Description
 *CandlestickApi* | [**fundings**](docs/CandlestickApi.md#fundings) | **GET** /api/v1/fundings | fundings
 *CandlestickApi* | [**mark_price_candles**](docs/CandlestickApi.md#mark_price_candles) | **GET** /api/v1/markPriceCandles | markPriceCandles
 *CandlestickApi* | [**market_price_charts**](docs/CandlestickApi.md#market_price_charts) | **GET** /api/v1/marketPriceCharts | marketPriceCharts
+*EventApi* | [**events**](docs/EventApi.md#events) | **GET** /api/v1/events | events
 *FundingApi* | [**funding_rates**](docs/FundingApi.md#funding_rates) | **GET** /api/v1/funding-rates | funding-rates
 *InfoApi* | [**layer1_basic_info**](docs/InfoApi.md#layer1_basic_info) | **GET** /api/v1/layer1BasicInfo | layer1BasicInfo
+*InfoApi* | [**price_oracle_info**](docs/InfoApi.md#price_oracle_info) | **GET** /api/v1/priceOracleInfo | priceOracleInfo
 *InfoApi* | [**synthetic_spot_info**](docs/InfoApi.md#synthetic_spot_info) | **GET** /api/v1/syntheticSpotInfo | syntheticSpotInfo
 *InfoApi* | [**system_config**](docs/InfoApi.md#system_config) | **GET** /api/v1/systemConfig | systemConfig
 *InfoApi* | [**transfer_fee_info**](docs/InfoApi.md#transfer_fee_info) | **GET** /api/v1/transferFeeInfo | transferFeeInfo
@@ -111,14 +113,15 @@ Class | Method | HTTP request | Description
 *OrderApi* | [**asset_details**](docs/OrderApi.md#asset_details) | **GET** /api/v1/assetDetails | assetDetails
 *OrderApi* | [**exchange_metrics**](docs/OrderApi.md#exchange_metrics) | **GET** /api/v1/exchangeMetrics | exchangeMetrics
 *OrderApi* | [**exchange_stats**](docs/OrderApi.md#exchange_stats) | **GET** /api/v1/exchangeStats | exchangeStats
-*OrderApi* | [**export_historical_trades**](docs/OrderApi.md#export_historical_trades) | **GET** /api/v1/export/historicalTrades | export_historicalTrades
 *OrderApi* | [**execute_stats**](docs/OrderApi.md#execute_stats) | **GET** /api/v1/executeStats | executeStats
 *OrderApi* | [**export**](docs/OrderApi.md#export) | **GET** /api/v1/export | export
+*OrderApi* | [**export_historical_trades**](docs/OrderApi.md#export_historical_trades) | **GET** /api/v1/export/historicalTrades | export_historicalTrades
 *OrderApi* | [**order_book_details**](docs/OrderApi.md#order_book_details) | **GET** /api/v1/orderBookDetails | orderBookDetails
 *OrderApi* | [**order_book_orders**](docs/OrderApi.md#order_book_orders) | **GET** /api/v1/orderBookOrders | orderBookOrders
 *OrderApi* | [**order_books**](docs/OrderApi.md#order_books) | **GET** /api/v1/orderBooks | orderBooks
 *OrderApi* | [**recent_trades**](docs/OrderApi.md#recent_trades) | **GET** /api/v1/recentTrades | recentTrades
 *OrderApi* | [**trades**](docs/OrderApi.md#trades) | **GET** /api/v1/trades | trades
+*PortfolioApi* | [**portfolio_bo_pnl**](docs/PortfolioApi.md#portfolio_bo_pnl) | **GET** /api/v1/portfolio/boPnl | portfolio_boPnl
 *ReferralApi* | [**referral_create**](docs/ReferralApi.md#referral_create) | **POST** /api/v1/referral/create | referral_create
 *ReferralApi* | [**referral_get**](docs/ReferralApi.md#referral_get) | **GET** /api/v1/referral/get | referral_get
 *ReferralApi* | [**referral_kickback_update**](docs/ReferralApi.md#referral_kickback_update) | **POST** /api/v1/referral/kickback/update | referral_kickback_update
@@ -141,6 +144,7 @@ Class | Method | HTTP request | Description
 *TransactionApi* | [**tx_from_l1_tx_hash**](docs/TransactionApi.md#tx_from_l1_tx_hash) | **GET** /api/v1/txFromL1TxHash | txFromL1TxHash
 *TransactionApi* | [**txs**](docs/TransactionApi.md#txs) | **GET** /api/v1/txs | txs
 *TransactionApi* | [**withdraw_history**](docs/TransactionApi.md#withdraw_history) | **GET** /api/v1/withdraw/history | withdraw_history
+*UpdownApi* | [**up_down_candles**](docs/UpdownApi.md#up_down_candles) | **GET** /api/v1/upDownCandles | upDownCandles
 <!-- /AUTOGEN:API_ENDPOINTS -->
 
 <!-- AUTOGEN:MODELS -->
@@ -159,8 +163,11 @@ Class | Method | HTTP request | Description
  - [ApprovedIntegrator](docs/ApprovedIntegrator.md)
  - [Asset](docs/Asset.md)
  - [AssetDetails](docs/AssetDetails.md)
+ - [BinaryOptionMarketStats](docs/BinaryOptionMarketStats.md)
  - [Block](docs/Block.md)
  - [Blocks](docs/Blocks.md)
+ - [BoEventPnL](docs/BoEventPnL.md)
+ - [BoOutcomePnL](docs/BoOutcomePnL.md)
  - [BridgeSupportedNetwork](docs/BridgeSupportedNetwork.md)
  - [BridgeSupportedNetworks](docs/BridgeSupportedNetworks.md)
  - [Candle](docs/Candle.md)
@@ -175,15 +182,17 @@ Class | Method | HTTP request | Description
  - [DetailedAccount](docs/DetailedAccount.md)
  - [DetailedAccounts](docs/DetailedAccounts.md)
  - [EnrichedTx](docs/EnrichedTx.md)
+ - [EventDetail](docs/EventDetail.md)
+ - [EventOrderBookEntry](docs/EventOrderBookEntry.md)
  - [ExchangeMetric](docs/ExchangeMetric.md)
  - [ExchangeStats](docs/ExchangeStats.md)
  - [ExecuteStat](docs/ExecuteStat.md)
  - [ExportData](docs/ExportData.md)
  - [Funding](docs/Funding.md)
  - [FundingRate](docs/FundingRate.md)
  - [FundingRates](docs/FundingRates.md)
- - [HistoricalTradesExportData](docs/HistoricalTradesExportData.md)
  - [Fundings](docs/Fundings.md)
+ - [HistoricalTradesExportData](docs/HistoricalTradesExportData.md)
  - [L1Metadata](docs/L1Metadata.md)
  - [L1ProviderInfo](docs/L1ProviderInfo.md)
  - [Layer1BasicInfo](docs/Layer1BasicInfo.md)
@@ -212,29 +221,33 @@ Class | Method | HTTP request | Description
  - [PartnerStats](docs/PartnerStats.md)
  - [PendingUnlock](docs/PendingUnlock.md)
  - [PerpsOrderBookDetail](docs/PerpsOrderBookDetail.md)
+ - [PnLEntry](docs/PnLEntry.md)
  - [PnlLeaderboard](docs/PnlLeaderboard.md)
  - [PnlLeaderboardEntry](docs/PnlLeaderboardEntry.md)
- - [PnLEntry](docs/PnLEntry.md)
  - [PositionFunding](docs/PositionFunding.md)
  - [PositionFundings](docs/PositionFundings.md)
+ - [PriceOracleMarket](docs/PriceOracleMarket.md)
+ - [PriceOraclePrice](docs/PriceOraclePrice.md)
  - [PublicPoolInfo](docs/PublicPoolInfo.md)
  - [PublicPoolMetadata](docs/PublicPoolMetadata.md)
  - [PublicPoolShare](docs/PublicPoolShare.md)
  - [RFQEntry](docs/RFQEntry.md)
  - [RFQMetadata](docs/RFQMetadata.md)
  - [RFQResponseEntry](docs/RFQResponseEntry.md)
  - [Referral](docs/Referral.md)
- - [ReferralStat](docs/ReferralStat.md)
- - [ReferralStats](docs/ReferralStats.md)
  - [ReferralCode](docs/ReferralCode.md)
  - [ReferralPointEntry](docs/ReferralPointEntry.md)
  - [ReferralPoints](docs/ReferralPoints.md)
  - [ReferralProgramKickback](docs/ReferralProgramKickback.md)
+ - [ReferralStat](docs/ReferralStat.md)
+ - [ReferralStats](docs/ReferralStats.md)
  - [ReferralTotals](docs/ReferralTotals.md)
  - [ReqSetAccountMetadata](docs/ReqSetAccountMetadata.md)
  - [RespChangeAccountTier](docs/RespChangeAccountTier.md)
  - [RespCreateRFQ](docs/RespCreateRFQ.md)
  - [RespGetApiTokens](docs/RespGetApiTokens.md)
+ - [RespGetBoPnL](docs/RespGetBoPnL.md)
+ - [RespGetEvents](docs/RespGetEvents.md)
  - [RespGetExchangeMetrics](docs/RespGetExchangeMetrics.md)
  - [RespGetExecuteStats](docs/RespGetExecuteStats.md)
  - [RespGetFastBridgeInfo](docs/RespGetFastBridgeInfo.md)
@@ -243,8 +256,10 @@ Class | Method | HTTP request | Description
  - [RespGetLeases](docs/RespGetLeases.md)
  - [RespGetMakerOnlyApiKeys](docs/RespGetMakerOnlyApiKeys.md)
  - [RespGetRFQ](docs/RespGetRFQ.md)
+ - [RespGetUpDownCandles](docs/RespGetUpDownCandles.md)
  - [RespListRFQs](docs/RespListRFQs.md)
  - [RespPostApiToken](docs/RespPostApiToken.md)
+ - [RespPriceOracleInfo](docs/RespPriceOracleInfo.md)
  - [RespPublicPoolsMetadata](docs/RespPublicPoolsMetadata.md)
  - [RespRespondToRFQ](docs/RespRespondToRFQ.md)
  - [RespRevokeApiToken](docs/RespRevokeApiToken.md)
@@ -279,6 +294,7 @@ Class | Method | HTTP request | Description
  - [Tx](docs/Tx.md)
  - [TxHash](docs/TxHash.md)
  - [Txs](docs/Txs.md)
+ - [UpDownCandle](docs/UpDownCandle.md)
  - [UserReferrals](docs/UserReferrals.md)
  - [ValidatorInfo](docs/ValidatorInfo.md)
  - [WithdrawHistory](docs/WithdrawHistory.md)

docs/AccountApi.md

@@ -402,7 +402,7 @@ No authorization required
 
 changeAccountTier
 
-Change account type (applies to both master, and subaccounts). Downgrades can be performed once every 24 hours.
+Change account tier. You can only perform this action once every 24 hours.
 
 ### Example
 

docs/BinaryOptionMarketStats.md

@@ -0,0 +1,44 @@
+# BinaryOptionMarketStats
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **str** |  | 
+**market_id** | **int** |  | 
+**mid_price** | **str** |  | 
+**best_ask_price** | **str** |  | 
+**best_bid_price** | **str** |  | 
+**last_trade_price** | **str** |  | 
+**daily_base_token_volume** | **float** |  | 
+**daily_quote_token_volume** | **float** |  | 
+**daily_price_low** | **float** |  | 
+**daily_price_high** | **float** |  | 
+**daily_price_change** | **float** |  | 
+**lifetime_quote_token_volume** | **float** |  | 
+**lifetime_base_token_volume** | **float** |  outcome shares traded over the market's life | 
+**open_interest** | **str** |  | 
+**status** | **str** |  inactive once the trading window closes | 
+**outcome** | **int** |  | 
+
+## Example
+
+```python
+from lighter.models.binary_option_market_stats import BinaryOptionMarketStats
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BinaryOptionMarketStats from a JSON string
+binary_option_market_stats_instance = BinaryOptionMarketStats.from_json(json)
+# print the JSON string representation of the object
+print(BinaryOptionMarketStats.to_json())
+
+# convert the object into a dict
+binary_option_market_stats_dict = binary_option_market_stats_instance.to_dict()
+# create an instance of BinaryOptionMarketStats from a dict
+binary_option_market_stats_from_dict = BinaryOptionMarketStats.from_dict(binary_option_market_stats_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/BoEventPnL.md

@@ -0,0 +1,33 @@
+# BoEventPnL
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_id** | **int** |  | 
+**event_title** | **str** |  | 
+**event_description** | **str** |  | 
+**total_pnl** | **str** |  | 
+**outcomes** | [**List[BoOutcomePnL]**](BoOutcomePnL.md) |  | 
+
+## Example
+
+```python
+from lighter.models.bo_event_pn_l import BoEventPnL
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BoEventPnL from a JSON string
+bo_event_pn_l_instance = BoEventPnL.from_json(json)
+# print the JSON string representation of the object
+print(BoEventPnL.to_json())
+
+# convert the object into a dict
+bo_event_pn_l_dict = bo_event_pn_l_instance.to_dict()
+# create an instance of BoEventPnL from a dict
+bo_event_pn_l_from_dict = BoEventPnL.from_dict(bo_event_pn_l_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/BoOutcomePnL.md

@@ -0,0 +1,35 @@
+# BoOutcomePnL
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_id** | **int** |  | 
+**symbol** | **str** |  | 
+**outcome** | **int** |  | 
+**end_timestamp** | **int** |  | 
+**settlement_pnl** | **str** |  | 
+**last_trade_id** | **int** |  | 
+**total_pnl** | **str** |  | 
+
+## Example
+
+```python
+from lighter.models.bo_outcome_pn_l import BoOutcomePnL
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BoOutcomePnL from a JSON string
+bo_outcome_pn_l_instance = BoOutcomePnL.from_json(json)
+# print the JSON string representation of the object
+print(BoOutcomePnL.to_json())
+
+# convert the object into a dict
+bo_outcome_pn_l_dict = bo_outcome_pn_l_instance.to_dict()
+# create an instance of BoOutcomePnL from a dict
+bo_outcome_pn_l_from_dict = BoOutcomePnL.from_dict(bo_outcome_pn_l_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+