Concepts

  • Overview

Smart contracts

  • Raw contract integration
  • Market making

TypeScript SDK

  • Getting started
  • The exchange API
  • Binary markets
  • Spot markets
  • Perps
  • SomniaLend
  • Price feeds
  • Chains
  • Bridge
  • Chains walkthrough
  • Native RPC
  • Reactivity
  • The engine (advanced)
  • Architecture
  • Release notes

Functions

  • accrueCompounded
  • accrueLinear
  • annualizedFundingRate
  • averageEntryPrice
  • balanceFloor
  • binaryFillsFor
  • binaryFillsFromPortfolio
  • binaryResolutionMode
  • bookMidPrice
  • boundaryPrice
  • buildFundingRateSeries
  • cadenceBandSec
  • candlesKey
  • ceilRawAmount
  • claimableFrom
  • computeBinaryPnl
  • computePortfolioAnalytics
  • computePositionPnL
  • consoleDebugSink
  • debugCollector
  • decodeBinaryVenueFeeParams
  • decodeOutcomeId
  • decodePerpStopOrderIds
  • densifyFundingBuckets
  • estimateMarketOrder
  • estPayoutFor
  • fillKind
  • fillsWithinSlippage
  • floorRawBalance
  • formatIntervalLabel
  • fromHuman
  • fundingRate1h
  • fundingRate8h
  • fundingRatePerInterval
  • getMarketTypePlugin
  • intervalsPerWindow
  • isBinaryMarket
  • isFundingStale
  • isLocalPrecompileUnavailable
  • isPerpMarket
  • isSpotMarket
  • lendRayRateToApy
  • listMarketTypePlugins
  • marketCreatorsKey
  • marketFeesKey
  • marketIntervalLabel
  • marketKey
  • marketOnchainKey
  • marketsKey
  • marketStats24hFromCandles
  • markOutcomePosition
  • markYesPrice
  • maxVenueFeeBpsKey
  • midYesPrice
  • normalizeFundingRate
  • operatorsKey
  • oracleAdaptersKey
  • outcomeId
  • outcomeMarkPrice
  • perpLiquidationPrice
  • perpMarkForPnl
  • perpOrderMarginQuote
  • perpPositionAnalytics
  • pnlEventsFor
  • portfolioKey
  • positionMarkState
  • preflightChain
  • preflightCreateQuote
  • preflightHub
  • preflightMarketCreator
  • preflightOperator
  • preflightRoll
  • preflightSeries
  • preflightVenue
  • priceToProbability
  • probabilityToPrice
  • quoteBinaryOrderOverBook
  • quoteBinarySellOverBook
  • quoteBinaryStakeOverBook
  • rayMul
  • realizedFundingPerBase
  • resolveIntervalSec
  • sideOfKind
  • slippageForCrossing
  • snapIntervalSec
  • snapToCadence
  • syncStatusKey
  • toHuman
  • toHumanString
  • upPercent
  • upProbability

React hooks

  • SomniaMarketsProvider
  • useCandles
  • useFundingRateSeries
  • useIndexerQuery
  • useIsTailing
  • useLendAccount
  • useLendReserves
  • useLiveBinaryOrderBook
  • useLiveBinaryOrderBookByMarket
  • useLiveFills
  • useLiveFundingUpdates
  • useLiveMarketByAddress
  • useLiveMarketByPool
  • useLiveMarkets
  • useLivePrice
  • useLivePriceFeedInfo
  • useLivePriceTicks
  • useLiveSpotOrderBook
  • useLiveStatus
  • useLiveUserFills
  • useLiveUserOrders
  • useMarketCreators
  • useMarketFees
  • useMarkets
  • useOperators
  • useOracleAdapters
  • usePortfolio
  • useSomniaMarketsClient
  • useWatchMarket
  • useWatchPrice
  • useWatchUser

