Content Display Requirements

Message example

Content

  1. Do not modify, edit or otherwise change the message content as passed through the API, except as needed to reformat for technical limitations of your specific service.
  2. All $TICKER cashtags within each message must be hyperlinked and point to the StockTwits ticker page at http://www.stocktwits.com/symbol/.
  3. All @mentions within each message must be hyperlinked and point to the StockTwits user page for the mentioned user at http://www.stocktwits.com/.
  4. Messages should be presented with a timestamp, either in absolute (May 1, 2012 3:30pm) or relative (1 hour ago) format. The timestamp should be linked to the message display page on StockTwits at http://www.stocktwits.com/message/.
  5. If you choose to display media objects passed within the API in your application; such as a chart image or video, the object must be hyperlinked and point to the message display page on StockTwits at http://www.stocktwits.com/message/.

Linking Cashtags (eg. $GOOG) can be done easily, we have created a library that provides text processing routines for StockTwits Messages. This library provides autolinking and extraction for cashtags, it's available on Github: https://github.com/stocktwits/stocktwits-text-js

We recommend using the Twitter text-js Library for linking URLs. The library provides autolinking and extraction for URLs. You will find it on Github:  https://github.com/twitter/twitter-text-js

Author and Attribution

  1. The StockTwits user’s name must be presented as the author of the content, using either the user’s StockTwits user name or user name and full name. The name should be linked to the user’s StockTwits profile page at http://www.stocktwits.com/.
  2. The user’s name should be presented in a way to distinguish it from the message content.
  3. Display of the user’s avatar is recommended, but not required. If displayed the user’s avatar should also be linked to the StockTwits user page for the user.

Message Interactions

  1. You may include Reply, Reshare, and Like action links using the StockTwits web intents, if so they should be used consistently across all messages for authenticated StockTwits users.
  2. You cannot include third party interactions with StockTwits messages.

Branding

  1. It must always be apparent to the user that they are looking at a StockTwits message.
  2. Any StockTwits messages displayed individually or as part of a stream labeled with a StockTwits logo adjacent to the message or stream. Logos and buttons are available via our logo page. Whenever possible, StockTwits logos should link to http://stocktwits.com