Example: Stock Exchange Price

You can use the custom macro functionality to create a macro that allows users to display stock exchange prices on a Confluence page. 

The example below assumes you already have a REST API authentication token for the StockData REST API stored in a Script Variable with the name STOCKDATA_API_KEY.

1. Select the Settings cog in the top right-hand corner of the screen. 
2. Select Macros under ScriptRunner. 
3. Select Create Custom Macro.
4. Fill out the fields that appear: 
   
   1. Macro Name: Stock Exchange Price. 
   2. Description: Use this macro for a stock exchange price to appear on a Confluence page.
   3. Enabled (radio button): Select Enabled.
   4. Body Type: None. 
   5. Output Type: Block

   6. Script to Execute: Enter the script for the macro here.

      groovy
      def exchange_symbol = parameters['Stock Exchange Symbol']
      def url = "https://api.stockdata.org/v1/data/quote?symbols=${exchange_symbol}&api_token=${STOCKDATA_API_KEY}"
      def resp = get(url).asObject(Map)
      if (resp.status > 300) {
          return "<p>Sorry, we couldn't fetch the stock details for ${exchange_symbol}</p>"
      }
      def body = resp.body as Map<List>
      def data = body.data as List<Map>
      if (!data) {
          return "<p>Sorry, we couldn't fetch the stock details for ${exchange_symbol}</p>"
      }
      def stock_price = "${data[0].price} ${data[0].currency}"
      def stock_name = "${data[0].name} (${data[0].ticker})"
      
      return """
      <p>${stock_name} ${stock_price}</p>
      """

5. Select Add Parameter. 
   
   1. Type: String
   2. Name: Stock Exchange Symbol
   3. Description: Enter the symbol of the stock that you would like to see the exchange price for. 
   4. Required: Do not tick the box
   5. Hidden: Do not tick the box

   6. Select Add.
      

      When users add this macro to a Confluence page, they will enter something like NASDAQ:AMZN for Amazon.com. 

6. Select Save. 

Result: You can now use this macro on a Confluence page. For help with using the macro, check out the Use Macros section of the Macros documentation. 

This is what the macro looks when rendered on a Confluence page: 

You can use multiple instances of it in a table, which would look like this: