Writing Algorithms

Live Notifications

Introduction

Set up some live trading notifications so that you are notified of market events and your algorithm's performance. We support email, SMS, webhooks, and Telegram notifications. Lean ignores notifications during backtests.

Email

Email notifications can include up to 10KB of text content in the message body. These notifications can be slow since they go through your email provider. If you don't receive an email notification that you're expecting, check your junk folders. These notifications are rate-limited to 20 messages per hour. If you exceed the limit, each additional email notification costs 10 QuantConnect Credit (QCC).

To send email notifications in your code files, run:

Notify.Email(emailAddress, subject, body, attachment, headers);
self.Notify.Email(email_address, subject, body, attachment, headers)

SMS

SMS notifications are the only type of notification that you don't need an internet connection to receive. These notifications are rate-limited to 20 messages per hour. If you exceed the limit, each additional SMS notification costs 5 QCC.

To send SMS notifications in your code files, run:

Notify.Sms(phoneNumber, message);
self.Notify.Sms(phone_number, message)

Webhooks

Webhook notifications are an HTTP-POST request to a URL you provide. The request is sent with a timeout of 300s. You can process these notifications on your web server however you want. For instance, you can inject the content of the notifications into your server's database or use it to create other notifications on your own server. These notifications are rate-limited to 20 requests per hour. If you exceed the limit, each additional webhook notification costs 5 QCC.

To send webhook notifications in your code files, run:

Notify.Web(url, payload, headers);
self.Notify.Web(url, payload, headers)

Telegram

Telegram notifications are automated messages to a Telegram group. These notifications are rate-limited to 20 requests per 30 minutes. If you exceed the limit, each additional Telegram notification costs 5 QCC.

To send Telegram notifications in your code files, run:

Notify.Telegram(id, message, token);
self.Notify.Telegram(id, message, token)

The id argument is your Telegram user Id or group Id. Your group Id is in the URL when you open your group chat in the Telegram web interface. For example, the group Id of web.telegram.org/z/#-503016366 is -503016366.

Terms of Use

The notification system can't be used for data distribution.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: