Returns system notification messages relevant to the application.

Description

This API returns a list containing system notification messages of interest to the application developer. Withn the response, the messages are grouped into two general types: global messages, intended for the entire E*TRADE Developer Platform, and platform messages, which are intended only for the developer associated with the consumer key. Within each of those two overall types, messages are further grouped into three priority levels: info (low), notice (medium), and alert (high). Optional request parameters may specify a single message type, or a single message priority level, or both.

These messages are intended for developers, not users, and are very infrequent. They might contain information, for instance, about a new system feature, a planned system upgrade, etc.

URL

https://etws.etrade.com/notification/rest/getmessagelist

HTTP Method: GET

Request Parameters

Parameter Type Required? Description
messageType enum optional If specified, requests only the messages intended for this specific user, or only the messages intended for all users. If not specified (default), both types of messages are returned. Possible values are:
• GLOBAL - messages for all developers
• PLATFORM - messages for this developer
messageTier enum optional If specified, requests only the messages with the specified message priority level, identified by the name of the container element. Possible values are:
• INFO - low priority (returns infoMessages)
• NOTICE - medium priority (returns infoMessages)
• ALERT - high priority (returns alertMessages)
Response Properties
Property Type Description
globalMessages complex Container for messages of messageType GLOBAL.
alertMessages,
noticeMessages, infoMessages
complex These containers contain messages grouped by high priority (alert), medium priority (notice), or low priority (info). Correlates to the messageTier parameter in request.
   count integer The number of messages in this tier (i.e., the number of alerts, or the number of notices, or the number of info messages.
   message complex Container for a single message
      description string The message content
      subject string The message subject
platformMessages complex Container for messages of messageType PLATFORM
consumerKey string OAuth consumer key that identifies the developer/application for which these messages are intended
alertMessages,
noticeMessages,
infoMessages
complex These containers contain messages grouped by high priority (alert), medium priority (notice), or low priority (info), correlating to the messageTier parameter in the request. By default, all three types of messages are returned.
   count integer The number of messages in this tier (i.e., the number of alerts, or the number of notices, or the number of info messages
   message complex Container for a single message
      description string The message content
      subject string The message subject
Sample Request
GET https://etws.etrade.com/notification/rest/getmessagelist
Sample Response - XML
<getMessageListResponse xmlns="http://notification.etws.etrade.com/">
  <globalMessages>
    <alertMessages>
      <count>1</count>
    </alertMessages>
    <infoMessages>
      <count>2</count>
      <message>
        <description>This is an info message.</description>
        <subject>Info 1</subject>
      </message>
      <message>
        <description>This is also a test.</description>
        <subject>Info 2</subject>
      </message>
    </infoMessages>
    <noticeMessages>
      <count>1</count>
      <message>
        <description>This is a notice message.</description>
        <subject>Notice 1</subject>
      </message>
    </noticeMessages>
  </globalMessages>
  <platformMessages>
    <alertMessages>
      <count>1</count>
      <message>
        <description>Test Verification</description>
        <subject>Hello</subject>
      </message>
    </alertMessages>
    <consumerKey>45e56f05d7fa1021e2c81d3c7a1d2e06</consumerKey>
    <infoMessages>
      <count>2</count>
      <message>
        <description>Testing.</description>
        <subject>A test message</subject>
      </message>
      <message>
        <description>This is the body of a message.</description>
        <subject>This is the subject.</subject>
      </message>
    </infoMessages>
    <noticeMessages>
      <count>1</count>
      <message>
        <description>Sample message contents.</description>
        <subject>Sample Message</subject>
      </message>
    </noticeMessages>
  </platformMessages>
</getMessageListResponse>
Sample response - JSON
{
  "getMessageListResponse": {
    "-xmlns": "http://notification.etws.etrade.com/",
    "globalMessages": {
      "alertMessages": { "count": "1" },
      "infoMessages": {
        "count": "2",
        "message": [
          {
            "description": "This is an info message.",
            "subject": "Info 1"
          },
          {
            "description": "This is also a test.",
            "subject": "Info 2"
          }
        ]
      },
      "noticeMessages": {
        "count": "1",
        "message": {
          "description": "This is a notice message.",
          "subject": "Notice 1"
        }
      }
    },
    "platformMessages": {
      "alertMessages": {
        "count": "1",
        "message": {
          "description": "Test Verification",
          "subject": "Hello"
        }
      },
      "consumerKey": "45e56f05d7fa1021e2c81d3c7a1d2e06",
      "infoMessages": {
        "count": "2",
        "message": [
          {
            "description": "Testing.",
            "subject": "A test message"
          },
          {
            "description": "This is the body of a message.",
            "subject": "This is the subject."
          }
        ]
      },
      "noticeMessages": {
        "count": "1",
        "message": {
          "description": "Sample message contents.",
          "subject": "Sample Message"
        }
      }
    }
  }
}
Notes
  • The messages returned by this API are intended for developers and not typically exposed to ordinary application users.
  • For more on system messages and notifications, refer to our developer's guide on Notifications.
PLEASE READ THE IMPORTANT DISCLOSURES BELOW

By using E*TRADE API ("API") and accepting the terms of the Application Programming Interface License Agreement and the Application Programming Interface User Agreement, you agree that API may employ security policies, procedures and systems of Third Party providers which may or may not be less stringent and secure than the policies, procedures and systems of E*TRADE Securities LLC ("E*TRADE") or its affiliates. Material provided on API may have been produced by independent third parties not affiliated or endorsed by E*TRADE or its affiliates ("Third Party"). To the extent that API or Third Party providers express opinions or make recommendations, you understand that such opinions or recommendations are expressed by the Third Party provider and are not the opinions or recommendations of E*TRADE or its affiliates. E*TRADE is not responsible for the accuracy of market data displayed on API or made available by Third Party providers. There may be latency between the time an order (or other information) is submitted from API and the time the order is received by E*TRADE. The E*TRADE Two Second Execution Guarantee or any similar guarantee does not apply for orders placed through API and Third Party provider web sites. The E*TRADE CompleteTM Protection Guarantee does not apply. Orders created and submitted through API are not vetted until they are received by E*TRADE. It is possible that E*TRADE may reject an order placed through API. Please see the Application Programming Interface License Agreement and the Application Programming Interface User Agreement for more information.


The E*TRADE family of companies provides financial services including trading, investing, and related banking products and services to retail investors.


Securities products and services offered by E*TRADE Securities LLC, Member FINRA/SIPC.


System response and account access times may vary due to a variety of factors, including trading volumes, market conditions, system performance, and other factors.