Interfaces

  • SomniaMarketsClient
  • ClientConfig
  • Trader
  • AcceptOperatorOwnershipParams
  • AccountHealth
  • AdoptFromParams
  • AmendOrderParams
  • AmendOrderResult
  • AmendOrdersParams
  • AmendOrdersResult
  • ApproveBuilderParams
  • ArmFirstRollParams
  • AutoPullRequirement
  • BalanceQuery
  • BatchCancelOutcome
  • BatchOrderRequest
  • BatchPlaceOutcome
  • BinaryBookParams
  • BinaryCrossingParams
  • BinaryOrderBook
  • BinaryOrderQuote
  • BinaryOutcomePnl
  • BinaryOutcomePositionPnL
  • BinaryPnl
  • BinaryPnlFill
  • BinaryPositionPnL
  • BinarySellQuote
  • BinaryStakeQuote
  • BinaryVenueParams
  • BookLevel
  • BuilderApprovalRef
  • BurnSetParams
  • CancelExpiredOrdersParams
  • CancelOrderParams
  • CancelOrdersParams
  • CancelOrdersResult
  • CancelPerpStopOrdersParams
  • CancelStopOrderParams
  • CaptureCloseParams
  • ClaimableInput
  • ClaimablePosition
  • ClaimOwedParams
  • ClaimPerpStopSomiParams
  • ClosingPriceState
  • ContractMeta
  • CreateMarketCreatorParams
  • CreateMarketCreatorResult
  • CreateOrderParams
  • CreateQuotePreflightInput
  • CreateVenueParams
  • CreateVenueResult
  • DebugCollector
  • DecodedOutcomeId
  • DepositMarginParams
  • DepositVaultNativeParams
  • DepositVaultParams
  • EnableHubReactivityParams
  • EntryTrade
  • EquityPoint
  • Erc20Metadata
  • FaucetParams
  • FinalizeMarketParams
  • FixedFees
  • FundHubParams
  • FundingBucketLike
  • FundMarketCreatorParams
  • GetAutoPullRequirementParams
  • GetBankruptcyPriceOptions
  • GetManualVaultModeParams
  • GetOutcomeBalanceParams
  • GetPerpSideHoldersOptions
  • GetVaultBalanceParams
  • GovernanceAdmin
  • HandoffToParams
  • HubPreflightInput
  • HubQuestionState
  • HubStatus
  • IndexedPool
  • InsuranceFundState
  • InsuranceFundTier
  • IsApprovedForPoolParams
  • IsGloballyApprovedParams
  • IsOperatorAuthorizedParams
  • LendAccount
  • LendAddresses
  • Lender
  • LendPosition
  • LendRepayOptions
  • LendReserve
  • LendSupplyOptions
  • LendWithdrawOptions
  • LendWriteOptions
  • LinkPerpStopOrdersParams
  • LiquidationEngineConfig
  • LiveFill
  • LiveFundingUpdate
  • LiveOrder
  • LivePrice
  • LockedBalance
  • LockedTokenBreakdown
  • MachineryStep
  • MarginAccount
  • MarketCreatorAdmin
  • MarketCreatorInfo
  • MarketCreatorOnchain
  • MarketCreatorPreflightInput
  • MarketOnchain
  • MarketOnchainSources
  • MarketOrderEstimate
  • MarketStats24h
  • MarketTypePlugin
  • MarkSources
  • MintSetNativeParams
  • MintSetParams
  • MintSetPermit2Params
  • OnchainOrder
  • OnchainResolutionPrice
  • OperatorAdmin
  • OperatorAdminConfig
  • OperatorPreflightInput
  • OracleHubAdmin
  • OracleHubAdminConfig
  • OrderBookParams
  • OrderFill
  • OutcomePositionMark
  • Permit2TransferFrom
  • PerpLeverage
  • PerpLiquidationPriceInputs
  • PerpMainFunding
  • PerpOrderMarginQuote
  • PerpOrderMarginQuoteInputs
  • PerpPosition
  • PerpPositionAnalyticsInputs
  • PerpPositionMetrics
  • PerpPositionRef
  • PerpRiskParams
  • PerpSideHolders
  • PerpSideHoldersRef
  • PerpStateOnchain
  • PerpStopOrderLeg
  • PerpSystemConfig
  • PerpWalletLinkage
  • PlaceOrderParams
  • PlaceOrderResult
  • PlacePerpOrderParams
  • PlacePerpStopOrderParams
  • PlacePerpStopOrderResult
  • PlaceSpotOrderParams
  • PlaceSpotOrdersParams
  • PlaceSpotOrdersResult
  • PlaceSpotStopOrderParams
  • PlaceStopOrderResult
  • PnlBucket
  • PnLEvent
  • PokeOracleParams
  • PoolBindingRecord
  • PortfolioAnalytics
  • PortfolioAnalyticsOptions
  • PortfolioFundingEvent
  • PortfolioTradeEvent
  • PreflightResult
  • PriceCandle
  • PriceFeedConfig
  • PriceFeedInfo
  • PricePoint
  • PriceWatchHandle
  • QuestionDefinitionInput
  • QuestionIntervalInput
  • QuestionSourceInput
  • ReclaimOracleCreditParams
  • RecoverSeriesParams
  • RedeemAuthorization
  • RedeemDirectParams
  • RedeemForParams
  • RedeemManyParams
  • RedeemNativeParams
  • RedeemParams
  • ReduceOrderParams
  • ReduceOrderRequest
  • ReduceOrdersParams
  • RegisterOperatorParams
  • RegisterOperatorResult
  • RegisterSeriesParams
  • ReleasePoolParams
  • ResolveParams
  • RollPreflightInput
  • RouterMintBase
  • ScheduleQuestionParams
  • ScheduleQuestionResult
  • SeriesOnchain
  • SeriesPreflightInput
  • SetAdapterApprovedParams
  • SetHubDrainParams
  • SetHubGasParams
  • SetManualVaultModeParams
  • SetOperatorApprovalForPoolParams
  • SetOperatorApprovalGlobalParams
  • SetOperatorEnabledParams
  • SetPerpLeverageParams
  • SetReactivityGasParamsParams
  • SettlementRecord
  • SetVenueEnabledParams
  • SignRedeemAuthParams
  • SomniaLendClient
  • SomniaMarketsAddresses
  • Span
  • SpotOrderBook
  • SpotOrderRequest
  • SwapCreatorParams
  • SweepExpiredAtLevelParams
  • SyncSettlementParams
  • SystemInfo
  • TailStatus
  • TokenLockBreakdown
  • Tradable
  • TraderConfig
  • TransferOperatorOwnershipParams
  • TriggerRollParams
  • TxResult
  • UnifiedBalance
  • UnifiedBalances
  • UnifiedFundingRate
  • UnifiedMarket
  • UnifiedOrder
  • UnifiedOrderBook
  • UnifiedPosition
  • UnifiedPrice
  • UnifiedStopOrder
  • UnifiedTicker
  • UnifiedTrade
  • UnsignedCall
  • UnsignedMarginDeposit
  • UnsignedOrder
  • UnsignedPerpStopOrder
  • UpdateOperatorParams
  • UpdateVenueParams
  • ValidAnswersInput
  • VenueConfigInput
  • VenuePreflightInput
  • VoidExpiredParams
  • VoidMarketParams
  • WatchHandle
  • WithdrawMarginParams
  • WithdrawMyCreditParams
  • WithdrawParams
  • WithdrawVaultParams
  • YesBookTop

