< API Reference
GET
/allaccess/market/notifications/halts?seqno={seqno}&type={type}
See trading halts for underlying securities due to news dissemination, reg sho (securities that are subject to the short sale price test restriction), and limit up/limit down.

Example URI

Live (1 points)

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

Delayed (1 points)

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

Request Information

URI Parameters

Name Description Type Additional 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

Name Description Type Additional information
underlying_symbol

Underlying symbol

 string

None
session_time

Session time (Eastern Standard Time)

 string

None

Halt type

 HaltType

None

HaltType

Possible enumeration values:

Value Description

open

preopen

halted

closed

reg_sho

quote_resume

trade_resume

luld

preopen_no_cancel

opening

not_available_for_trading

postclose

precross

cross

unknown

Reason

 HaltReason

None

HaltReason

Possible enumeration values:

Value Description

not_available

news_pending

news_released

news_and_resumption

trade_pause

extra_mkt_activity

trade_only_resume

etf

addl_info_requested

non_compliance

not_current

sec_trading_sspd

regulatory_concern

sec_revocation

operations_halt

ipo_not_traded

ipo_quote_release

ipo_window_extension

corporate_action

quote_not_available

vol_trade_pause

vol_trade_straddle

market_wide_halt0

market_wide_halt1

market_wide_halt2

market_wide_halt3

market_wide_resume

new_issue_available

issue_available

qual_issues_resolved

filings_met

news_not_coming

qual_halt_concluded

halt_concluded_by_reg

sec_vol_trading_pause

security_deletion

foreign_mkt_reg

comp_deriv_sec

extra_events

merger_effective

order_imbalance

operational

sub_penny

reg_sho_intra_day

reg_sho_remains

group_schedule

surveillance_intervention

market_event

instrument_activation

instrument_expiration

unknown

recovery_in_progress

etf_comp_prices_not_available

new_sec_offering

intraday_ind_val_not_available

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": "CBOE",
    "session_time": "2017-07-03 10:30:01",
    "type": "quote_resume",
    "reason": "market_wide_resume",
    "sequence_number": 21298809887
  }
]

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>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_messages>