Skip to main content

Get Admin Messages

GET 
/v1/native/iex/admin/messages/:symbol

Get Admin Messages

Request​

Path Parameters

    symbol stringrequired

    The symbol identifier

Query Parameters

    date date-timerequired

    Optional date in format YYYY-MM-DD (defaults to latest available data)

Responses​

successful operation

Schema

  • Array [

    • trading_status

    object

    Represents the response DTO for trading status information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the trading status was recorded as DateTime

    is_trading_live boolean

    Gets whether the security is currently trading on IEX

    is_trading_halted boolean

    Gets whether the security is halted across all US equity markets

    is_trading_in_order_acceptance_period boolean

    Gets whether the security is in Order Acceptance Period on IEX

    is_trading_paused boolean

    Gets whether the security is paused and in Order Acceptance Period on IEX

    is_reason_halt_news_pending boolean

    Gets whether the halt reason is News Pending

    is_reason_ipo_not_yet_trading boolean

    Gets whether the halt reason is IPO Not Yet Trading

    is_reason_ipo_deferred boolean

    Gets whether the halt reason is IPO Deferred

    is_reason_halt_news_dissemination boolean

    Gets whether the order acceptance period reason is Halt News Dissemination

    is_reason_ipo_order_acceptance_period boolean

    Gets whether the order acceptance period reason is IPO Order Acceptance Period

    is_reason_ipo_pre_launch_period boolean

    Gets whether the order acceptance period reason is IPO Pre-Launch Period

    is_reason_market_wide_circuit_breaker_level1 boolean

    Gets whether the order acceptance period reason is Market-Wide Circuit Breaker Level 1 – Breached

    is_reason_market_wide_circuit_breaker_level2 boolean

    Gets whether the order acceptance period reason is Market-Wide Circuit Breaker Level 2 – Breached

    is_reason_market_wide_circuit_breaker_level3 boolean

    Gets whether the halt reason is Market-Wide Circuit Breaker Level 3 – Breached

    is_reason_not_applicable boolean

    Gets whether the reason is Not Applicable

    is_reason_not_available boolean

    Gets whether the halt reason is Not Available

    official_price

    object

    Represents the response DTO for official price information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the official price was recorded as DateTime

    price_type int32

    Type of price as byte value

    price_type_code stringnullable

    Type of price as character string

    price_type_text stringnullable

    Human-readable description of the price type

    is_price_type_opening boolean

    Indicates if the price type is 'IEX Official Opening Price' ('Q'/0x51).

    is_price_type_closing boolean

    Indicates if the price type is 'IEX Official Closing Price' ('M'/0x4d).

    official_price double

    Official price as decimal

    security_event

    object

    Represents the response DTO for security event information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the security event was recorded as DateTime

    security_event int32

    Security event as byte value

    security_event_code stringnullable

    Security event as character string ('O' or 'C')

    security_event_text stringnullable

    Human-readable description of the security event

    is_opening_process_complete boolean

    Indicates if the security event is 'Opening Process Complete' ('O'/0x4f).

    is_closing_process_complete boolean

    Indicates if the security event is 'Closing Process Complete' ('C'/0x43).

    auction_information

    object

    Represents the response DTO for auction information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the auction data was recorded as DateTime

    auction_type int32

    Type of auction as byte value

    auction_type_code stringnullable

    Type of auction as character string

    auction_type_text stringnullable

    Human-readable description of the auction type

    is_auction_type_opening boolean

    Indicates if the auction type is 'Opening Auction' ('O'/0x4f).

    is_auction_type_closing boolean

    Indicates if the auction type is 'Closing Auction' ('C'/0x43).

    is_auction_type_ipo boolean

    Indicates if the auction type is 'IPO Auction' ('I'/0x49).

    is_auction_type_halt boolean

    Indicates if the auction type is 'Halt Auction' ('H'/0x48).

    is_auction_type_volatility boolean

    Indicates if the auction type is 'Volatility Auction' ('V'/0x56).

    paired_shares int32

    Number of shares paired at the Reference Price

    reference_price double

    Reference price as decimal

    indicative_clearing_price double

    Indicative clearing price as decimal

    imbalance_shares int32

    Number of unpaired shares at the Reference Price

    imbalance_side int32

    Side of the imbalance as byte value

    imbalance_side_code stringnullable

    Side of the imbalance as character string

    imbalance_side_text stringnullable

    Human-readable description of the imbalance side

    is_imbalance_side_buy boolean

    Indicates if there is a buy-side imbalance ('B'/0x42).

    is_imbalance_side_sell boolean

    Indicates if there is a sell-side imbalance ('S'/0x53).

    is_imbalance_side_none boolean

    Indicates if there is no imbalance ('N'/0x4e).

    extension_number int32

    Number of extensions to the auction

    scheduled_auction_time_seconds int32

    Scheduled auction time in seconds since epoch

    scheduled_auction_time date-time

    Scheduled time for the auction as DateTime

    auction_book_clearing_price double

    Auction book clearing price as decimal

    collar_reference_price double

    Collar reference price as decimal

    lower_auction_collar double

    Lower auction collar as decimal

    upper_auction_collar double

    Upper auction collar as decimal

    short_sale_price_test

    object

    Represents the response DTO for short sale price test status information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the short sale price test status was recorded as DateTime

    short_sale_price_test_status int32

    Short sale price test status as byte value

    short_sale_price_test_status_code stringnullable

    Short sale price test status as hex string

    short_sale_price_test_status_text stringnullable

    Human-readable description of the short sale price test status

    is_short_sale_price_test_not_in_effect boolean

    Indicates if the short sale price test is not in effect

    is_short_sale_price_test_in_effect boolean

    Indicates if the short sale price test is in effect

    detail int32

    Detail of the short sale price test as byte value

    detail_code stringnullable

    Detail of the short sale price test as character string

    detail_text stringnullable

    Human-readable description of the short sale price test detail

    is_detail_no_price_test boolean

    Indicates if there is no price test in place

    is_detail_activated boolean

    Indicates if the short sale price test restriction is in effect due to an intraday price drop

    is_detail_continued boolean

    Indicates if the short sale price test restriction remains in effect from prior day

    is_detail_deactivated boolean

    Indicates if the short sale price test restriction is deactivated

    is_detail_not_available boolean

    Indicates if the detail is not available

    operational_halt_status

    object

    Represents the response DTO for operational halt status information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the operational halt status was recorded as DateTime

    operational_halt_status int32

    Operational halt status as byte value

    operational_halt_status_code stringnullable

    Operational halt status as character string

    operational_halt_status_text stringnullable

    Human-readable description of the operational halt status

    is_operationally_halted boolean

    Indicates if the status is 'IEX specific operational trading halt' ('O'/0x4f).

    is_not_operationally_halted boolean

    Indicates if the status is 'Not operationally halted on IEX' ('N'/0x4e).

    retail_liquidity_indicator

    object

    Represents the response DTO for retail liquidity indicator information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the retail liquidity indicator was recorded as DateTime

    retail_liquidity_indicator int32

    Retail liquidity indicator as byte value

    retail_liquidity_indicator_code stringnullable

    Retail liquidity indicator as character string

    retail_liquidity_indicator_text stringnullable

    Human-readable description of the retail liquidity indicator

    is_retail_indicator_not_applicable boolean

    Indicates if the indicator is 'Not Applicable' (' '/0x20).

    is_retail_indicator_buy_interest boolean

    Indicates if there is 'Buy interest for Retail' ('A'/0x41).

    is_retail_indicator_sell_interest boolean

    Indicates if there is 'Sell interest for Retail' ('B'/0x42).

    is_retail_indicator_buy_and_sell_interest boolean

    Indicates if there is 'Buy and sell interest for Retail' ('C'/0x43).

    system_event

    object

    Represents the response DTO for system event information

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the system event was recorded as DateTime

    system_event int32

    System event as byte value

    system_event_code stringnullable

    System event as string

    system_event_text stringnullable

    Human-readable description of the system event

    is_system_event_start_of_messages boolean

    Indicates if the system event is 'Start of Messages' (O). Outside of heartbeat messages on the lower level protocol, the start of day message is the first message sent in any trading session.

    is_system_event_start_of_system_hours boolean

    Indicates if the system event is 'Start of System Hours' (S). This message indicates that IEX is open and ready to start accepting orders.

    is_system_event_start_of_regular_market_hours boolean

    Indicates if the system event is 'Start of Regular Market Hours' (R). This message indicates that DAY and GTX orders, as well as market orders and pegged orders, are available for execution on IEX.

    is_system_event_end_of_regular_market_hours boolean

    Indicates if the system event is 'End of Regular Market Hours' (M). This message indicates that DAY orders, market orders, and pegged orders are no longer accepted by IEX.

    is_system_event_end_of_system_hours boolean

    Indicates if the system event is 'End of System Hours' (E). This message indicates that IEX is now closed and will not accept any new orders during this trading session. It is still possible to receive messages after the end of day.

    is_system_event_end_of_messages boolean

    Indicates if the system event is 'End of Messages' (C). This is always the last message sent in any trading session.

    security_directory

    object

    Represents the response DTO for security directory information

    symbol stringnullable

    The stock symbol

    timestamp_nanos int64

    Original timestamp in nanoseconds since epoch

    timestamp date-time

    Time when the security directory information was recorded as DateTime

    flags int32

    Flags for the security

    round_lot_size int32

    Number of shares that represent a round lot

    adjusted_poc_price double

    Adjusted previous official closing price as decimal

    luld_tier int32

    LULD tier as byte value

    luld_tier_code stringnullable

    LULD tier as numeric string

    luld_tier_text stringnullable

    Human-readable description of the LULD tier

    is_luld_tier_not_applicable boolean

    Indicates if LULD Tier is 'Not applicable' (0x0).

    is_luld_tier1 boolean

    Indicates if LULD Tier is 'Tier 1 NMS Stock' (0x1).

    is_luld_tier2 boolean

    Indicates if LULD Tier is 'Tier 2 NMS Stock' (0x2).

  • ]

Loading...