Type aliases

  • BaseMarket
  • BinaryBuySide
  • BinaryFillKind
  • BinaryMarket
  • BinaryMarketFilter
  • BinaryMarketOrderBy
  • BinaryMarketStatus
  • BinaryResolutionMode
  • BinarySellSide
  • BinarySide
  • BookTop
  • BuilderApproval
  • BuilderFeeRecord
  • Candle
  • ClientQueryKey
  • ComputePortfolioAnalyticsError
  • CountResult
  • DebugEvent
  • FillRow
  • FillsOptions
  • FillsScope
  • FundingPayment
  • FundingRateCandle
  • FundingRateSeries
  • FundingRateUpdate
  • FundingSeriesBucket
  • IndexedMarketCreator
  • IndexedMarketCreatorPolicy
  • IndexedOperator
  • IndexedOracleAdapter
  • IndexedPerpPosition
  • IndexedSeries
  • IndexedVenue
  • IndexerSyncStatus
  • IntervalSource
  • LenderConfig
  • LiquidationEvent
  • LiveBinaryMarketsFilter
  • LiveMarket
  • MarginEvent
  • MarginStatus
  • Market
  • MarketCreatorFilter
  • MarketFees
  • MarketReferenceLink
  • MarketResolutionEvent
  • MarketStatusUpdate
  • MarketType
  • MarkSeries
  • OpenInterestSnapshot
  • OpenOrder
  • OpenPositionPnL
  • OperatorFilter
  • OperatorHubAccountRecord
  • OracleAnswer
  • OracleBindRecord
  • OracleCallbackRecord
  • OracleQuestionRecord
  • OrderMarket
  • OrderRow
  • OrdersOptions
  • OrderStatus
  • OutcomeBalances
  • OutcomeIdx
  • PastBinaryMarketsOptions
  • PerpClosePreview
  • PerpFeeRecord
  • PerpFundingPayer
  • PerpHealthSnapshot
  • PerpLiquidationPreview
  • PerpMarket
  • PerpMarketFilter
  • PerpMaxOrderSize
  • PerpMaxOrderSizeLimit
  • PerpOrderHistoryRow
  • PerpOrderMarginPreview
  • PerpPoolStatus
  • PerpPortfolio
  • PerpPortfolioMarket
  • PerpPortfolioOrder
  • PerpPortfolioTrade
  • PerpPositionAnalytics
  • PerpStopDropReason
  • PerpStopIntent
  • PerpStopOrder
  • PerpStopOrderMarket
  • PerpStopOrderOnChain
  • Portfolio
  • PortfolioFlowEvent
  • PortfolioMarket
  • PortfolioOptions
  • PortfolioOrder
  • PortfolioPosition
  • PortfolioTimeframe
  • PortfolioTrade
  • PositionMarkState
  • PriceCandleResolution
  • PriceFeedStatus
  • ProtocolFeeRecord
  • QueryKeyElement
  • QuoteDenomination
  • RouterActionKind
  • RouterActionRecord
  • RouterActionsOptions
  • SettlementFeeRecord
  • SomniaMarketsConfig
  • SpotMarket
  • SpotMarketFilter
  • SpotPortfolio
  • SpotPortfolioMarket
  • SpotPortfolioOrder
  • SpotPortfolioTrade
  • SpotStopOrder
  • StopOrderStatus
  • SweepableOrder
  • TailMode
  • TerminalOrderStatus
  • UnifiedBookLevels
  • UnifiedMarketType
  • UnifiedOHLCV
  • UnifiedOrderStatus
  • UnifiedStopOrderStatus
  • VaultPayoutFallback
  • VenueVoidPolicy
  • WatchStatus

