< API Reference
GET
/allaccess/reference/message-conditions
For API methods which return trades or quotes, a numeric message condition id is associated with the trade or quote. Message Conditions provides a mapping of the condition id to the condition details, including condition name and whether the condition applies to equities, options, and/or futures.

Example URI

Live (1 points)

https://api.livevol.com/v1/live/allaccess/reference/message-conditions

Delayed (1 points)

https://api.livevol.com/v1/delayed/allaccess/reference/message-conditions

Response Information

Resource Description

Collection of MessageCondition

Name Description Type Additional information
id

Condition id

 integer

None
name

Condition name

 string

None

Message condition type

 MessageType

None

MessageType

Possible enumeration values:

Value Description

trade

quote

security_types

List of security types

 Collection of string

None

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": 0,
    "name": "Regular",
    "message_type": "trade",
    "security_types": [
      "equity"
    ]
  },
  {
    "id": 2,
    "name": "OutOfSeq",
    "message_type": "quote",
    "security_types": [
      "equity",
      "option"
    ]
  }
]

application/xml, text/xml

Sample: 
<message_conditions xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <message_condition>
    <id>0</id>
    <message_type>trade</message_type>
    <name>Regular</name>
    <security_types xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>equity</d3p1:string>
    </security_types>
  </message_condition>
  <message_condition>
    <id>2</id>
    <message_type>quote</message_type>
    <name>OutOfSeq</name>
    <security_types xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>equity</d3p1:string>
      <d3p1:string>option</d3p1:string>
    </security_types>
  </message_condition>
</message_conditions>