Skip to main content

Module public_data

Module public_data 

Source
Expand description

Public reference-data endpoints (/api/v5/public/*).

Structsยง

ConvertContractCoin
Contract/coin conversion result.
ConvertContractCoinRequest
Query parameters for contract/coin conversion.
DeliveryExercise
Delivery/exercise history row.
DeliveryExerciseHistoryRequest
Query parameters for delivery/exercise history.
DiscountDetail
Discount tier returned in the details array.
DiscountLevel
Discount tier returned for interest-free quota calculations (legacy format).
DiscountRateInterestFreeQuota
Discount-rate and interest-free quota row.
EstimatedPrice
Estimated delivery or exercise price row.
FundingRate
Current funding-rate information.
FundingRateHistory
Historical funding-rate row.
FundingRateHistoryRequest
Query parameters for funding-rate history.
Instrument
A tradable instrument.
InstrumentFamilyRequest
Query parameters for public endpoints filtered by instrument family.
InstrumentTickBand
Instrument tick-band row.
InstrumentTickBandsRequest
Query parameters for GET /api/v5/public/instrument-tick-bands.
InsuranceFund
Insurance-fund snapshot.
InsuranceFundRequest
Query parameters for insurance fund snapshots.
InterestRateLoanQuota
Interest-rate and loan-quota response row.
InterestRateLoanQuotaRequest
Empty query for GET /api/v5/public/interest-rate-loan-quota.
LoanQuotaBasic
Per-currency base rate and quota.
LoanQuotaConfig
Customized absolute loan quota.
LoanQuotaConfiguredCurrency
Currency with a customized interest rate.
LoanQuotaLevel
User-level quota coefficient.
MarkPrice
Mark-price information.
MarketDataHistory
Market-data history row.
MarketDataHistoryRequest
Query parameters for GET /api/v5/public/market-data-history.
OpenInterest
Open interest for an instrument.
OptionSummary
Option summary row.
OptionSummaryRequest
Query parameters for GET /api/v5/public/opt-summary.
PositionTier
Public position-tier information.
PositionTiersRequest
Query parameters for public position tiers.
PriceLimit
Price-limit information for an instrument.
PublicData
Accessor for the public reference-data endpoints.
PublicOptionTrade
Public option-trade row.
PublicOptionTradesRequest
Query parameters for GET /api/v5/public/option-trades.
SystemTime
OKX system time.
TickBandDetail
A single price range and tick-size definition.
UnderlyingRequest
Query parameters for GET /api/v5/public/underlying.
VipInterestRateLoanQuota
VIP interest-rate loan quota row.