Variables

  • ANSWER_TYPE
  • binaryMarketTypePlugin
  • binaryModuleReadAbi
  • binaryModuleWriteAbi
  • binaryPoolWriteAbi
  • binarySettlementAbi
  • CADENCE_LADDER_SEC
  • CADENCE_TOLERANCE_SEC
  • CANCEL_ORDER_FOR_SELECTOR
  • CANDLE_INTERVALS
  • DECIMALS
  • DEFAULT_CEX_RATE_BPS
  • DEFAULT_FEES
  • DEFAULT_SLIPPAGE_BPS
  • DEFAULT_SLIPPAGE_MIN_TICKS
  • EIGHT_HOURS_SEC
  • erc20VaultWriteAbi
  • erc20WriteAbi
  • erc6909Abi
  • FUNDING_PRECISION
  • HUB_MIN_FREE_BALANCE_WEI
  • lendDebtTokenAbi
  • lendGatewayAbi
  • lendPoolAbi
  • lendUiPoolDataProviderAbi
  • MARGIN_STATUS
  • marginBankWriteAbi
  • MARKET_TYPE_BINARY_V1
  • MARKET_TYPE_PLUGINS
  • MIN_SERIES_INTERVAL_SEC
  • NATIVE_TOKEN_SENTINEL
  • ONE_HOUR_SEC
  • ONE_YEAR_SEC
  • operatorRegistryWriteAbi
  • oracleHubAbi
  • oracleHubEventsAbi
  • ORDER_KIND
  • ORDER_KIND_SIDE
  • ORDER_TYPE
  • orderBookBatchWriteAbi
  • orderBookEventsAbi
  • PERP_POOL_FACTORY_MARKET_STATUS_INTERFACE_ID
  • PERP_STOP_DROP_REASON
  • perpPoolWriteAbi
  • PLACE_ORDER_FOR_SELECTOR
  • PRICE_FEED_DECIMALS
  • PRICE_RESOLUTION_SECONDS
  • QUERY_KEY_SCOPE
  • QUESTION_SOURCE_TYPE
  • RAY
  • SELF_MATCHING_OPTION
  • SOMNIA_MAINNET_ADDRESSES
  • SOMNIA_MAINNET_LEND
  • SOMNIA_TESTNET_ADDRESSES
  • SOMNIA_TESTNET_LEND
  • SOMNIA_TESTNET_PRICE_FEED
  • spotPoolWriteAbi
  • spotStopRegistryEventsAbi
  • spotStopRegistryWriteAbi
  • TIMEFRAMES
  • ZERO_ADDRESS

@somnia-chain/markets-sdk

@somnia-chain/markets-sdk / reactivity

reactivity

reactivity

isLocalPrecompileUnavailable

Re-exports isLocalPrecompileUnavailable

// Somnia Markets markets explorer

system