< API Reference
GET
/market/notifications/halts?seqno={seqno}&type={type}
STOCKS
Get halt messages

Example URI

Live

https://api.livevol.com/v1/live/market/notifications/halts?seqno=0&type=active_halts

Delayed

https://api.livevol.com/v1/delayed/market/notifications/halts?seqno=0&type=active_halts

Request Information

URI Parameters

NameDescriptionTypeAdditional information
seqno

Sequence number (ignored in active_halts, reg_sho modes)

unsigned integer

None.

type

Type

string

Allowed values are [ all, active_halts, reg_sho ]

Default value is: all

Response Information

Resource Description

Collection of HaltMessage

NameDescriptionTypeAdditional information
underlying_symbol

Underlying symbol

string

None.

session_time

Session time (Eastern Standard Time)

string

None.

type

Halt type

HaltType

None.

reason

Reason

HaltReason

None.

sequence_number

Sequence number

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "underlying_symbol": "CBOE",
    "session_time": "2017-07-03 10:30:01",
    "type": "quote_resume",
    "reason": "market_wide_resume",
    "sequence_number": 21298809887
  },
  {
    "underlying_symbol": null,
    "session_time": null,
    "type": "open",
    "reason": "not_available",
    "sequence_number": 0
  }
]

application/xml, text/xml

Sample:
<halt_messages xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <halt_message>
    <sequence_number>21298809887</sequence_number>
    <reason>market_wide_resume</reason>
    <session_time>2017-07-03 10:30:01</session_time>
    <type>quote_resume</type>
    <underlying_symbol>CBOE</underlying_symbol>
  </halt_message>
  <halt_message>
    <sequence_number>0</sequence_number>
    <reason>not_available</reason>
    <session_time i:nil="true" />
    <type>open</type>
    <underlying_symbol i:nil="true" />
  </halt_message>
</halt_messages>