> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arcus.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Market updates

> > **Endpoint:** `wss://api.arcus.xyz/v1/ws` — one socket multiplexes every channel and RPC request. Click **Connect**, then send the example subscribe message below to start receiving data.

Global public channel (no `id`, no auth) that streams the split lifecycle of every market. Every frame is `{isSnapshot, updates}`; a streaming frame carries exactly one update:

- `MarketUpdateSplitUpcoming` — a split was announced (e.g. 8-for-1 on SNDK-USD: `currentMultiplier` "1", `postSplitMultiplier` "8").
- `MarketUpdateSplitCancelled` — a pending split was withdrawn.
- `MarketUpdateStateChange` — every transition into or out of OFFLINE: `HALTED` when the market goes offline, `RESUMED` when it leaves offline.
- `MarketUpdateSplitEffective` — the split was applied: position sizes multiplied and prices divided by the ratio.

On subscribe the server sends a snapshot (`isSnapshot: true`) carrying every pending split announcement and every market still halted, ordered by market id (a market's split before its halt); `updates` is empty when nothing is pending. The snapshot is rebuilt from the persisted notice history at server start.




## AsyncAPI

````yaml api-reference/asyncapi.yaml marketUpdates
id: marketUpdates
title: Market updates
description: >
  > **Endpoint:** `wss://api.arcus.xyz/v1/ws` — one socket multiplexes every
  channel and RPC request. Click **Connect**, then send the example subscribe
  message below to start receiving data.


  Global public channel (no `id`, no auth) that streams the split lifecycle of
  every market. Every frame is `{isSnapshot, updates}`; a streaming frame
  carries exactly one update:


  - `MarketUpdateSplitUpcoming` — a split was announced (e.g. 8-for-1 on
  SNDK-USD: `currentMultiplier` "1", `postSplitMultiplier` "8").

  - `MarketUpdateSplitCancelled` — a pending split was withdrawn.

  - `MarketUpdateStateChange` — every transition into or out of OFFLINE:
  `HALTED` when the market goes offline, `RESUMED` when it leaves offline.

  - `MarketUpdateSplitEffective` — the split was applied: position sizes
  multiplied and prices divided by the ratio.


  On subscribe the server sends a snapshot (`isSnapshot: true`) carrying every
  pending split announcement and every market still halted, ordered by market id
  (a market's split before its halt); `updates` is empty when nothing is
  pending. The snapshot is rebuilt from the persisted notice history at server
  start.
servers:
  - id: mainnet
    protocol: wss
    host: api.arcus.xyz
    bindings: []
    variables: []
  - id: testnet
    protocol: wss
    host: api.testnet.arcus.xyz
    bindings: []
    variables: []
address: /v1/ws?channel=marketUpdates
parameters: []
bindings: []
operations:
  - &ref_3
    id: subscribeMarketUpdates
    title: Subscribe market updates
    type: receive
    messages:
      - &ref_5
        id: subscribe
        contentType: application/json
        payload:
          - name: Subscribe to the market updates channel
            type: object
            properties:
              - name: type
                type: string
                description: subscribe
                required: true
              - name: channel
                type: string
                description: marketUpdates
                required: true
        headers: []
        jsonPayloadSchema:
          type: object
          required:
            - type
            - channel
          properties:
            type:
              type: string
              const: subscribe
              x-parser-schema-id: <anonymous-schema-158>
            channel:
              type: string
              const: marketUpdates
              x-parser-schema-id: <anonymous-schema-159>
          x-parser-schema-id: SubscribeMarketUpdatesPayload
        title: Subscribe to the market updates channel
        example: |-
          {
            "type": "subscribe",
            "channel": "marketUpdates"
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: subscribe
    bindings: []
    extensions: &ref_2
      - id: x-parser-unique-object-id
        value: marketUpdates
  - &ref_4
    id: receiveMarketUpdates
    title: Receive market updates
    type: send
    messages:
      - &ref_6
        id: snapshot
        contentType: application/json
        payload:
          - allOf: &ref_0
              - type: object
                description: Common envelope for all server-pushed channel messages.
                required:
                  - type
                  - channel
                properties:
                  type:
                    type: string
                    enum:
                      - subscribed
                      - channel_data
                    description: >-
                      `subscribed` for the initial snapshot; `channel_data` for
                      updates.
                    x-parser-schema-id: <anonymous-schema-7>
                  channel:
                    type: string
                    description: Channel name.
                    x-parser-schema-id: <anonymous-schema-8>
                  id:
                    type: string
                    description: >
                      Channel id (market, or the lowercase master Ethereum
                      address on account-scoped channels). Absent for global
                      channels. Always lowercase for addresses regardless of the
                      spelling used to subscribe, so compare it
                      case-insensitively.
                    x-parser-schema-id: <anonymous-schema-9>
                  accountIndex:
                    type: integer
                    description: >
                      Subaccount this frame belongs to. Present on EVERY frame
                      of an account-scoped channel — `subscribed`,
                      `unsubscribed`, `degraded`, and `channel_data` alike —
                      including when it is 0, so a frame names its subaccount
                      outright and no client needs a "missing means 0" rule.
                      Omitted on every other channel. This is what makes several
                      subaccounts of one address demuxable on a single
                      connection: `id` alone is the master address and is
                      identical across all of them.
                    minimum: 0
                    maximum: 9
                    example: 3
                    x-parser-schema-id: <anonymous-schema-10>
                  sigFigs:
                    type: integer
                    description: >
                      Echo of the l2Orderbook aggregation this frame belongs to.
                      Omitted on full-precision views and on every other
                      channel. Lets a client holding several aggregations of the
                      same market demux snapshots.
                    enum:
                      - 2
                      - 3
                      - 4
                      - 5
                    x-parser-schema-id: <anonymous-schema-11>
                  roundStep:
                    type: integer
                    description: >-
                      Echo of the l2Orderbook roundStep for this view. Omitted
                      unless sigFigs is 5 and roundStep was 2 or 5.
                    enum:
                      - 1
                      - 2
                      - 5
                    x-parser-schema-id: <anonymous-schema-12>
                  throttleMs:
                    type: integer
                    enum:
                      - 100
                      - 250
                      - 500
                      - 1000
                      - 2000
                    description: >
                      Echo of the throttleMs cadence requested on subscribe.
                      Present on the `subscribed` ack for `bbo` and
                      `oraclePrices` when throttling was requested; absent
                      otherwise and absent on `channel_data` frames (it is not
                      part of subscription identity, so there is nothing to
                      demux).
                    x-parser-schema-id: <anonymous-schema-13>
                  market:
                    type: string
                    example: BTC-USD
                    description: >
                      Display ticker of the market this frame belongs to, always
                      the resolved ticker even when the client subscribed by
                      numeric id. Present only on `positions` / `orders` /
                      `userFills`; omitted on every other channel. Its meaning
                      differs slightly by frame type. On `subscribed` /
                      `unsubscribed` it echoes the market filter the
                      subscription was created with, and is omitted for an
                      unfiltered subscription. On `channel_data` it is the
                      market of the frame itself, so an UNFILTERED subscriber
                      sees it too — those channels emit one frame per market, so
                      every frame has one. This is what lets a client demux,
                      exactly as `sigFigs` / `roundStep` do for l2Orderbook: a
                      connection holding several market-filtered views of one
                      account matches each frame to the right view by this
                      field. Clients that hold a single unfiltered view can
                      ignore it.
                    x-parser-schema-id: <anonymous-schema-14>
                  contents:
                    type: object
                    additionalProperties: true
                    description: Channel-specific payload. Schema varies by channel.
                    properties: {}
                    x-parser-schema-id: <anonymous-schema-15>
                x-parser-schema-id: ChannelDataEnvelope
              - type: object
                properties:
                  contents:
                    type: object
                    required:
                      - isSnapshot
                      - updates
                    properties:
                      isSnapshot:
                        type: boolean
                        description: >
                          True for the subscribe-time snapshot of pending splits
                          and halted markets; false for streaming frames.
                        x-parser-schema-id: <anonymous-schema-162>
                      updates:
                        type: array
                        description: >
                          Streaming frames carry exactly one update. The
                          snapshot carries every pending split and every market
                          still halted, ordered by market id, a market's split
                          before its halt.
                        items:
                          type: object
                          description: >
                            One market split-lifecycle event. Fields that do not
                            apply to `type` are omitted.
                          required:
                            - type
                            - marketId
                            - marketDisplayName
                            - timestamp
                            - globalSequenceId
                          properties:
                            type:
                              type: string
                              enum:
                                - MarketUpdateSplitUpcoming
                                - MarketUpdateSplitCancelled
                                - MarketUpdateStateChange
                                - MarketUpdateSplitEffective
                              description: >
                                `MarketUpdateSplitUpcoming` — a split was
                                announced. `MarketUpdateSplitCancelled` — a
                                pending split was withdrawn.
                                `MarketUpdateStateChange` — the market went
                                offline or came back online.
                                `MarketUpdateSplitEffective` — the split was
                                applied (position sizes multiplied, prices
                                divided by the ratio).
                              x-parser-schema-id: <anonymous-schema-164>
                            marketId:
                              type: integer
                              example: 33
                              x-parser-schema-id: <anonymous-schema-165>
                            marketDisplayName:
                              type: string
                              example: SNDK-USD
                              x-parser-schema-id: <anonymous-schema-166>
                            state:
                              type: string
                              enum:
                                - HALTED
                                - RESUMED
                              description: >
                                `MarketUpdateStateChange` only. `HALTED` when
                                the market goes offline, `RESUMED` when it
                                leaves offline.
                              x-parser-schema-id: <anonymous-schema-167>
                            splitEffectiveTimeNs:
                              type: integer
                              format: int64
                              description: >
                                `MarketUpdateSplitUpcoming` /
                                `MarketUpdateSplitCancelled` only. Scheduled
                                split time in Unix nanoseconds.
                              example: 1795136700000000000
                              x-parser-schema-id: <anonymous-schema-168>
                            splitTimeNs:
                              type: integer
                              format: int64
                              description: >
                                `MarketUpdateSplitEffective` only. Time the
                                split was applied, in Unix nanoseconds.
                              example: 1795136700123456800
                              x-parser-schema-id: <anonymous-schema-169>
                            currentMultiplier:
                              type: string
                              description: >
                                Split updates only (not
                                `MarketUpdateStateChange`). The market's
                                cumulative shares per originally listed share
                                before the split, as a decimal string ("1", "8",
                                "1.5").
                              example: '1'
                              x-parser-schema-id: <anonymous-schema-170>
                            postSplitMultiplier:
                              type: string
                              description: >
                                Split updates only (not
                                `MarketUpdateStateChange`). The market's
                                cumulative shares per originally listed share
                                after the split. An 8-for-1 split on a fresh
                                market goes from "1" to "8".
                              example: '8'
                              x-parser-schema-id: <anonymous-schema-171>
                            timestamp:
                              type: integer
                              format: int64
                              description: Engine event time in Unix nanoseconds.
                              example: 1795010400123456800
                              x-parser-schema-id: <anonymous-schema-172>
                            globalSequenceId:
                              type: integer
                              format: int64
                              description: Strict ordering across all engine events.
                              example: 9700000001
                              x-parser-schema-id: <anonymous-schema-173>
                          x-parser-schema-id: MarketUpdate
                        x-parser-schema-id: <anonymous-schema-163>
                    x-parser-schema-id: <anonymous-schema-161>
                x-parser-schema-id: <anonymous-schema-160>
            x-parser-schema-id: MarketUpdatesPayload
            name: Market Updates Snapshot
            description: >
              Sent once on subscribe (`isSnapshot: true`): every pending split
              announcement and every market still halted, ordered by market id,
              a market's split before its halt. `updates` is empty when nothing
              is pending.
        headers: []
        jsonPayloadSchema: &ref_1
          allOf: *ref_0
          x-parser-schema-id: MarketUpdatesPayload
        title: Market Updates Snapshot
        description: >
          Sent once on subscribe (`isSnapshot: true`): every pending split
          announcement and every market still halted, ordered by market id, a
          market's split before its halt. `updates` is empty when nothing is
          pending.
        example: |-
          {
            "type": "subscribed",
            "channel": "marketUpdates",
            "contents": {
              "isSnapshot": true,
              "updates": [
                {
                  "type": "MarketUpdateSplitUpcoming",
                  "marketId": 33,
                  "marketDisplayName": "SNDK-USD",
                  "splitEffectiveTimeNs": 1795136700000000000,
                  "currentMultiplier": "1",
                  "postSplitMultiplier": "8",
                  "timestamp": 1795010400123456800,
                  "globalSequenceId": 9700000001
                },
                {
                  "type": "MarketUpdateStateChange",
                  "marketId": 33,
                  "marketDisplayName": "SNDK-USD",
                  "state": "HALTED",
                  "timestamp": 1795122000123456800,
                  "globalSequenceId": 9700050000
                }
              ]
            }
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: snapshot
      - &ref_7
        id: update
        contentType: application/json
        payload:
          - allOf: *ref_0
            x-parser-schema-id: MarketUpdatesPayload
            name: Market Update
            description: >
              One frame per market notice, carrying exactly one update
              (`isSnapshot: false`).
        headers: []
        jsonPayloadSchema: *ref_1
        title: Market Update
        description: >
          One frame per market notice, carrying exactly one update (`isSnapshot:
          false`).
        example: |-
          {
            "type": "channel_data",
            "channel": "marketUpdates",
            "contents": {
              "isSnapshot": false,
              "updates": [
                {
                  "type": "MarketUpdateSplitUpcoming",
                  "marketId": 33,
                  "marketDisplayName": "SNDK-USD",
                  "splitEffectiveTimeNs": 1795136700000000000,
                  "currentMultiplier": "1",
                  "postSplitMultiplier": "8",
                  "timestamp": 1795010400123456800,
                  "globalSequenceId": 9700000001
                }
              ]
            }
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: update
    bindings: []
    extensions: *ref_2
sendOperations:
  - *ref_3
receiveOperations:
  - *ref_4
sendMessages:
  - *ref_5
receiveMessages:
  - *ref_6
  - *ref_7
extensions:
  - id: x-parser-unique-object-id
    value: marketUpdates
securitySchemes: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.