> ## Documentation Index
> Fetch the complete documentation index at: https://orderly.network/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Orderly network hooks
[Orderly SDKs](/sdks/tech-doc/README) / [Modules](/sdks/tech-doc/modules) / @orderly.network/hooks
# Module: @orderly.network/hooks
## Table of contents
### Namespaces
* [RefferalAPI](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI)
* [utils](/sdks/tech-doc/modules/orderly_network_hooks.utils)
### Enumerations
* [MarketsType](/sdks/tech-doc/enums/orderly_network_hooks.MarketsType)
* [WsNetworkStatus](/sdks/tech-doc/enums/orderly_network_hooks.WsNetworkStatus)
### Interfaces
* [CallOptions](/sdks/tech-doc/interfaces/orderly_network_hooks.CallOptions)
* [ConfigProviderProps](/sdks/tech-doc/interfaces/orderly_network_hooks.ConfigProviderProps)
* [ControlFunctions](/sdks/tech-doc/interfaces/orderly_network_hooks.ControlFunctions)
* [DebouncedState](/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState)
* [Favorite](/sdks/tech-doc/interfaces/orderly_network_hooks.Favorite)
* [FavoriteTab](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)
* [Options](/sdks/tech-doc/interfaces/orderly_network_hooks.Options)
* [OrderlyConfigContextState](/sdks/tech-doc/interfaces/orderly_network_hooks.OrderlyConfigContextState)
* [Recent](/sdks/tech-doc/interfaces/orderly_network_hooks.Recent)
* [StatusContextState](/sdks/tech-doc/interfaces/orderly_network_hooks.StatusContextState)
* [WalletAdapter](/sdks/tech-doc/interfaces/orderly_network_hooks.WalletAdapter)
### Type Aliases
* [Chain](/sdks/tech-doc/modules/orderly_network_hooks#chain)
* [Chains](/sdks/tech-doc/modules/orderly_network_hooks#chains)
* [CollateralOutputs](/sdks/tech-doc/modules/orderly_network_hooks#collateraloutputs)
* [ComputedAlgoOrder](/sdks/tech-doc/modules/orderly_network_hooks#computedalgoorder)
* [DrawOptions](/sdks/tech-doc/modules/orderly_network_hooks#drawoptions)
* [OrderBookItem](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)
* [OrderParams](/sdks/tech-doc/modules/orderly_network_hooks#orderparams)
* [OrderbookData](/sdks/tech-doc/modules/orderly_network_hooks#orderbookdata)
* [OrderbookOptions](/sdks/tech-doc/modules/orderly_network_hooks#orderbookoptions)
* [PosterLayoutConfig](/sdks/tech-doc/modules/orderly_network_hooks#posterlayoutconfig)
* [SWRConfiguration](/sdks/tech-doc/modules/orderly_network_hooks#swrconfiguration)
* [UseChainsOptions](/sdks/tech-doc/modules/orderly_network_hooks#usechainsoptions)
* [UseChainsReturnObject](/sdks/tech-doc/modules/orderly_network_hooks#usechainsreturnobject)
* [UseOrderEntryMetaState](/sdks/tech-doc/modules/orderly_network_hooks#useorderentrymetastate)
* [chainFilter](/sdks/tech-doc/modules/orderly_network_hooks#chainfilter)
* [chainFilterFunc](/sdks/tech-doc/modules/orderly_network_hooks#chainfilterfunc)
* [filteredChains](/sdks/tech-doc/modules/orderly_network_hooks#filteredchains)
### Variables
* [DefaultLayoutConfig](/sdks/tech-doc/modules/orderly_network_hooks#defaultlayoutconfig)
* [OrderlyContext](/sdks/tech-doc/modules/orderly_network_hooks#orderlycontext)
* [StatusContext](/sdks/tech-doc/modules/orderly_network_hooks#statuscontext)
* [WalletConnectorContext](/sdks/tech-doc/modules/orderly_network_hooks#walletconnectorcontext)
* [version](/sdks/tech-doc/modules/orderly_network_hooks#version)
### Function Functions
* [useDebouncedCallback](/sdks/tech-doc/modules/orderly_network_hooks#usedebouncedcallback)
* [useThrottledCallback](/sdks/tech-doc/modules/orderly_network_hooks#usethrottledcallback)
### Other Functions
* [OrderlyConfigProvider](/sdks/tech-doc/modules/orderly_network_hooks#orderlyconfigprovider)
* [OrderlyProvider](/sdks/tech-doc/modules/orderly_network_hooks#orderlyprovider)
* [SWRConfig](/sdks/tech-doc/modules/orderly_network_hooks#swrconfig)
* [StatusProvider](/sdks/tech-doc/modules/orderly_network_hooks#statusprovider)
* [checkNotional](/sdks/tech-doc/modules/orderly_network_hooks#checknotional)
* [cleanStringStyle](/sdks/tech-doc/modules/orderly_network_hooks#cleanstringstyle)
* [parseJSON](/sdks/tech-doc/modules/orderly_network_hooks#parsejson)
* [unstable\_serialize](/sdks/tech-doc/modules/orderly_network_hooks#unstable_serialize)
* [useAccount](/sdks/tech-doc/modules/orderly_network_hooks#useaccount)
* [useAccountInfo](/sdks/tech-doc/modules/orderly_network_hooks#useaccountinfo)
* [useAccountInstance](/sdks/tech-doc/modules/orderly_network_hooks#useaccountinstance)
* [useBoolean](/sdks/tech-doc/modules/orderly_network_hooks#useboolean)
* [useChain](/sdks/tech-doc/modules/orderly_network_hooks#usechain)
* [useChains](/sdks/tech-doc/modules/orderly_network_hooks#usechains)
* [useCheckReferralCode](/sdks/tech-doc/modules/orderly_network_hooks#usecheckreferralcode)
* [useCollateral](/sdks/tech-doc/modules/orderly_network_hooks#usecollateral)
* [useCommission](/sdks/tech-doc/modules/orderly_network_hooks#usecommission)
* [useConfig](/sdks/tech-doc/modules/orderly_network_hooks#useconfig)
* [useConstant](/sdks/tech-doc/modules/orderly_network_hooks#useconstant)
* [useDaily](/sdks/tech-doc/modules/orderly_network_hooks#usedaily)
* [useDebounce](/sdks/tech-doc/modules/orderly_network_hooks#usedebounce)
* [useDeposit](/sdks/tech-doc/modules/orderly_network_hooks#usedeposit)
* [useDistribution](/sdks/tech-doc/modules/orderly_network_hooks#usedistribution)
* [useEventEmitter](/sdks/tech-doc/modules/orderly_network_hooks#useeventemitter)
* [useFundingRate](/sdks/tech-doc/modules/orderly_network_hooks#usefundingrate)
* [useGetReferralCode](/sdks/tech-doc/modules/orderly_network_hooks#usegetreferralcode)
* [useHoldingStream](/sdks/tech-doc/modules/orderly_network_hooks#useholdingstream)
* [useIndexPrice](/sdks/tech-doc/modules/orderly_network_hooks#useindexprice)
* [useLazyQuery](/sdks/tech-doc/modules/orderly_network_hooks#uselazyquery)
* [useLeverage](/sdks/tech-doc/modules/orderly_network_hooks#useleverage)
* [useLocalStorage](/sdks/tech-doc/modules/orderly_network_hooks#uselocalstorage)
* [useMarginRatio](/sdks/tech-doc/modules/orderly_network_hooks#usemarginratio)
* [useMarkPrice](/sdks/tech-doc/modules/orderly_network_hooks#usemarkprice)
* [useMarkPricesStream](/sdks/tech-doc/modules/orderly_network_hooks#usemarkpricesstream)
* [useMarketTradeStream](/sdks/tech-doc/modules/orderly_network_hooks#usemarkettradestream)
* [useMarkets](/sdks/tech-doc/modules/orderly_network_hooks#usemarkets)
* [useMarketsStream](/sdks/tech-doc/modules/orderly_network_hooks#usemarketsstream)
* [useMaxQty](/sdks/tech-doc/modules/orderly_network_hooks#usemaxqty)
* [useMediaQuery](/sdks/tech-doc/modules/orderly_network_hooks#usemediaquery)
* [useMutation](/sdks/tech-doc/modules/orderly_network_hooks#usemutation)
* [useOrderEntry](/sdks/tech-doc/modules/orderly_network_hooks#useorderentry)
* [useOrderStream](/sdks/tech-doc/modules/orderly_network_hooks#useorderstream)
* [useOrderbookStream](/sdks/tech-doc/modules/orderly_network_hooks#useorderbookstream)
* [usePositionStream](/sdks/tech-doc/modules/orderly_network_hooks#usepositionstream)
* [usePoster](/sdks/tech-doc/modules/orderly_network_hooks#useposter)
* [usePreLoadData](/sdks/tech-doc/modules/orderly_network_hooks#usepreloaddata)
* [usePrivateDataObserver](/sdks/tech-doc/modules/orderly_network_hooks#useprivatedataobserver)
* [usePrivateInfiniteQuery](/sdks/tech-doc/modules/orderly_network_hooks#useprivateinfinitequery)
* [usePrivateQuery](/sdks/tech-doc/modules/orderly_network_hooks#useprivatequery)
* [useQuery](/sdks/tech-doc/modules/orderly_network_hooks#usequery)
* [useRefereeHistory](/sdks/tech-doc/modules/orderly_network_hooks#userefereehistory)
* [useRefereeInfo](/sdks/tech-doc/modules/orderly_network_hooks#userefereeinfo)
* [useRefereeRebateSummary](/sdks/tech-doc/modules/orderly_network_hooks#userefereerebatesummary)
* [useReferralInfo](/sdks/tech-doc/modules/orderly_network_hooks#usereferralinfo)
* [useReferralRebateSummary](/sdks/tech-doc/modules/orderly_network_hooks#usereferralrebatesummary)
* [useSWR](/sdks/tech-doc/modules/orderly_network_hooks#useswr)
* [useSWRConfig](/sdks/tech-doc/modules/orderly_network_hooks#useswrconfig)
* [useSessionStorage](/sdks/tech-doc/modules/orderly_network_hooks#usesessionstorage)
* [useSettleSubscription](/sdks/tech-doc/modules/orderly_network_hooks#usesettlesubscription)
* [useSymbolLeverage](/sdks/tech-doc/modules/orderly_network_hooks#usesymbolleverage)
* [useSymbolPriceRange](/sdks/tech-doc/modules/orderly_network_hooks#usesymbolpricerange)
* [useSymbolsInfo](/sdks/tech-doc/modules/orderly_network_hooks#usesymbolsinfo)
* [useTPSLOrder](/sdks/tech-doc/modules/orderly_network_hooks#usetpslorder)
* [useTickerStream](/sdks/tech-doc/modules/orderly_network_hooks#usetickerstream)
* [useWS](/sdks/tech-doc/modules/orderly_network_hooks#usews)
* [useWalletConnector](/sdks/tech-doc/modules/orderly_network_hooks#usewalletconnector)
* [useWalletSubscription](/sdks/tech-doc/modules/orderly_network_hooks#usewalletsubscription)
* [useWithdraw](/sdks/tech-doc/modules/orderly_network_hooks#usewithdraw)
* [useWsStatus](/sdks/tech-doc/modules/orderly_network_hooks#usewsstatus)
## Type Aliases
### Chain
Ƭ **Chain**: [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain) & \{ `nativeToken?`: [`TokenInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.TokenInfo) }
#### Defined in
[packages/hooks/src/orderly/useChains.ts:15](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useChains.ts#L15)
***
### Chains
Ƭ **Chains**\<`T`, `K`>: `T` extends [`NetworkId`](/sdks/tech-doc/modules/orderly_network_types#networkid) ? `K` extends keyof [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain) ? [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain)\[`K`]\[] : [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain)\[] : `K` extends keyof [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain) ? \{ `mainnet`: [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain)\[`K`]\[] ; `testnet`: [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain)\[`K`]\[] } : \{ `mainnet`: [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain)\[] ; `testnet`: [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain)\[] }
#### Type parameters
| Name | Type |
| :--- | :-------------------------------------------------------------------------------------------------------------- |
| `T` | extends [`NetworkId`](/sdks/tech-doc/modules/orderly_network_types#networkid) \| `undefined` = `undefined` |
| `K` | extends keyof [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain) \| `undefined` = `undefined` |
#### Defined in
[packages/hooks/src/orderly/useChains.ts:19](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useChains.ts#L19)
***
### CollateralOutputs
Ƭ **CollateralOutputs**: `Object`
#### Type declaration
| Name | Type |
| :----------------- | :------------------------------------------------------------------------------- |
| `accountInfo?` | [`AccountInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.AccountInfo) |
| `availableBalance` | `number` |
| `freeCollateral` | `number` |
| `positions` | [`Position`](/sdks/tech-doc/interfaces/orderly_network_types.API.Position)\[] |
| `totalCollateral` | `number` |
| `totalValue` | `number` |
| `unsettledPnL` | `number` |
#### Defined in
[packages/hooks/src/orderly/useCollateral.ts:16](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useCollateral.ts#L16)
***
### ComputedAlgoOrder
Ƭ **ComputedAlgoOrder**: `Partial`\<[`AlgoOrderEntity`](/sdks/tech-doc/modules/orderly_network_types#algoorderentity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)> & \{ `sl_offset`: `number` ; `sl_offset_percentage`: `number` ; `sl_pnl`: `number` ; `tp_offset`: `number` ; `tp_offset_percentage`: `number` ; `tp_pnl`: `number` }>
#### Defined in
[packages/hooks/src/orderly/useTakeProfitAndStopLoss/useTPSL.ts:19](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useTakeProfitAndStopLoss/useTPSL.ts#L19)
***
### DrawOptions
Ƭ **DrawOptions**: `Object`
#### Type declaration
| Name | Type | Description |
| :----------------- | :-------------------------------------------------------------------------------------- | :--------------------------------- |
| `backgroundColor?` | `string` | - |
| `backgroundImg?` | `string` | - |
| `brandColor?` | `string` | The brand color of the application |
| `color?` | `string` | Color of common text |
| `data?` | `posterDataSource` | - |
| `fontFamily?` | `string` | - |
| `layout?` | [`PosterLayoutConfig`](/sdks/tech-doc/modules/orderly_network_hooks#posterlayoutconfig) | - |
| `lossColor?` | `string` | Lose color |
| `profitColor?` | `string` | Profit color |
#### Defined in
[packages/hooks/src/services/painter/basePaint.ts:85](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/services/painter/basePaint.ts#L85)
***
### OrderBookItem
Ƭ **OrderBookItem**: `number`\[]
#### Defined in
[packages/hooks/src/orderly/useOrderbookStream.ts:12](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderbookStream.ts#L12)
***
### OrderParams
Ƭ **OrderParams**: `Required`\<`Pick`\<[`OrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.OrderEntity), `"side"` | `"order_type"` | `"symbol"`>> & `Partial`\<`Omit`\<[`OrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.OrderEntity), `"side"` | `"symbol"` | `"order_type"`>>
#### Defined in
[packages/hooks/src/orderly/useOrderEntry.ts:74](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderEntry.ts#L74)
***
### OrderbookData
Ƭ **OrderbookData**: `Object`
#### Type declaration
| Name | Type |
| :----- | :------------------------------------------------------------------------------- |
| `asks` | [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)\[] |
| `bids` | [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)\[] |
#### Defined in
[packages/hooks/src/orderly/useOrderbookStream.ts:14](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderbookStream.ts#L14)
***
### OrderbookOptions
Ƭ **OrderbookOptions**: `Object`
Configuration for the Order Book
#### Type declaration
| Name | Type | Description |
| :--------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------- |
| `level?` | `number` | Indicates the number of data entries to return for ask/bid, default is 10 |
| `padding?` | `boolean` | Whether to fill in when the actual data entries are less than the level. If filled, it will add \[nan, nan, nan, nan]. Default is true |
#### Defined in
[packages/hooks/src/orderly/useOrderbookStream.ts:222](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderbookStream.ts#L222)
***
### PosterLayoutConfig
Ƭ **PosterLayoutConfig**: `Object`
#### Type declaration
| Name | Type |
| :--------------- | :----------------------------------------------------------------------------- |
| `domain?` | `layoutInfo` |
| `informations?` | `layoutInfo` & \{ `labelColor?`: `string` } |
| `message?` | `layoutInfo` |
| `position?` | `layoutInfo` |
| `unrealizedPnl?` | `layoutInfo` & \{ `secondaryColor`: `string` ; `secondaryFontSize`: `number` } |
| `updateTime?` | `layoutInfo` |
#### Defined in
[packages/hooks/src/services/painter/basePaint.ts:69](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/services/painter/basePaint.ts#L69)
***
### SWRConfiguration
Ƭ **SWRConfiguration**\<`Data`, `Error`, `Fn`>: `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `Fn`>>
#### Type parameters
| Name | Type |
| :------ | :---------------------------------------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `Fn` | extends `BareFetcher`\<`any`> = `BareFetcher`\<`any`> |
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:257
***
### UseChainsOptions
Ƭ **UseChainsOptions**: \{ `filter?`: (`item`: [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain)) => `boolean` ; `pick?`: `"dexs"` | `"network_infos"` | `"token_infos"` } & [`SWRConfiguration`](/sdks/tech-doc/modules/orderly_network_hooks#swrconfiguration)
#### Defined in
[packages/hooks/src/orderly/useChains.ts:36](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useChains.ts#L36)
***
### UseChainsReturnObject
Ƭ **UseChainsReturnObject**: `Object`
#### Type declaration
| Name | Type |
| :-------------- | :------------------------------------------------------------------------------------------------------------------------ |
| `error` | `any` |
| `findByChainId` | (`chainId`: `number`, `field?`: `string`) => [`Chain`](/sdks/tech-doc/modules/orderly_network_hooks#chain) \| `undefined` |
#### Defined in
[packages/hooks/src/orderly/useChains.ts:41](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useChains.ts#L41)
***
### UseOrderEntryMetaState
Ƭ **UseOrderEntryMetaState**: `Object`
#### Type declaration
| Name | Type |
| :---------- | :---------------------------------------------------------------- |
| `dirty` | \{ \[P in keyof OrderEntity]?: boolean } \| `null` \| `undefined` |
| `errors` | \{ \[P in keyof OrderEntity]?: Object } \| `null` \| `undefined` |
| `submitted` | `boolean` |
#### Defined in
[packages/hooks/src/orderly/useOrderEntry.ts:37](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderEntry.ts#L37)
***
### chainFilter
Ƭ **chainFilter**: [`filteredChains`](/sdks/tech-doc/modules/orderly_network_hooks#filteredchains) | [`chainFilterFunc`](/sdks/tech-doc/modules/orderly_network_hooks#chainfilterfunc)
#### Defined in
[packages/hooks/src/orderlyContext.ts:18](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderlyContext.ts#L18)
***
### chainFilterFunc
Ƭ **chainFilterFunc**: (`config`: [`ConfigStore`](/sdks/tech-doc/interfaces/orderly_network_core.ConfigStore)) => [`filteredChains`](/sdks/tech-doc/modules/orderly_network_hooks#filteredchains)
#### Type declaration
▸ (`config`): [`filteredChains`](/sdks/tech-doc/modules/orderly_network_hooks#filteredchains)
##### Parameters
| Name | Type |
| :------- | :-------------------------------------------------------------------------- |
| `config` | [`ConfigStore`](/sdks/tech-doc/interfaces/orderly_network_core.ConfigStore) |
##### Returns
[`filteredChains`](/sdks/tech-doc/modules/orderly_network_hooks#filteredchains)
#### Defined in
[packages/hooks/src/orderlyContext.ts:16](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderlyContext.ts#L16)
***
### filteredChains
Ƭ **filteredChains**: `Object`
#### Type declaration
| Name | Type |
| :--------- | :------------------------------------------------------------------------------ |
| `mainnet?` | [`ChainConfig`](/sdks/tech-doc/interfaces/orderly_network_types.ChainConfig)\[] |
| `testnet?` | [`ChainConfig`](/sdks/tech-doc/interfaces/orderly_network_types.ChainConfig)\[] |
#### Defined in
[packages/hooks/src/orderlyContext.ts:11](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderlyContext.ts#L11)
## Variables
### DefaultLayoutConfig
• `Const` **DefaultLayoutConfig**: [`PosterLayoutConfig`](/sdks/tech-doc/modules/orderly_network_hooks#posterlayoutconfig)
#### Defined in
[packages/hooks/src/services/painter/layout.config.ts:3](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/services/painter/layout.config.ts#L3)
***
### OrderlyContext
• `Const` **OrderlyContext**: `Context`\<[`OrderlyConfigContextState`](/sdks/tech-doc/interfaces/orderly_network_hooks.OrderlyConfigContextState)>
#### Defined in
[packages/hooks/src/orderlyContext.ts:37](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderlyContext.ts#L37)
***
### StatusContext
• `Const` **StatusContext**: `Context`\<[`StatusContextState`](/sdks/tech-doc/interfaces/orderly_network_hooks.StatusContextState)>
#### Defined in
[packages/hooks/src/statusProvider.tsx:8](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/statusProvider.tsx#L8)
***
### WalletConnectorContext
• `Const` **WalletConnectorContext**: `Context`\<`WalletConnectorContextState`>
#### Defined in
[packages/hooks/src/walletConnectorContext.tsx:36](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/walletConnectorContext.tsx#L36)
***
### version
• **version**: `"1.5.7"`
#### Defined in
[packages/hooks/src/version.ts:14](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/version.ts#L14)
## Function Functions
### useDebouncedCallback
▸ **useDebouncedCallback**\<`T`>(`func`, `wait?`, `options?`): [`DebouncedState`](/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState)\<`T`>
Creates a debounced function that delays invoking `func` until after `wait`
milliseconds have elapsed since the last time the debounced function was
invoked, or until the next browser frame is drawn.
The debounced function comes with a `cancel` method to cancel delayed `func`
invocations and a `flush` method to immediately invoke them.
Provide `options` to indicate whether `func` should be invoked on the leading
and/or trailing edge of the `wait` timeout. The `func` is invoked with the
last arguments provided to the debounced function.
Subsequent calls to the debounced function return the result of the last
`func` invocation.
**Note:** If `leading` and `trailing` options are `true`, `func` is
invoked on the trailing edge of the timeout only if the debounced function
is invoked more than once during the `wait` timeout.
If `wait` is `0` and `leading` is `false`, `func` invocation is deferred
until the next tick, similar to `setTimeout` with a timeout of `0`.
If `wait` is omitted in an environment with `requestAnimationFrame`, `func`
invocation will be deferred until the next frame is drawn (typically about
16ms).
See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/)
for details over the differences between `debounce` and `throttle`.
#### Type parameters
| Name | Type |
| :--- | :----------------------------------------------- |
| `T` | extends (...`args`: `any`) => `ReturnType`\<`T`> |
#### Parameters
| Name | Type | Description |
| :--------- | :------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
| `func` | `T` | The function to debounce. |
| `wait?` | `number` | The number of milliseconds to delay; if omitted, `requestAnimationFrame` is used (if available, otherwise it will be setTimeout(...,0)). |
| `options?` | [`Options`](/sdks/tech-doc/interfaces/orderly_network_hooks.Options) | The options object. Controls if `func` should be invoked on the leading edge of the timeout. |
#### Returns
[`DebouncedState`](/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState)\<`T`>
Returns the new debounced function.
**`Example`**
```ts theme={null}
// Avoid costly calculations while the window size is in flux.
const resizeHandler = useDebouncedCallback(calculateLayout, 150);
window.addEventListener('resize', resizeHandler)
// Invoke `sendMail` when clicked, debouncing subsequent calls.
const clickHandler = useDebouncedCallback(sendMail, 300, {
leading: true,
trailing: false,
})
// Ensure `batchLog` is invoked once after 1 second of debounced calls.
const debounced = useDebouncedCallback(batchLog, 250, { 'maxWait': 1000 })
const source = new EventSource('/stream')
source.addEventListener('message', debounced)
// Cancel the trailing debounced invocation.
window.addEventListener('popstate', debounced.cancel)
// Check for pending invocations.
const status = debounced.pending() ? "Pending..." : "Ready"
```
#### Defined in
node\_modules/.pnpm/use-[debounce@9.0.4\_react](mailto:debounce@9.0.4_react)@18.2.0/node\_modules/use-debounce/dist/useDebouncedCallback.d.ts:104
***
### useThrottledCallback
▸ **useThrottledCallback**\<`T`>(`func`, `wait?`, `options?`): [`DebouncedState`](/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState)\<`T`>
Creates a throttled function that only invokes `func` at most once per
every `wait` milliseconds (or once per browser frame).
The throttled function comes with a `cancel` method to cancel delayed `func`
invocations and a `flush` method to immediately invoke them.
Provide `options` to indicate whether `func` should be invoked on the leading
and/or trailing edge of the `wait` timeout. The `func` is invoked with the
last arguments provided to the throttled function.
Subsequent calls to the throttled function return the result of the last
`func` invocation.
**Note:** If `leading` and `trailing` options are `true`, `func` is
invoked on the trailing edge of the timeout only if the throttled function
is invoked more than once during the `wait` timeout.
If `wait` is `0` and `leading` is `false`, `func` invocation is deferred
until the next tick, similar to `setTimeout` with a timeout of `0`.
If `wait` is omitted in an environment with `requestAnimationFrame`, `func`
invocation will be deferred until the next frame is drawn (typically about
16ms).
See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/)
for details over the differences between `throttle` and `debounce`.
#### Type parameters
| Name | Type |
| :--- | :----------------------------------------------- |
| `T` | extends (...`args`: `any`) => `ReturnType`\<`T`> |
#### Parameters
| Name | Type | Description |
| :--------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `func` | `T` | The function to throttle. |
| `wait?` | `number` | The number of milliseconds to throttle invocations to; if omitted, `requestAnimationFrame` is used (if available, otherwise it will be setTimeout(...,0)). |
| `options?` | [`CallOptions`](/sdks/tech-doc/interfaces/orderly_network_hooks.CallOptions) | The options object. |
#### Returns
[`DebouncedState`](/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState)\<`T`>
Returns the new throttled function.
**`Example`**
```ts theme={null}
// Avoid excessively updating the position while scrolling.
const scrollHandler = useThrottledCallback(updatePosition, 100)
window.addEventListener('scroll', scrollHandler)
// Invoke `renewToken` when the click event is fired, but not more than once every 5 minutes.
const { callback } = useThrottledCallback(renewToken, 300000, { 'trailing': false })
// Cancel the trailing throttled invocation.
window.addEventListener('popstate', throttled.cancel);
```
#### Defined in
node\_modules/.pnpm/use-[debounce@9.0.4\_react](mailto:debounce@9.0.4_react)@18.2.0/node\_modules/use-debounce/dist/useThrottledCallback.d.ts:54
***
## Other Functions
### OrderlyConfigProvider
▸ **OrderlyConfigProvider**(`props`): `null` | `Element`
#### Parameters
| Name | Type |
| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `props` | `PropsWithChildren`\<`RequireAtLeastOne`\<[`ConfigProviderProps`](/sdks/tech-doc/interfaces/orderly_network_hooks.ConfigProviderProps), `"brokerId"` \| `"configStore"`>> |
#### Returns
`null` | `Element`
#### Defined in
[packages/hooks/src/configProvider.tsx:60](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/configProvider.tsx#L60)
***
### OrderlyProvider
▸ **OrderlyProvider**(`props`): `ReactNode`
**NOTE**: Exotic components are not callable.
#### Parameters
| Name | Type |
| :------ | :------------------------------------------------------------------------------------------------------------------------- |
| `props` | `ProviderProps`\<[`OrderlyConfigContextState`](/sdks/tech-doc/interfaces/orderly_network_hooks.OrderlyConfigContextState)> |
#### Returns
`ReactNode`
#### Defined in
node\_modules/.pnpm/@types+react\@18.2.38/node\_modules/@types/react/index.d.ts:395
***
### SWRConfig
▸ **SWRConfig**(`props`, `context?`): `ReactNode`
#### Parameters
| Name | Type |
| :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `props` | `PropsWithChildren`\<\{ `value?`: `Partial`\<`PublicConfiguration`\<`any`, `any`, `BareFetcher`\<`any`>>> & `Partial`\<`ProviderConfiguration`> & \{ `provider?`: (`cache`: `Readonly`\<`Cache`\<`any`>>) => `Cache`\<`any`> } \| (`parentConfig?`: `Partial`\<`PublicConfiguration`\<`any`, `any`, `BareFetcher`\<`any`>>> & `Partial`\<`ProviderConfiguration`> & \{ `provider?`: (`cache`: `Readonly`\<`Cache`\<`any`>>) => `Cache`\<`any`> }) => `Partial`\<`PublicConfiguration`\<`any`, `any`, `BareFetcher`\<`any`>>> & `Partial`\<`ProviderConfiguration`> & \{ `provider?`: (`cache`: `Readonly`\<`Cache`\<`any`>>) => `Cache`\<`any`> } }> |
| `context?` | `any` |
#### Returns
`ReactNode`
#### Defined in
node\_modules/.pnpm/@types+react\@18.2.21/node\_modules/@types/react/index.d.ts:563
***
### StatusProvider
▸ **StatusProvider**(`props`, `context?`): `ReactNode`
#### Parameters
| Name | Type |
| :---------------- | :---------- |
| `props` | `Object` |
| `props.children?` | `ReactNode` |
| `context?` | `any` |
#### Returns
`ReactNode`
#### Defined in
node\_modules/.pnpm/@types+react\@18.2.38/node\_modules/@types/react/index.d.ts:567
***
### checkNotional
▸ **checkNotional**(`price?`, `qty?`, `minNotional?`): `string` | `undefined`
#### Parameters
| Name | Type |
| :------------- | :------------------- |
| `price?` | `string` \| `number` |
| `qty?` | `string` \| `number` |
| `minNotional?` | `number` |
#### Returns
`string` | `undefined`
#### Defined in
[packages/hooks/src/utils/createOrder.ts:3](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/utils/createOrder.ts#L3)
***
### cleanStringStyle
▸ **cleanStringStyle**(`str`): `string`
#### Parameters
| Name | Type |
| :---- | :------------------- |
| `str` | `string` \| `number` |
#### Returns
`string`
#### Defined in
[packages/hooks/src/utils/orderEntryHelper.ts:29](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/utils/orderEntryHelper.ts#L29)
***
### parseJSON
▸ **parseJSON**\<`T`>(`value`): `T` | `undefined`
#### Type parameters
| Name |
| :--- |
| `T` |
#### Parameters
| Name | Type |
| :------ | :----------------- |
| `value` | `null` \| `string` |
#### Returns
`T` | `undefined`
#### Defined in
[packages/hooks/src/utils/json.ts:1](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/utils/json.ts#L1)
***
### unstable\_serialize
▸ **unstable\_serialize**(`key`): `string`
#### Parameters
| Name | Type |
| :---- | :---- |
| `key` | `Key` |
#### Returns
`string`
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/core/dist/index.d.ts:6
***
### useAccount
▸ **useAccount**(): `Object`
#### Returns
`Object`
| Name | Type |
| :----------------- | :---------------------------------------------------------------------------- |
| `account` | [`Account`](/sdks/tech-doc/classes/orderly_network_core.Account) |
| `createAccount` | () => `Promise`\<`any`> |
| `createOrderlyKey` | (`remember`: `boolean`) => `Promise`\<`any`> |
| `state` | [`AccountState`](/sdks/tech-doc/interfaces/orderly_network_core.AccountState) |
#### Defined in
[packages/hooks/src/useAccount.ts:6](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useAccount.ts#L6)
***
### useAccountInfo
▸ **useAccountInfo**(): `SWRResponse`\<[`AccountInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.AccountInfo), `any`, `any`>
#### Returns
`SWRResponse`\<[`AccountInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.AccountInfo), `any`, `any`>
#### Defined in
[packages/hooks/src/orderly/useAccountInfo.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useAccountInfo.ts#L4)
***
### useAccountInstance
▸ **useAccountInstance**(): [`Account`](/sdks/tech-doc/classes/orderly_network_core.Account)
#### Returns
[`Account`](/sdks/tech-doc/classes/orderly_network_core.Account)
#### Defined in
[packages/hooks/src/useAccountInstance.ts:6](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useAccountInstance.ts#L6)
***
### useBoolean
▸ **useBoolean**(`initialValue?`): \[`boolean`, \{ `setFalse`: () => `void` ; `setTrue`: () => `void` ; `toggle`: () => `void` }]
#### Parameters
| Name | Type | Default value |
| :------------- | :-------- | :------------ |
| `initialValue` | `boolean` | `false` |
#### Returns
\[`boolean`, \{ `setFalse`: () => `void` ; `setTrue`: () => `void` ; `toggle`: () => `void` }]
#### Defined in
[packages/hooks/src/useBoolean.ts:3](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useBoolean.ts#L3)
***
### useChain
▸ **useChain**(`token`): `Object`
#### Parameters
| Name | Type |
| :------ | :------- |
| `token` | `string` |
#### Returns
`Object`
| Name | Type |
| :---------- | :----------------------------------------------------------------------------- |
| `chains` | `null` \| [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain) |
| `isLoading` | `boolean` |
#### Defined in
[packages/hooks/src/orderly/useChain.ts:5](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useChain.ts#L5)
***
### useChains
▸ **useChains**(`networkId?`, `options?`): \[[`Chains`](/sdks/tech-doc/modules/orderly_network_hooks#chains)\<`undefined`, `undefined`>, [`UseChainsReturnObject`](/sdks/tech-doc/modules/orderly_network_hooks#usechainsreturnobject)]
#### Parameters
| Name | Type |
| :----------- | :---------- |
| `networkId?` | `undefined` |
| `options?` | `undefined` |
#### Returns
\[[`Chains`](/sdks/tech-doc/modules/orderly_network_hooks#chains)\<`undefined`, `undefined`>, [`UseChainsReturnObject`](/sdks/tech-doc/modules/orderly_network_hooks#usechainsreturnobject)]
#### Defined in
[packages/hooks/src/orderly/useChains.ts:46](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useChains.ts#L46)
▸ **useChains**\<`T`, `K`>(`networkId?`, `options?`): \[[`Chains`](/sdks/tech-doc/modules/orderly_network_hooks#chains)\<`T`, `K` extends [`UseChainsOptions`](/sdks/tech-doc/modules/orderly_network_hooks#usechainsoptions) ? `K`\[`"pick"`] extends keyof [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain) ? `K`\[`"pick"`] : `undefined` : `undefined`>, [`UseChainsReturnObject`](/sdks/tech-doc/modules/orderly_network_hooks#usechainsreturnobject)]
#### Type parameters
| Name | Type |
| :--- | :--------------------------------------------------------------------------------------------------------- |
| `T` | extends `undefined` \| [`NetworkId`](/sdks/tech-doc/modules/orderly_network_types#networkid) |
| `K` | extends `undefined` \| [`UseChainsOptions`](/sdks/tech-doc/modules/orderly_network_hooks#usechainsoptions) |
#### Parameters
| Name | Type |
| :----------- | :--- |
| `networkId?` | `T` |
| `options?` | `K` |
#### Returns
\[[`Chains`](/sdks/tech-doc/modules/orderly_network_hooks#chains)\<`T`, `K` extends [`UseChainsOptions`](/sdks/tech-doc/modules/orderly_network_hooks#usechainsoptions) ? `K`\[`"pick"`] extends keyof [`Chain`](/sdks/tech-doc/interfaces/orderly_network_types.API.Chain) ? `K`\[`"pick"`] : `undefined` : `undefined`>, [`UseChainsReturnObject`](/sdks/tech-doc/modules/orderly_network_hooks#usechainsreturnobject)]
#### Defined in
[packages/hooks/src/orderly/useChains.ts:51](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useChains.ts#L51)
***
### useCheckReferralCode
▸ **useCheckReferralCode**(`code?`): `Object`
#### Parameters
| Name | Type |
| :------ | :------- |
| `code?` | `string` |
#### Returns
`Object`
| Name | Type |
| :---------- | :-------- |
| `error` | `any` |
| `isExist?` | `boolean` |
| `isLoading` | `boolean` |
#### Defined in
[packages/hooks/src/referral/useCheckReferralCode.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useCheckReferralCode.ts#L4)
***
### useCollateral
▸ **useCollateral**(`options?`): [`CollateralOutputs`](/sdks/tech-doc/modules/orderly_network_hooks#collateraloutputs)
#### Parameters
| Name | Type | Description |
| :----------- | :------- | :---------------- |
| `options` | `Object` | - |
| `options.dp` | `number` | decimal precision |
#### Returns
[`CollateralOutputs`](/sdks/tech-doc/modules/orderly_network_hooks#collateraloutputs)
#### Defined in
[packages/hooks/src/orderly/useCollateral.ts:30](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useCollateral.ts#L30)
***
### useCommission
▸ **useCommission**(`options?`): `any`\[]
#### Parameters
| Name | Type |
| :-------------- | :------- |
| `options?` | `Object` |
| `options.size?` | `number` |
#### Returns
`any`\[]
#### Defined in
[packages/hooks/src/referral/useCommission.ts:5](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useCommission.ts#L5)
***
### useConfig
▸ **useConfig**(): [`ConfigStore`](/sdks/tech-doc/interfaces/orderly_network_core.ConfigStore)
#### Returns
[`ConfigStore`](/sdks/tech-doc/interfaces/orderly_network_core.ConfigStore)
#### Defined in
[packages/hooks/src/useConfig.ts:5](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useConfig.ts#L5)
▸ **useConfig**\<`T`>(`key`, `defaultValue?`): `T`
#### Type parameters
| Name | Type |
| :--- | :------- |
| `T` | `string` |
#### Parameters
| Name | Type |
| :-------------- | :------------------------------------------------------------------- |
| `key` | [`ConfigKey`](/sdks/tech-doc/modules/orderly_network_core#configkey) |
| `defaultValue?` | `T` |
#### Returns
`T`
#### Defined in
[packages/hooks/src/useConfig.ts:6](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useConfig.ts#L6)
***
### useConstant
▸ **useConstant**\<`T`>(`fn`): `T`
#### Type parameters
| Name |
| :--- |
| `T` |
#### Parameters
| Name | Type |
| :--- | :-------- |
| `fn` | () => `T` |
#### Returns
`T`
#### Defined in
node\_modules/.pnpm/use-[constant@1.1.1\_react](mailto:constant@1.1.1_react)@18.2.0/node\_modules/use-constant/types/index.d.ts:1
***
### useDaily
▸ **useDaily**(`options?`): `Object`
#### Parameters
| Name | Type |
| :------------------- | :------- |
| `options?` | `Object` |
| `options.endDate?` | `Date` |
| `options.startDate?` | `Date` |
#### Returns
`Object`
| Name | Type |
| :------- | :--------------------------------------------------------------------------------------- |
| `data?` | [`DayliVolume`](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#daylivolume)\[] |
| `mutate` | `any` |
#### Defined in
[packages/hooks/src/referral/useDaily.ts:5](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useDaily.ts#L5)
***
### useDebounce
▸ **useDebounce**\<`T`>(`value`, `delay`, `options?`): \[`T`, [`DebouncedState`](/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState)\<(`value`: `T`) => `void`>]
#### Type parameters
| Name |
| :--- |
| `T` |
#### Parameters
| Name | Type |
| :-------------------- | :--------------------------------------- |
| `value` | `T` |
| `delay` | `number` |
| `options?` | `Object` |
| `options.equalityFn?` | (`left`: `T`, `right`: `T`) => `boolean` |
| `options.leading?` | `boolean` |
| `options.maxWait?` | `number` |
| `options.trailing?` | `boolean` |
#### Returns
\[`T`, [`DebouncedState`](/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState)\<(`value`: `T`) => `void`>]
#### Defined in
node\_modules/.pnpm/use-[debounce@9.0.4\_react](mailto:debounce@9.0.4_react)@18.2.0/node\_modules/use-debounce/dist/useDebounce.d.ts:2
***
### useDeposit
▸ **useDeposit**(`options?`): `Object`
#### Parameters
| Name | Type |
| :--------- | :------------------ |
| `options?` | `useDepositOptions` |
#### Returns
`Object`
| Name | Type |
| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowance` | `string` |
| `allowanceRevalidating` | `boolean` |
| `approve` | (`amount?`: `string`) => `Promise`\<`undefined` \| `void`> |
| `balance` | `string` |
| `balanceRevalidating` | `boolean` |
| `deposit` | () => `Promise`\<`any`> |
| `depositFee` | `bigint` |
| `depositFeeRevalidating` | `boolean` |
| `dst` | \{ `address`: `undefined` \| `string` = USDC.address; `chainId`: `number` = targetChain.network\_infos.chain\_id; `decimals`: `undefined` \| `number` = USDC.decimals; `network`: `string` = targetChain.network\_infos.shortName; `symbol`: `string` = "USDC" } |
| `dst.address` | `undefined` \| `string` |
| `dst.chainId` | `number` |
| `dst.decimals` | `undefined` \| `number` |
| `dst.network` | `string` |
| `dst.symbol` | `string` |
| `fetchBalance` | (`address`: `string`, `decimals?`: `number`) => `Promise`\<`string`> |
| `fetchBalances` | (`tokens`: [`TokenInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.TokenInfo)\[]) => `Promise`\<`void`> |
| `isNativeToken` | `boolean` |
| `quantity` | `string` |
| `setQuantity` | `Dispatch`\<`SetStateAction`\<`string`>> |
#### Defined in
[packages/hooks/src/orderly/useDeposit.ts:27](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useDeposit.ts#L27)
***
### useDistribution
▸ **useDistribution**(`params`): `any`
#### Parameters
| Name | Type |
| :------- | :------- |
| `params` | `Params` |
#### Returns
`any`
#### Defined in
[packages/hooks/src/referral/useDistribution.ts:17](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useDistribution.ts#L17)
***
### useEventEmitter
▸ **useEventEmitter**(): [`EventEmitter`](/sdks/tech-doc/classes/orderly_network_core.EventEmitter-1)\<`string` | `symbol`, `any`>
#### Returns
[`EventEmitter`](/sdks/tech-doc/classes/orderly_network_core.EventEmitter-1)\<`string` | `symbol`, `any`>
#### Defined in
[packages/hooks/src/useEventEmitter.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useEventEmitter.ts#L4)
***
### useFundingRate
▸ **useFundingRate**(`symbol`): `Object`
#### Parameters
| Name | Type |
| :------- | :------- |
| `symbol` | `string` |
#### Returns
`Object`
| Name | Type |
| :----------------------------- | :------- |
| `countDown` | `string` |
| `est_funding_rate` | `string` |
| `est_funding_rate_timestamp?` | `number` |
| `last_funding_rate?` | `number` |
| `last_funding_rate_timestamp?` | `number` |
| `next_funding_time?` | `number` |
| `sum_unitary_funding?` | `number` |
| `symbol?` | `string` |
#### Defined in
[packages/hooks/src/orderly/useFundingRate.ts:6](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useFundingRate.ts#L6)
***
### useGetReferralCode
▸ **useGetReferralCode**(`accountId?`): `Object`
#### Parameters
| Name | Type |
| :----------- | :------- |
| `accountId?` | `string` |
#### Returns
`Object`
| Name | Type |
| :--------------- | :-------- |
| `error` | `any` |
| `isLoading` | `boolean` |
| `referral_code?` | `string` |
#### Defined in
[packages/hooks/src/referral/useGetReferralCode.ts:3](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useGetReferralCode.ts#L3)
***
### useHoldingStream
▸ **useHoldingStream**(): `Object`
#### Returns
`Object`
| Name | Type |
| :---------- | :----------------------------------------------------------------------------------------- |
| `data` | `undefined` \| [`Holding`](/sdks/tech-doc/interfaces/orderly_network_types.API.Holding)\[] |
| `isLoading` | `boolean` |
| `usdc` | `undefined` \| [`Holding`](/sdks/tech-doc/interfaces/orderly_network_types.API.Holding) |
#### Defined in
[packages/hooks/src/orderly/useHoldingStream.ts:7](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useHoldingStream.ts#L7)
***
### useIndexPrice
▸ **useIndexPrice**(`symbol`): `SWRSubscriptionResponse`\<`any`, `any`>
#### Parameters
| Name | Type |
| :------- | :------- |
| `symbol` | `string` |
#### Returns
`SWRSubscriptionResponse`\<`any`, `any`>
#### Defined in
[packages/hooks/src/orderly/useIndexPrice.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useIndexPrice.ts#L4)
***
### useLazyQuery
▸ **useLazyQuery**\<`T`, `R`>(`query`, `options?`): `SWRMutationResponse`\<`any`, `any`, `Key`, `never`>
useQuery
#### Type parameters
| Name | Type |
| :--- | :---- |
| `T` | `T` |
| `R` | `any` |
#### Parameters
| Name | Type |
| :--------- | :------------------------------------------------------------------------------------------------------------- |
| `query` | `Key` |
| `options?` | `SWRMutationConfiguration`\<`any`, `any`> & \{ `formatter?`: (`data`: `any`) => `R` ; `init?`: `RequestInit` } |
#### Returns
`SWRMutationResponse`\<`any`, `any`, `Key`, `never`>
**`Description`**
for public api
#### Defined in
[packages/hooks/src/useLazyQuery.ts:15](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useLazyQuery.ts#L15)
***
### useLeverage
▸ **useLeverage**(): `any`
#### Returns
`any`
#### Defined in
[packages/hooks/src/orderly/useLeverage.ts:7](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useLeverage.ts#L7)
***
### useLocalStorage
▸ **useLocalStorage**\<`T`>(`key`, `initialValue`): \[`any`, (`value`: `T`) => `void`]
#### Type parameters
| Name |
| :--- |
| `T` |
#### Parameters
| Name | Type |
| :------------- | :------- |
| `key` | `string` |
| `initialValue` | `T` |
#### Returns
\[`any`, (`value`: `T`) => `void`]
#### Defined in
[packages/hooks/src/useLocalStorage.ts:5](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useLocalStorage.ts#L5)
***
### useMarginRatio
▸ **useMarginRatio**(): `MarginRatioReturn`
#### Returns
`MarginRatioReturn`
#### Defined in
[packages/hooks/src/orderly/useMarginRatio.ts:17](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useMarginRatio.ts#L17)
***
### useMarkPrice
▸ **useMarkPrice**(`symbol`): `Object`
#### Parameters
| Name | Type |
| :------- | :------- |
| `symbol` | `string` |
#### Returns
`Object`
| Name | Type |
| :----- | :------- |
| `data` | `number` |
#### Defined in
[packages/hooks/src/orderly/useMarkPrice.ts:5](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useMarkPrice.ts#L5)
***
### useMarkPricesStream
▸ **useMarkPricesStream**(): `SWRSubscriptionResponse`\<`Record`\<`string`, `number`>, `any`>
#### Returns
`SWRSubscriptionResponse`\<`Record`\<`string`, `number`>, `any`>
#### Defined in
[packages/hooks/src/orderly/useMarkPricesStream.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useMarkPricesStream.ts#L4)
***
### useMarketTradeStream
▸ **useMarketTradeStream**(`symbol`, `options?`): `Object`
#### Parameters
| Name | Type |
| :-------- | :------------------------- |
| `symbol` | `string` |
| `options` | `MarketTradeStreamOptions` |
#### Returns
`Object`
| Name | Type |
| :---------- | :---------------------------------------------------------------------- |
| `data` | [`Trade`](/sdks/tech-doc/interfaces/orderly_network_types.API.Trade)\[] |
| `isLoading` | `boolean` |
#### Defined in
[packages/hooks/src/orderly/useMarketTradeStream.ts:9](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useMarketTradeStream.ts#L9)
***
### useMarkets
▸ **useMarkets**(`type`): readonly \[[`Ticker`](/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.Ticker)\[], \{ `addToHistory`: (`symbol`: [`MarketInfoExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfoExt)) => `void` ; `favoriteTabs`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[] = tabs; `favorites`: \{ `name`: `string` ; `tabs`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[] = favTabs }\[] ; `getLastSelFavTab`: () => [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab) ; `pinToTop`: (`symbol`: [`MarketInfoExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfoExt)) => `void` ; `recent`: [`Recent`](/sdks/tech-doc/interfaces/orderly_network_hooks.Recent)\[] ; `updateFavoriteTabs`: (`tab`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab) | [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[], `operator?`: \{ `add?`: `boolean` ; `delete?`: `boolean` ; `update?`: `boolean` }) => `void` ; `updateSelectedFavoriteTab`: (`tab`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)) => `void` ; `updateSymbolFavoriteState`: (`symbol`: [`MarketInfoExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfoExt), `tab`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab) | [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[], `del`: `boolean`) => `void` }]
#### Parameters
| Name | Type |
| :----- | :---------------------------------------------------------------------- |
| `type` | [`MarketsType`](/sdks/tech-doc/enums/orderly_network_hooks.MarketsType) |
#### Returns
readonly \[[`Ticker`](/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.Ticker)\[], \{ `addToHistory`: (`symbol`: [`MarketInfoExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfoExt)) => `void` ; `favoriteTabs`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[] = tabs; `favorites`: \{ `name`: `string` ; `tabs`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[] = favTabs }\[] ; `getLastSelFavTab`: () => [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab) ; `pinToTop`: (`symbol`: [`MarketInfoExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfoExt)) => `void` ; `recent`: [`Recent`](/sdks/tech-doc/interfaces/orderly_network_hooks.Recent)\[] ; `updateFavoriteTabs`: (`tab`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab) | [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[], `operator?`: \{ `add?`: `boolean` ; `delete?`: `boolean` ; `update?`: `boolean` }) => `void` ; `updateSelectedFavoriteTab`: (`tab`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)) => `void` ; `updateSymbolFavoriteState`: (`symbol`: [`MarketInfoExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfoExt), `tab`: [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab) | [`FavoriteTab`](/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab)\[], `del`: `boolean`) => `void` }]
#### Defined in
[packages/hooks/src/orderly/useMarkets.ts:49](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useMarkets.ts#L49)
***
### useMarketsStream
▸ **useMarketsStream**(): `Object`
#### Returns
`Object`
| Name | Type |
| :----- | :---------------------------------------------------------------------------------------- |
| `data` | `null` \| [`Ticker`](/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.Ticker)\[] |
#### Defined in
[packages/hooks/src/orderly/useMarketsStream.ts:8](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useMarketsStream.ts#L8)
***
### useMaxQty
▸ **useMaxQty**(`symbol`, `side`, `reduceOnly?`): `number`
#### Parameters
| Name | Type | Default value |
| :----------- | :------------------------------------------------------------------ | :------------ |
| `symbol` | `string` | `undefined` |
| `side` | [`OrderSide`](/sdks/tech-doc/enums/orderly_network_types.OrderSide) | `undefined` |
| `reduceOnly` | `boolean` | `false` |
#### Returns
`number`
the maximum quantity available for trading in USD
#### Defined in
[packages/hooks/src/orderly/useMaxQty.ts:23](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useMaxQty.ts#L23)
***
### useMediaQuery
▸ **useMediaQuery**(`query`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------- |
| `query` | `string` |
#### Returns
`boolean`
#### Defined in
[packages/hooks/src/useMediaQuery.ts:3](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useMediaQuery.ts#L3)
***
### useMutation
▸ **useMutation**\<`T`, `E`>(`url`, `method?`, `options?`): readonly \[(`data`: `null` | `Record`\<`string`, `any`>, `params?`: `Record`\<`string`, `any`>, `options?`: `SWRMutationConfiguration`\<`T`, `E`>) => `Promise`\<`any`>, \{ `data`: `any` ; `error`: `undefined` | `E` ; `isMutating`: `boolean` ; `reset`: () => `void` }]
This hook is used to execute API requests for data mutation, such as POST, DELETE, PUT, etc.
#### Type parameters
| Name |
| :--- |
| `T` |
| `E` |
#### Parameters
| Name | Type | Default value | Description |
| :--------- | :------------------------------------ | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | `string` | `undefined` | The URL to send the request to. If the URL does not start with "http", it will be prefixed with the API base URL. |
| `method` | `HTTP_METHOD` | `"POST"` | The HTTP method to use for the request. Defaults to "POST". |
| `options?` | `SWRMutationConfiguration`\<`T`, `E`> | `undefined` | The configuration object for the mutation. **`See`** [useSWRMutation](https://swr.vercel.app/docs/mutation#api) **`Link`** [https://swr.vercel.app/docs/mutation#api](https://swr.vercel.app/docs/mutation#api) |
#### Returns
readonly \[(`data`: `null` | `Record`\<`string`, `any`>, `params?`: `Record`\<`string`, `any`>, `options?`: `SWRMutationConfiguration`\<`T`, `E`>) => `Promise`\<`any`>, \{ `data`: `any` ; `error`: `undefined` | `E` ; `isMutating`: `boolean` ; `reset`: () => `void` }]
#### Defined in
[packages/hooks/src/useMutation.ts:53](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useMutation.ts#L53)
***
### useOrderEntry
▸ **useOrderEntry**(`order`, `options?`): `UseOrderEntryReturn`
Create Order
#### Parameters
| Name | Type |
| :--------- | :------------------------------------------------------------------------ |
| `order` | [`OrderParams`](/sdks/tech-doc/modules/orderly_network_hooks#orderparams) |
| `options?` | `UseOrderEntryOptions` |
#### Returns
`UseOrderEntryReturn`
**`Example`**
```tsx theme={null}
import { useOrderEntry } from "@orderly.network/hooks";
import { OrderSide, OrderType } from "@orderly.network/types";
const { formattedOrder, onSubmit, helper } = useOrderEntry(
{
symbol: "PERP_ETH_USDC",
side: OrderSide.BUY,
order_type: OrderType.LIMIT,
order_price: 10000,
order_quantity: 1
},
{
// **Note:** it's required
watchOrderbook: true
}
);
```
#### Defined in
[packages/hooks/src/orderly/useOrderEntry.ts:98](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderEntry.ts#L98)
▸ **useOrderEntry**(`symbol`, `side`, `reduceOnly`): `UseOrderEntryReturn`
#### Parameters
| Name | Type |
| :----------- | :------------------------------------------------------------------ |
| `symbol` | `string` |
| `side` | [`OrderSide`](/sdks/tech-doc/enums/orderly_network_types.OrderSide) |
| `reduceOnly` | `boolean` |
#### Returns
`UseOrderEntryReturn`
**`Deprecated`**
#### Defined in
[packages/hooks/src/orderly/useOrderEntry.ts:105](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderEntry.ts#L105)
***
### useOrderStream
▸ **useOrderStream**(`params`, `options?`): readonly \[`null` | `any`\[], \{ `cancelAlgoOrder`: (`orderId`: `number`, `symbol?`: `string`) => `Promise`\<`any`> ; `cancelAlgoOrdersByTypes`: (`types`: [`AlgoOrderRootType`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType)\[]) => `Promise`\<`any`\[]> ; `cancelAllOrders`: () => `Promise`\<\[`any`, `any`]> ; `cancelAllTPSLOrders`: () => `Promise`\<`any`\[]> ; `cancelOrder`: (`orderId`: `number`, `symbol?`: `string`) => `Promise`\<`any`> ; `cancelTPSLChildOrder`: (`orderId`: `number`, `rootAlgoOrderId`: `number`) => `Promise`\<`any`> ; `errors`: \{ `cancelAlgoOrder`: `unknown` = cancelAlgoOrderError; `cancelOrder`: `unknown` = cancelOrderError; `updateAlgoOrder`: `unknown` = updateAlgoOrderError; `updateOrder`: `unknown` = updateOrderError } ; `isLoading`: `boolean` = ordersResponse.isLoading; `loadMore`: () => `void` ; `refresh`: `KeyedMutator`\<`any`\[]> = ordersResponse.mutate; `submitting`: \{ `cancelAlgoOrder`: `boolean` = cancelAlgoMutating; `cancelOrder`: `boolean` = cancelMutating; `updateAlglOrder`: `boolean` = updateAlgoMutating; `updateOrder`: `boolean` = updateMutating } ; `total`: `number` ; `updateAlgoOrder`: (`orderId`: `string`, `order`: [`OrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.OrderEntity)) => `Promise`\<`any`> ; `updateOrder`: (`orderId`: `string`, `order`: [`OrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.OrderEntity)) => `Promise`\<`any`> ; `updateTPSLOrder`: (`orderId`: `number`, `childOrders`: [`AlgoOrder`](/sdks/tech-doc/interfaces/orderly_network_types.API.AlgoOrder)\[]) => `Promise`\<`any`> }]
#### Parameters
| Name | Type | Description |
| :----------------------- | :---------------------------------------------------------------------- | :------------------------------------------------- |
| `params` | `Object` | Orders query params |
| `params.excludes?` | `CombineOrderType`\[] | Exclude the order type **`Default`** `ts [] ` |
| `params.includes?` | `CombineOrderType`\[] | Include the order type **`Default`** `ts ["ALL"] ` |
| `params.side?` | [`OrderSide`](/sdks/tech-doc/enums/orderly_network_types.OrderSide) | - |
| `params.size?` | `number` | - |
| `params.status?` | [`OrderStatus`](/sdks/tech-doc/enums/orderly_network_types.OrderStatus) | - |
| `params.symbol?` | `string` | - |
| `options?` | `Object` | - |
| `options.keeplive?` | `boolean` | Keep the state update alive |
| `options.stopOnUnmount?` | `boolean` | Stop the state update when the component unmount |
#### Returns
readonly \[`null` | `any`\[], \{ `cancelAlgoOrder`: (`orderId`: `number`, `symbol?`: `string`) => `Promise`\<`any`> ; `cancelAlgoOrdersByTypes`: (`types`: [`AlgoOrderRootType`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType)\[]) => `Promise`\<`any`\[]> ; `cancelAllOrders`: () => `Promise`\<\[`any`, `any`]> ; `cancelAllTPSLOrders`: () => `Promise`\<`any`\[]> ; `cancelOrder`: (`orderId`: `number`, `symbol?`: `string`) => `Promise`\<`any`> ; `cancelTPSLChildOrder`: (`orderId`: `number`, `rootAlgoOrderId`: `number`) => `Promise`\<`any`> ; `errors`: \{ `cancelAlgoOrder`: `unknown` = cancelAlgoOrderError; `cancelOrder`: `unknown` = cancelOrderError; `updateAlgoOrder`: `unknown` = updateAlgoOrderError; `updateOrder`: `unknown` = updateOrderError } ; `isLoading`: `boolean` = ordersResponse.isLoading; `loadMore`: () => `void` ; `refresh`: `KeyedMutator`\<`any`\[]> = ordersResponse.mutate; `submitting`: \{ `cancelAlgoOrder`: `boolean` = cancelAlgoMutating; `cancelOrder`: `boolean` = cancelMutating; `updateAlglOrder`: `boolean` = updateAlgoMutating; `updateOrder`: `boolean` = updateMutating } ; `total`: `number` ; `updateAlgoOrder`: (`orderId`: `string`, `order`: [`OrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.OrderEntity)) => `Promise`\<`any`> ; `updateOrder`: (`orderId`: `string`, `order`: [`OrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.OrderEntity)) => `Promise`\<`any`> ; `updateTPSLOrder`: (`orderId`: `number`, `childOrders`: [`AlgoOrder`](/sdks/tech-doc/interfaces/orderly_network_types.API.AlgoOrder)\[]) => `Promise`\<`any`> }]
#### Defined in
[packages/hooks/src/orderly/useOrderStream/useOrderStream.ts:23](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderStream/useOrderStream.ts#L23)
***
### useOrderbookStream
▸ **useOrderbookStream**(`symbol`, `initial?`, `options?`): (\{ `allDepths?`: `undefined` = depths; `asks`: [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)\[] ; `bids`: [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)\[] ; `depth`: `undefined` ; `isLoading`: `undefined` ; `markPrice`: `number` = markPrice; `middlePrice`: `number`\[] ; `onDepthChange`: `undefined` ; `onItemClick`: `undefined` } | \{ `allDepths`: `any`\[] = depths; `asks?`: `undefined` ; `bids?`: `undefined` ; `depth`: `undefined` | `number` ; `isLoading`: `boolean` ; `markPrice?`: `undefined` = markPrice; `middlePrice?`: `undefined` ; `onDepthChange`: (`depth`: `number`) => `void` ; `onItemClick`: (`item`: [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)) => `void` })\[]
#### Parameters
| Name | Type | Default value |
| :--------- | :---------------------------------------------------------------------------------- | :------------ |
| `symbol` | `string` | `undefined` |
| `initial` | [`OrderbookData`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookdata) | `INIT_DATA` |
| `options?` | [`OrderbookOptions`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookoptions) | `undefined` |
#### Returns
(\{ `allDepths?`: `undefined` = depths; `asks`: [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)\[] ; `bids`: [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)\[] ; `depth`: `undefined` ; `isLoading`: `undefined` ; `markPrice`: `number` = markPrice; `middlePrice`: `number`\[] ; `onDepthChange`: `undefined` ; `onItemClick`: `undefined` } | \{ `allDepths`: `any`\[] = depths; `asks?`: `undefined` ; `bids?`: `undefined` ; `depth`: `undefined` | `number` ; `isLoading`: `boolean` ; `markPrice?`: `undefined` = markPrice; `middlePrice?`: `undefined` ; `onDepthChange`: (`depth`: `number`) => `void` ; `onItemClick`: (`item`: [`OrderBookItem`](/sdks/tech-doc/modules/orderly_network_hooks#orderbookitem)) => `void` })\[]
**`Name`**
useOrderbookStream
**`Description`**
React hook that returns the current orderbook for a given market
#### Defined in
[packages/hooks/src/orderly/useOrderbookStream.ts:235](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useOrderbookStream.ts#L235)
***
### usePositionStream
▸ **usePositionStream**(`symbol?`, `options?`): readonly \[\{ `aggregated`: `any` ; `rows`: `null` | [`PositionTPSLExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionTPSLExt)\[] = positionsRows; `totalCollateral`: `Decimal` ; `totalUnrealizedROI`: `number` ; `totalValue`: `Decimal` }, \{ `current_margin_ratio_with_orders`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `free_collateral`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `initial_margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `initial_margin_ratio_with_orders`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `maintenance_margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `maintenance_margin_ratio_with_orders`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `open_margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `total_collateral_value`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `total_pnl_24_h`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` } & \{ `isNil`: `boolean` }, \{ `error`: `any` ; `loading`: `false` = false; `refresh`: `KeyedMutator`\<[`PositionInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionInfo)> = refreshPositions }]
#### Parameters
| Name | Type | Description |
| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- |
| `symbol?` | `string` | If symbol is passed, only the position of that symbol will be returned. |
| `options?` | `Partial`\<`PublicConfiguration`\<`any`, `any`, `BareFetcher`\<`any`>>> & \{ `calcMode?`: `PriceMode` ; `includedPendingOrder?`: `boolean` } | - |
#### Returns
readonly \[\{ `aggregated`: `any` ; `rows`: `null` | [`PositionTPSLExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionTPSLExt)\[] = positionsRows; `totalCollateral`: `Decimal` ; `totalUnrealizedROI`: `number` ; `totalValue`: `Decimal` }, \{ `current_margin_ratio_with_orders`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `free_collateral`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `initial_margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `initial_margin_ratio_with_orders`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `maintenance_margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `maintenance_margin_ratio_with_orders`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `open_margin_ratio`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `total_collateral_value`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` ; `total_pnl_24_h`: (`key?`: `"margin_ratio"` | `"initial_margin_ratio"` | `"maintenance_margin_ratio"` | `"open_margin_ratio"` | `"current_margin_ratio_with_orders"` | `"initial_margin_ratio_with_orders"` | `"maintenance_margin_ratio_with_orders"` | `"total_collateral_value"` | `"free_collateral"` | `"total_pnl_24_h"`, `defaultValue?`: `number`) => `any` } & \{ `isNil`: `boolean` }, \{ `error`: `any` ; `loading`: `false` = false; `refresh`: `KeyedMutator`\<[`PositionInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionInfo)> = refreshPositions }]
#### Defined in
[packages/hooks/src/orderly/usePositionStream/usePositionStream.ts:37](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/usePositionStream/usePositionStream.ts#L37)
***
### usePoster
▸ **usePoster**(`data`, `options?`): `Object`
Generates a poster image based on position information. You can set the size, background color, font color, font size, and content position of the poster.
#### Parameters
| Name | Type | Description |
| :--------------- | :------------------------------------------------------------------------ | :----------------------------- |
| `data` | [`DrawOptions`](/sdks/tech-doc/modules/orderly_network_hooks#drawoptions) | The options to draw the poster |
| `options?` | `Object` | - |
| `options.ratio?` | `number` | The ratio of the poster |
#### Returns
`Object`
| Name | Type |
| :---------- | :------------------------------------------------------------------------------- |
| `canCopy` | `boolean` |
| `copy` | () => `Promise`\<`void`> |
| `download` | (`filename`: `string`, `type`: `string`, `encoderOptions?`: `number`) => `void` |
| `error` | `null` \| `Error` |
| `ref` | (`ref`: `null` \| `HTMLCanvasElement`) => `void` |
| `toBlob` | (`type?`: `string`, `encoderOptions?`: `number`) => `Promise`\<`null` \| `Blob`> |
| `toDataURL` | (`type?`: `string`, `encoderOptions?`: `number`) => `string` |
**`Example`**
```tsx theme={null}
const { ref, toDataURL, toBlob, download, copy } = usePoster({
backgroundColor: "#0b8c70",
backgroundImg: "/images/poster_bg.png",
color: "rgba(255, 255, 255, 0.98)",
profitColor: "rgb(0,181,159)"
// ...
});
```
#### Defined in
[packages/hooks/src/usePoster.ts:21](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/usePoster.ts#L21)
***
### usePreLoadData
▸ **usePreLoadData**(): `Object`
#### Returns
`Object`
| Name | Type |
| :------ | :-------- |
| `done` | `boolean` |
| `error` | `any` |
#### Defined in
[packages/hooks/src/usePreloadData.ts:6](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/usePreloadData.ts#L6)
***
### usePrivateDataObserver
▸ **usePrivateDataObserver**(`options`): `void`
#### Parameters
| Name | Type |
| :------------------- | :------------------------------------------------------- |
| `options` | `Object` |
| `options.getKeysMap` | (`type`: `string`) => `Map`\<`string`, `getKeyFunction`> |
#### Returns
`void`
#### Defined in
[packages/hooks/src/orderly/usePrivateDataObserver.ts:14](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/usePrivateDataObserver.ts#L14)
***
### usePrivateInfiniteQuery
▸ **usePrivateInfiniteQuery**(`getKey`, `options?`): `SWRInfiniteResponse`\<`any`, `any`>
#### Parameters
| Name | Type |
| :--------- | :------------------------------------------------------------------------------------------------------------- |
| `getKey` | `SWRInfiniteKeyLoader` |
| `options?` | `SWRInfiniteConfiguration`\<`any`, `any`, `BareFetcher`\<`any`>> & \{ `formatter?`: (`data`: `any`) => `any` } |
#### Returns
`SWRInfiniteResponse`\<`any`, `any`>
#### Defined in
[packages/hooks/src/usePrivateInfiniteQuery.ts:10](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/usePrivateInfiniteQuery.ts#L10)
***
### usePrivateQuery
▸ **usePrivateQuery**\<`T`>(`query`, `options?`): `SWRResponse`\<`T`, `any`, `any`>
usePrivateQuery
#### Type parameters
| Name |
| :--- |
| `T` |
#### Parameters
| Name | Type |
| :--------- | :---------------------- |
| `query` | `string` |
| `options?` | `useQueryOptions`\<`T`> |
#### Returns
`SWRResponse`\<`T`, `any`, `any`>
**`Description`**
for private api
#### Defined in
[packages/hooks/src/usePrivateQuery.ts:13](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/usePrivateQuery.ts#L13)
***
### useQuery
▸ **useQuery**\<`T`>(`query`, `options?`): `SWRResponse`\<`T`, `any`, `any`>
useQuery
#### Type parameters
| Name |
| :--- |
| `T` |
#### Parameters
| Name | Type |
| :--------- | :---------------------- |
| `query` | `Key` |
| `options?` | `useQueryOptions`\<`T`> |
#### Returns
`SWRResponse`\<`T`, `any`, `any`>
**`Description`**
for public api
#### Defined in
[packages/hooks/src/useQuery.ts:11](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useQuery.ts#L11)
***
### useRefereeHistory
▸ **useRefereeHistory**(`params`): `any`\[]
#### Parameters
| Name | Type |
| :------- | :------- |
| `params` | `Params` |
#### Returns
`any`\[]
#### Defined in
[packages/hooks/src/referral/useRefereeHistory.ts:16](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useRefereeHistory.ts#L16)
***
### useRefereeInfo
▸ **useRefereeInfo**(`params`): `any`\[]
#### Parameters
| Name | Type |
| :------- | :------- |
| `params` | `Params` |
#### Returns
`any`\[]
#### Defined in
[packages/hooks/src/referral/useRefereeInfo.ts:17](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useRefereeInfo.ts#L17)
***
### useRefereeRebateSummary
▸ **useRefereeRebateSummary**(`params`): `Object`
#### Parameters
| Name | Type |
| :------- | :------- |
| `params` | `Params` |
#### Returns
`Object`
| Name | Type |
| :---------- | :--------------------------------------------------------------------------------------------------------- |
| `data?` | [`RefereeRebateSummary`](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#refereerebatesummary)\[] |
| `isLoading` | `boolean` |
| `mutate` | `any` |
#### Defined in
[packages/hooks/src/referral/useRefereeRebateSummary.ts:10](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useRefereeRebateSummary.ts#L10)
***
### useReferralInfo
▸ **useReferralInfo**(): `Object`
#### Returns
`Object`
| Name | Type |
| :---------------- | :----------------------------------------------------------------------------------------------------------- |
| `data?` | [`ReferralInfo`](/sdks/tech-doc/interfaces/orderly_network_hooks.RefferalAPI.ReferralInfo) |
| `error` | `any` |
| `getFirstRefCode` | () => `undefined` \| [`ReferralCode`](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#referralcode) |
| `isAffiliate?` | `boolean` |
| `isLoading` | `boolean` |
| `isTrader?` | `boolean` |
#### Defined in
[packages/hooks/src/referral/useReferralInfo.tsx:7](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useReferralInfo.tsx#L7)
***
### useReferralRebateSummary
▸ **useReferralRebateSummary**(`params`): `any`\[]
#### Parameters
| Name | Type |
| :------- | :------- |
| `params` | `Params` |
#### Returns
`any`\[]
#### Defined in
[packages/hooks/src/referral/useReferralRebateSummary.ts:17](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/useReferralRebateSummary.ts#L17)
***
### useSWR
▸ **useSWR**\<`Data`, `Error`, `SWRKey`>(`key`): `SWRResponse`\<`Data`, `Error`, `any`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :------- | :-------------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `SWRKey` | extends `Key` = `StrictKey` |
#### Parameters
| Name | Type |
| :---- | :------- |
| `key` | `SWRKey` |
#### Returns
`SWRResponse`\<`Data`, `Error`, `any`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:199
▸ **useSWR**\<`Data`, `Error`, `SWRKey`>(`key`, `fetcher`): `SWRResponse`\<`Data`, `Error`, `any`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :------- | :-------------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `SWRKey` | extends `Key` = `StrictKey` |
#### Parameters
| Name | Type |
| :-------- | :------------------------------------- |
| `key` | `SWRKey` |
| `fetcher` | `null` \| `Fetcher`\<`Data`, `SWRKey`> |
#### Returns
`SWRResponse`\<`Data`, `Error`, `any`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:200
▸ **useSWR**\<`Data`, `Error`, `SWRKey`>(`key`, `fetcher`): `SWRResponse`\<`Data`, `Error`, `any`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :------- | :-------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `SWRKey` | extends `Key` = `Key` |
#### Parameters
| Name | Type |
| :-------- | :------------------------------------- |
| `key` | `SWRKey` |
| `fetcher` | `null` \| `Fetcher`\<`Data`, `SWRKey`> |
#### Returns
`SWRResponse`\<`Data`, `Error`, `any`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:201
▸ **useSWR**\<`Data`, `Error`, `SWRKey`, `SWROptions`>(`key`, `config`): `SWRResponse`\<`Data`, `Error`, `SWROptions`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `SWRKey` | extends `Key` = `StrictKey` |
| `SWROptions` | extends `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `Fetcher`\<`Data`, `SWRKey`>>> = `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `Fetcher`\<`Data`, `SWRKey`>>> |
#### Parameters
| Name | Type |
| :------- | :----------- |
| `key` | `SWRKey` |
| `config` | `SWROptions` |
#### Returns
`SWRResponse`\<`Data`, `Error`, `SWROptions`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:202
▸ **useSWR**\<`Data`, `Error`, `SWRKey`, `SWROptions`>(`key`, `fetcher`, `config`): `SWRResponse`\<`Data`, `Error`, `SWROptions`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `SWRKey` | extends `Key` = `StrictKey` |
| `SWROptions` | extends `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `Fetcher`\<`Data`, `SWRKey`>>> = `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `Fetcher`\<`Data`, `SWRKey`>>> |
#### Parameters
| Name | Type |
| :-------- | :------------------------------------- |
| `key` | `SWRKey` |
| `fetcher` | `null` \| `Fetcher`\<`Data`, `SWRKey`> |
| `config` | `SWROptions` |
#### Returns
`SWRResponse`\<`Data`, `Error`, `SWROptions`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:203
▸ **useSWR**\<`Data`, `Error`>(`key`): `SWRResponse`\<`Data`, `Error`, `any`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :------ | :---- |
| `Data` | `any` |
| `Error` | `any` |
#### Parameters
| Name | Type |
| :---- | :---- |
| `key` | `Key` |
#### Returns
`SWRResponse`\<`Data`, `Error`, `any`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:204
▸ **useSWR**\<`Data`, `Error`, `SWROptions`>(`key`, `config`): `SWRResponse`\<`Data`, `Error`, `SWROptions`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `SWROptions` | extends `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `BareFetcher`\<`Data`>>> = `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `BareFetcher`\<`Data`>>> |
#### Parameters
| Name | Type |
| :------- | :----------- |
| `key` | `Key` |
| `config` | `SWROptions` |
#### Returns
`SWRResponse`\<`Data`, `Error`, `SWROptions`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:205
▸ **useSWR**\<`Data`, `Error`, `SWROptions`>(`key`, `fetcher`, `config`): `SWRResponse`\<`Data`, `Error`, `SWROptions`>
A hook to fetch data.
#### Type parameters
| Name | Type |
| :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Data` | `any` |
| `Error` | `any` |
| `SWROptions` | extends `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `BareFetcher`\<`Data`>>> = `undefined` \| `Partial`\<`PublicConfiguration`\<`Data`, `Error`, `BareFetcher`\<`Data`>>> |
#### Parameters
| Name | Type |
| :-------- | :------------------------------- |
| `key` | `Key` |
| `fetcher` | `null` \| `BareFetcher`\<`Data`> |
| `config` | `SWROptions` |
#### Returns
`SWRResponse`\<`Data`, `Error`, `SWROptions`>
**`Link`**
[https://swr.vercel.app](https://swr.vercel.app)
**`Example`**
```jsx theme={null}
import useSWR from "swr";
function Profile() {
const { data, error, isLoading } = useSWR("/api/user", fetcher);
if (error) return failed to load
;
if (isLoading) return loading...
;
return hello {data.name}!
;
}
```
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:206
***
### useSWRConfig
▸ **useSWRConfig**(): `FullConfiguration`\<`any`, `any`, `BareFetcher`\<`unknown`>>
#### Returns
`FullConfiguration`\<`any`, `any`, `BareFetcher`\<`unknown`>>
#### Defined in
node\_modules/.pnpm/swr\@2.2.4\_react\@18.2.0/node\_modules/swr/\_internal/dist/index.d.ts:356
***
### useSessionStorage
▸ **useSessionStorage**\<`T`>(`key`, `initialValue`): \[`T`, (`data`: `any`) => `void`]
#### Type parameters
| Name |
| :--- |
| `T` |
#### Parameters
| Name | Type |
| :------------- | :------- |
| `key` | `string` |
| `initialValue` | `T` |
#### Returns
\[`T`, (`data`: `any`) => `void`]
#### Defined in
[packages/hooks/src/useSessionStorage.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useSessionStorage.ts#L4)
***
### useSettleSubscription
▸ **useSettleSubscription**(`options?`): `SWRSubscriptionResponse`\<`any`, `any`>
#### Parameters
| Name | Type |
| :------------------- | :------------------------ |
| `options?` | `Object` |
| `options.onMessage?` | (`data`: `any`) => `void` |
#### Returns
`SWRSubscriptionResponse`\<`any`, `any`>
#### Defined in
[packages/hooks/src/orderly/useSettleSubscription.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useSettleSubscription.ts#L4)
***
### useSymbolLeverage
▸ **useSymbolLeverage**(`symbol`): `number` | `"-"`
#### Parameters
| Name | Type |
| :------- | :------- |
| `symbol` | `string` |
#### Returns
`number` | `"-"`
#### Defined in
[packages/hooks/src/orderly/useSymbolLeverage.ts:5](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useSymbolLeverage.ts#L5)
***
### useSymbolPriceRange
▸ **useSymbolPriceRange**(`symbol`, `side`, `price?`): `undefined` | `PriceRange`
Get the price range for the specified symbol with an optional price
#### Parameters
| Name | Type | Description |
| :------- | :------------------ | :------------------------------------ |
| `symbol` | `string` | The symbol to get the price range for |
| `side` | `"BUY"` \| `"SELL"` | - |
| `price?` | `number` | Optional parameter to set the price |
#### Returns
`undefined` | `PriceRange`
PriceRange | undefined - Returns the PriceRange representing the price range or undefined
#### Defined in
[packages/hooks/src/orderly/useSymbolPriceRange.ts:19](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useSymbolPriceRange.ts#L19)
***
### useSymbolsInfo
▸ **useSymbolsInfo**(): {} & \{ `isNil`: `boolean` }
#### Returns
{} & \{ `isNil`: `boolean` }
#### Defined in
[packages/hooks/src/orderly/useSymbolsInfo.ts:6](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useSymbolsInfo.ts#L6)
***
### useTPSLOrder
▸ **useTPSLOrder**(`position`, `options?`): \[`Partial`\<`Omit`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`> & `Partial`\<`Pick`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`>> & \{ `sl_offset`: `number` ; `sl_offset_percentage`: `number` ; `sl_pnl`: `number` ; `tp_offset`: `number` ; `tp_offset_percentage`: `number` ; `tp_pnl`: `number` }>, \{ `errors`: `null` | `ValidateError` ; `setValue`: (`key`: `string`, `value`: `string` | `number`) => `void` ; `setValues`: (`values`: `Partial`\<`Partial`\<`Omit`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`> & `Partial`\<`Pick`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`>> & \{ `sl_offset`: `number` ; `sl_offset_percentage`: `number` ; `sl_pnl`: `number` ; `tp_offset`: `number` ; `tp_offset_percentage`: `number` ; `tp_pnl`: `number` }>>) => `void` ; `submit`: () => `Promise`\<`void`> ; `validate`: () => `Promise`\<[`AlgoOrderEntity`](/sdks/tech-doc/modules/orderly_network_types#algoorderentity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl) | [`POSITIONAL_TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#positional_tp_sl)>> }]
#### Parameters
| Name | Type | Description |
| :---------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- |
| `position` | `Partial`\<[`PositionTPSLExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionTPSLExt)> & `Pick`\<[`PositionTPSLExt`](/sdks/tech-doc/interfaces/orderly_network_types.API.PositionTPSLExt), `"symbol"` \| `"position_qty"` \| `"average_open_price"`> | Position that needs to set take profit and stop loss |
| `options?` | `Object` | - |
| `options.defaultOrder?` | [`AlgoOrder`](/sdks/tech-doc/interfaces/orderly_network_types.API.AlgoOrder) | You can set the default value for the take profit and stop loss order, it is usually used when editing order |
#### Returns
\[`Partial`\<`Omit`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`> & `Partial`\<`Pick`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`>> & \{ `sl_offset`: `number` ; `sl_offset_percentage`: `number` ; `sl_pnl`: `number` ; `tp_offset`: `number` ; `tp_offset_percentage`: `number` ; `tp_pnl`: `number` }>, \{ `errors`: `null` | `ValidateError` ; `setValue`: (`key`: `string`, `value`: `string` | `number`) => `void` ; `setValues`: (`values`: `Partial`\<`Partial`\<`Omit`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`> & `Partial`\<`Pick`\<[`BaseAlgoOrderEntity`](/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl)>, `"type"` | `"side"` | `"trigger_price"` | `"order_type"`>> & \{ `sl_offset`: `number` ; `sl_offset_percentage`: `number` ; `sl_pnl`: `number` ; `tp_offset`: `number` ; `tp_offset_percentage`: `number` ; `tp_pnl`: `number` }>>) => `void` ; `submit`: () => `Promise`\<`void`> ; `validate`: () => `Promise`\<[`AlgoOrderEntity`](/sdks/tech-doc/modules/orderly_network_types#algoorderentity)\<[`TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#tp_sl) | [`POSITIONAL_TP_SL`](/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType#positional_tp_sl)>> }]
#### Defined in
[packages/hooks/src/orderly/useTakeProfitAndStopLoss/index.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useTakeProfitAndStopLoss/index.ts#L4)
***
### useTickerStream
▸ **useTickerStream**(`symbol`): [`MarketInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfo) & \{ `24h_change?`: `Decimal` ; `change?`: `Decimal` }
#### Parameters
| Name | Type |
| :------- | :------- |
| `symbol` | `string` |
#### Returns
[`MarketInfo`](/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfo) & \{ `24h_change?`: `Decimal` ; `change?`: `Decimal` }
#### Defined in
[packages/hooks/src/orderly/useTickerStream.ts:11](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useTickerStream.ts#L11)
***
### useWS
▸ **useWS**(): [`WS`](/sdks/tech-doc/classes/orderly_network_net.WS)
#### Returns
[`WS`](/sdks/tech-doc/classes/orderly_network_net.WS)
#### Defined in
[packages/hooks/src/useWS.ts:11](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useWS.ts#L11)
***
### useWalletConnector
▸ **useWalletConnector**(): `WalletConnectorContextState`
#### Returns
`WalletConnectorContextState`
#### Defined in
[packages/hooks/src/walletConnectorContext.tsx:39](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/walletConnectorContext.tsx#L39)
***
### useWalletSubscription
▸ **useWalletSubscription**(`options?`): `SWRSubscriptionResponse`\<`any`, `any`>
#### Parameters
| Name | Type |
| :------------------- | :------------------------ |
| `options?` | `Object` |
| `options.onMessage?` | (`data`: `any`) => `void` |
#### Returns
`SWRSubscriptionResponse`\<`any`, `any`>
#### Defined in
[packages/hooks/src/orderly/useWalletSubscription.ts:4](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useWalletSubscription.ts#L4)
***
### useWithdraw
▸ **useWithdraw**(`options?`): `Object`
#### Parameters
| Name | Type |
| :--------- | :------------------- |
| `options?` | `UseWithdrawOptions` |
#### Returns
`Object`
| Name | Type |
| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `availableBalance` | `number` |
| `availableWithdraw` | `number` |
| `dst` | \{ `address`: `undefined` \| `string` = USDC.address; `chainId`: `number` = targetChain.network\_infos.chain\_id; `decimals`: `number` ; `network`: `string` = targetChain.network\_infos.shortName; `symbol`: `string` } |
| `dst.address` | `undefined` \| `string` |
| `dst.chainId` | `number` |
| `dst.decimals` | `number` |
| `dst.network` | `string` |
| `dst.symbol` | `string` |
| `isLoading` | `boolean` |
| `maxAmount` | `number` |
| `unsettledPnL` | `number` |
| `withdraw` | (`inputs`: \{ `allowCrossChainWithdraw`: `boolean` ; `amount`: `string` ; `chainId`: `number` ; `token`: `string` }) => `Promise`\<`any`> |
#### Defined in
[packages/hooks/src/orderly/useWithdraw.ts:16](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/orderly/useWithdraw.ts#L16)
***
### useWsStatus
▸ **useWsStatus**(): [`WsNetworkStatus`](/sdks/tech-doc/enums/orderly_network_hooks.WsNetworkStatus)
#### Returns
[`WsNetworkStatus`](/sdks/tech-doc/enums/orderly_network_hooks.WsNetworkStatus)
#### Defined in
[packages/hooks/src/useWsStatus.ts:10](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/useWsStatus.ts#L10)