---
url: >-
  https://game-engine-io.github.io/enginex-frontend-sdk/reference/api/@getenginex/sdk-react/functions/useRealtimeStatus.md
---
[Reference](../../../index.md) / [@getenginex/sdk-react](../index.md) / useRealtimeStatus

# useRealtimeStatus()

> **useRealtimeStatus**(): [`RealtimeStatus`](../../sdk/realtime/type-aliases/RealtimeStatus.md)

Status of the client's realtime connection (`'connecting'`, `'open'`, `'reconnecting'`, `'closed'` or
`'unavailable'`), reactive. It does not open the connection: it opens with the first [useRealtime](useRealtime.md) or
[useRealtimeSync](useRealtimeSync.md). On the server and during hydration it is `'closed'`.

## Returns

[`RealtimeStatus`](../../sdk/realtime/type-aliases/RealtimeStatus.md)

The current status.

## Throws

If called outside an `EnginexProvider`.

## Example

```ts
const status = useRealtimeStatus()
if (status === 'reconnecting') return <Banner>Reconnecting...</Banner>
```
