2. Configuration¶
Configuring the bot can be as simple as select the exchange to use and copy-pasting your API key and Secret.
New features are required to be backwards compatible with previous versions of the .cfg but it is still recommended that you update your config immediately after updating to take advantage of new features.
To begin, copy default.cfg.example
to default.cfg
. Now you can edit your settings.
2.1. Exchange selection, API key and Secret¶
Select the exchange to use in attribute exchange
. Supported are Poloniex
and Bitfinex
. Default is Poloniex.
exchange = Poloniex
orexchange = Bitfinex
Create a NEW API key and Secret from Poloniex or Bitfinex and paste them into the respective slots in the config.
apikey = XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX
secret = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...
Warning
Do not share your API key nor secret with anyone whom you do not trust with all your Poloniex funds.
Note
If you use an API key that has been used by any other application, it will likely fail for one application or the other. This is because the API requires a nonce.
Poloniex
Your Poloniex API key is all capital letters and numbers in groups of 8, separated by hyphens. Your secret is 128 lowercase letters and numbers.
HIGHLY Recommended:
- Disable the “Enable Trading” checkbox. The bot does not need it to operate normally.
- Enable IP filter to only the IP address the bot will be running from.
Bitfinex
Your Bitfinex API key and secret are both 43 letters and numbers.
HIGHLY Recommended:
- The lending bot needs only READ permission to “Account History”, “Marging Funding”, “Wallets” and WRITE permission to “Margin Funding” and “Wallets”. Deselect all other on key generation, especially to “Withdraw”.
2.2. Exchange Sections¶
There is a section for each exchange to configure exchange specific attributes.
all_currencies
List of all supported currencies for funding. The list have to change only when the exchange adds a new supported currency or removes one. You can blacklist specific currencies by prefacing it with a ‘#’, this is the same as not including it on the list.- Format:
BTC,BTS,CLAM,DOGE,DASH,LTC,MAID,XMR,XRP,ETH,FCT,#BTG
- Format:
2.3. Timing¶
sleeptimeactive
is how long the bot will “rest” (in seconds) between running while the bot has loan offers waiting to be filled.- Default value: 60 seconds
- Allowed range: 1 to 3600 seconds
- If the bot finishes a cycle and has no open lend orders left to manage, it will change to inactive mode.
Note
Just because 1 second is a permitted sleeptime does not mean it is a good idea.
sleeptimeinactive
is how long the bot will “rest” (in seconds) between running while the bot has nothing to do.- Default value: 300 seconds (5 minutes)
- Allowed range: 1 to 3600 seconds
- If the bot finishes a cycle and has lend orders to manage, it will change to active mode.
timeout
is how long the bot waits for a response of a request- Default value: 30 seconds
- Allowed range: 1 to 180 seconds
2.4. Min and Max Rates¶
mindailyrate
is the minimum rate (in percent) that the bot will allow offer loans at.- Default value: 0.005 percent
- Allowed range: 0.0031 to 5 percent
- 0.0031% every day for a year, works out around 1%. This is less than most bank accounts and is considered not worth while.
- The current default value is a optimistic but very viable for the more high volume currencies. Not viable for lending DOGE, for example.
maxdailyrate
is the maximum rate (in percent) that the bot will allow lends to open.- Default value: 5 percent
- Allowed range: 0.0031 to 5 percent
- 2% is the default value offered by the exchange, but there is little reason not to set it higher if you feel optimistic.
frrasmin
tells the bot whether or not to use the flash return rate formindailyrate
.- Default value: False
- Allowed range: True or False
- This will only be used if the frr is above your
mindailyrate
. So which ever is highest at the time of the loan will be used. - This options only works on Bitfinex.
frrdelta
tells the bot whether or not to use the flash return rate <https://support.bitfinex.com/hc/en-us/articles/115003284729-What-is-the-FRR-Delta->- Default value: 0.0000
- Allowed range: 0.0000 -/+ 7
- This will only be used if the frr is above your
mindailyrate
. So which ever is highest at the time of the loan will be used. - This options only works on Bitfinex.
2.5. Spreading your Lends¶
If spreadlend = 1
and gapbottom = 0
, it will behave as simple lending bot lending at lowest possible offer.
spreadlend
is the amount (as an integer) of separate loans the bot will split your balance into across the order book.- Default value: 3
- Allowed range: 1 to 20 (1 is the same as disabling)
- The loans are distributed evenly between gapbottom and gaptop.
- This allows the bot to benefit from spikes in lending rate but can result in loan fragmentation (not really a bad thing since the bot has to deal with it.)
gapMode
is the “mode” you would like your gaps to be calculated in.- Default value: Relative
- Allowed values: Relative, RawBTC, Raw
- The values are case insensitive.
- The purpose of spreading your lends is to skip dust offers in the lendbook, and also to take advantage of any spikes that occur.
- Mode descriptions:
Relative
-Gapbottom
andGaptop
will be relative to your balance for each coin individually.- This is relative to your total lending balance, both loaned and unloaned.
gapbottom
andgaptop
will be in percents of your balance. (A setting of 100 will equal 100%)- Example: You have 1BTC. If
gapbottom = 100
then you will skip 100% of your balance of dust offers, thus skipping 1BTC into the lendbook. Ifgaptop = 200
then you will continue into the lendbook until you reach 200% of your balance, thus 2BTC. Then, ifspreadlend = 5
, you will make 5 equal volume loans over that gap.
RawBTC
-Gapbottom
andGaptop
will be in a raw BTC value, converted to each coin.- Recommended when using one-size-fits-all settings.
gapbottom
andgaptop
will be in BTC. (A setting of 3 will equal 3 BTC)- Example: If
gapbottom = 1
and you are currently lending ETH, the bot will check the current exchange rate, say 1BTC = 10ETH. Then the bot will skip 10ETH of dust offers at the bottom of the lendbook before lending. Ifgaptop = 10
, then using the same exchange rate 10BTC will be 100ETH. The bot will then continue 100ETH into the loanbook before stopping. Then, ifspreadlend = 5
, you will make 5 equal volume loans over that gap.
Raw
-Gapbottom
andGaptop
will be in a raw value of the coin being lent.- Recommended when used with coin-specific settings.
gapbottom
andgaptop
will be in value of the coin. (A setting of 3 will equal 3 BTC, 3 ETH, 3 DOGE, or whatever coin is being lent.)- Example: If
gapbottom = 1
and you are currently lending ETH, the bot will skip 1ETH of dust offers at the bottom of the lendbook before lending. Ifgaptop = 10
, the bot will then continue 10ETH into the loanbook before stopping. Then, ifspreadlend = 5
, you will make 5 equal volume loans over that gap.
gapbottom
is the lower setting for yourgapMode
values, and will be where you start to lend.- Default value: 10 percent
- Allowed range: 0 to <arbitrary large number>
- 10% gapbottom is recommended to skip past dust at the bottom of the lending book, but if you have a VERY high volume this will cause issues as you stray to far away from the most competitive bid.
gaptop
is the upper setting for yourgapMode
values, and will be where you finish spreading your lends.- Default value: 200 percent
- Allowed range: 0 to <arbitrary large number>
- This value should be adjusted based on your coin volume to avoid going astronomically far away from a realistic rate.
2.6. Variable loan Length¶
These values allow you to lock in a better rate for a longer period of time, as per your configuration.
xdaythreshold
is the rate (in percent) where the bot will begin attempting to lend for a longer period of time.- Default value: 0.2 percent
- Allowed range: 0 to 5 percent
xdays
is the length(in days) of any loan whose rate exceeds the set xdaythreshold.- Default value: 60 days
- Allowed range: 2 to 60 days
xdayspread
will spread the lending days by incrementing linear from 2 days at (xdaythreshold/xdayspread) rate to xdays days at xdaythreshold rateDefault value: 0 (disabled)
Allowed range: 0 to 10 as float
Example: Using values: xdaythreshold = 0.2, xdays = 60, xdayspread = 2, the bot will lend:
- rates < 0.1% (=xdaythreshold/xdayspread) for 2 days
- rates between 0.1% and 0.2%: days will be incremented from 2 to 60 days
(e.g. 0.1%/2d, 0.11%/8d, 0.12%/14d, 0.13%/20d, 0.14%/26d, 0.15%/32d, 0.16%/38d, 0.17%/44d, 0.18%/50d, 0.19%/56d, 0.20%/60d)
- rates > 0.2% for 60 days
2.7. Auto-transfer from Exchange Balance¶
If you regularly transfer funds into your Poloniex account but don’t enjoy having to log in yourself and transfer them to the lending balance, this feature is for you.
transferableCurrencies
is a list of currencies you would like to be transferred.- Default value: Commented out
- Format:
CURRENCY_TICKER,STR,BTC,BTS,CLAM,DOGE,DASH,LTC,MAID,XMR,XRP,ETH,FCT,ALL,ACTIVE
- Commenting it out will disable the feature.
- Entering
ACTIVE
within the list will transfer any currencies that are found in your lending account, as well as any other currencies alongside it. Example:ACTIVE, BTC, CLAM
will do BTC, CLAM, and any coins you are already lending. - Entering
ALL
will simply transfer all coins available to lending. - Do not worry about duplicates when using
ACTIVE
, they are handled. - Coins will be transferred every time the bot runs (60 seconds by default) so if you intend to trade or withdrawal it is recommended to turn off the bot or disable this feature.
2.8. Unimportant settings¶
Very few situations require you to change these settings.
minloansize
is the minimum size that a bot will make a loan at.- Default value: 0.01 of a coin
- Allowed range: 0.01 and up.
- If you dislike loan fragmentation, then this will make the minimum for each loan larger.
- Automatically adjusts to at least meet the minimum of each coin.
KeepStuckOrders
If True, keeps orders that are “stuck” in the market instead of canceling them.- Default value: True
- Allowed values: True or False
- A “Stuck” order occurs when it partially fills and leaves the coins balance total (total = open orders + let in balance) below your
minloansize
and so the bot would not be able to lend it again if it was canceled. - When disabled, stuck orders will be canceled and held in balance until enough orders expire to allow it to lend again.
hideCoins
If True, will not lend any of a coin if its market low is below the setmindailyrate
.- Default value: True
- Allowed values: True or False. Commented defaults to True
- This hides your coins from appearing in walls.
- Allows you to catch a higher rate if it spikes past your
mindailyrate
. - Not necessarily recommended if used with
analyseCurrencies
with an aggressivelendingStyle
, as the bot may miss short-lived rate spikes. This is not the case if usingMACD
withdaily_min_method
. In that case it is recommended to sethideCoins
to True. - If you are using the
analyseCurrencies
option, you will likely see a lot ofNot lending BTC due to rate below 0.9631%
type messages in the logs. This is normal.
endDate
Bot will try to make sure all your loans are done by this date so you can withdraw or do whatever you need.- Default value: Disabled
- Uncomment to enable.
- Format:
YEAR,MONTH,DAY
2.9. Max to be lent¶
This feature group allows you to only lend a certain percentage of your total holding in a coin, until the lending rate suprasses a certain threshhold. Then it will lend at max capacity.
maxtolend
is a raw number of how much you will lend of each coin whose lending rate is belowmaxtolendrate
.- Default value: Disabled
- Allowed range: 0 (disabled) or
minloansize
and up - If set to 0, same as if commented.
- If disabled, will check if
maxpercenttolend
is enabled and use that if it is enabled. - Setting this overwrites
maxpercenttolend
- This is a global setting for the raw value of coin that will be lent if the coins lending value is under
maxtolendrate
- Has no effect if current rate is higher than
maxtolendrate
- If the remainder (after subtracting
maxtolend
) in a coin’s balance is less thanminloansize
, then the remainder will be lent anyway. Otherwise, the coins would go to waste since you can’t lend underminloansize
maxpercenttolend
is a percentage of how much you will lend of each coin whose lending rate is belowmaxtolendrate
- Default value: Disabled
- Allowed range: 0 (disabled) to 100 percent
- If set to 0, same as if commented.
- If disabled in addition to
maxtolend
, entire feature will be disabled. - This percentage is calculated per-coin, and is the percentage of the balance that will be lent if the coin’s current rate is less than
maxtolendrate
- Has no effect if current rate is higher than
maxtolendrate
- If the remainder (after subtracting
maxpercenttolend
’s value) in a coin’s balance is less thanminloansize
, then the remainder will be lent anyway. Otherwise, the coins would go to waste since you can’t lend underminloansize
maxtolendrate
is the rate threshold when all coins are lent.- Default value: Disabled
- Allowed range: 0 (disabled) or
mindailyrate
to 5 percent - Setting this to 0 with a limit in place causes the limit to always be active.
- When an indiviaual coin’s lending rate passes this threshold, all of the coin will be lent instead of the limits
maxtolend
ormaxpercenttolend
2.10. Config per Coin¶
This can be configured in one of two ways.
Coincfg dictionary
coinconfig
is now REMOVED, please switch to using separate coin sections as described below.
Separate coin sections
This is an alternative layout for the coin config mentioned above. It provides the ability to change the minloansize per coin, but is otherwise identical in functionality. To use this configuration, make sure to comment out the line where coincfg is defined, then add a section for each coin you wish to configure.
Warning
These sections should come at the end of the file, after the other options for the bot.
Configuration should look like this:
[BTC]
minloansize = 0.01
mindailyrate = 0.1
maxactiveamount = 1
maxtolend = 0
maxpercenttolend = 0
maxtolendrate = 0
gapmode = raw
gapbottom = 10
gaptop = 20
frrasmin = true
frrdelta = 0.000000
2.11. Advanced logging and Web Display¶
jsonfile
is the location where the bot will log to a .json file instead of into console.- Default value: Commented out, uncomment to enable.
- Format:
www/botlog.json
- This is the location relative to the running instance of the bot where it will store the .json file. The default location or a path inside the
customWebServerTemplate
folder is recommended if using the webserver functionality.
jsonlogsize
is the amount of lines the botlog will keep before deleting the oldest event.- Default value: Commented out, uncomment to enable.
- Format:
200
- Reasons to lower this include: you are conscious of bandwidth when hosting your webserver, you prefer (slightly) faster loading times and less RAM usage of bot.
startWebServer
if true, this enables a webserver on the www/ folder.- Default value: Commented out, uncomment to enable.
- The server page can be accessed locally, at
http://localhost:8000/lendingbot.html
by default. - Forces
jsonfile
to be set usingwww/botlog.json
(unless otherwise configured) - You must close bot with a keyboard interrupt (CTRL-C on Windows) to properly shutdown the server and release the socket, otherwise you may have to wait several minutes for it to release itself.
customWebServerAddress
is the IP address that the webserver can be found at.- Advanced users only.
- Default value: 0.0.0.0 Uncomment to change
- Format:
IP
- Setting the ip to
127.0.0.1
will ONLY allow the webpage to be accessed at localhost (127.0.0.1
) - Setting the ip to
0.0.0.0
will allow the webpage to be accessed at localhost (127.0.0.1
) as well as at the computer’s LAN IP address within the local network. This option is the most versatile, and is default. - Setting the ip to
192.168.0.<LAN IP>
will ONLY allow the webpage to be access at the computer’s LAN IP address within the local network (And not through localhost.) It is recommended to be sure the device has a static local IP. - You must know what you are doing when changing the IP address to anything other than the three suggested configurations above.
customWebServerPort
is the IP port that the webserver can be found at- Advanced users only.
- Default value: 8000 Uncomment to change
- Format:
PORT
- Do not set the port to a reserved port or you will receive an error when running the bot or attempting to connect (depending on HOW reserved a port is.)
- When you like to run more than one bot on same host (e.g. the first to lend on Poloniex and another one to lend on Bitfinex) different port numbers have to defined. (e.g 8000 in Poloniex’s config and 8001 in Bitfinex’s config file)
customWebServerTemplate
is the location the bot will use for WebServer HTML GUI template.- Default value: www, uncomment to enable.
- Format:
PATH
- This is the location relative to the running HTML GUI instance used by the bot. Be sure the
jsonfile
belongs to this folder.
outputCurrency
this is the ticker of the coin which you would like the website to report your summary earnings in.- Default value: BTC
- Acceptable values: BTC, USDT, Any coin with a direct Poloniex BTC trading pair (ex. DOGE, MAID, ETH), Currencies that have a BTC exchange rate on blockchain.info (i.e. EUR, USD)
- Will be a close estimate, due to unexpected market fluctuations, trade fees, and other unforseeable factors.
label
is a custom name of the bot, that will be displayed in html page.- Default value: Lending Bot
- Allowed values: Any literal string
2.12. Plugins¶
Plugins allow extending Bot functionality with extra features.
To enable/disable a plugin add/remove it to the plugins
list config option under the [BOT] section, example:
plugins = Plugin1, Plugin2, etc...
Plugins can add their own HTML pages by calling self.log.addSectionlog('plugins', '<pluginName>', 'navbar', True);
within their init code.
This will add a navbar element on the main lendingbot.html page linking to <pluginName>.html
2.12.1. AccountStats Plugin¶
The AccountStats plugin fetches all your loan history and provides statistics based on it. Current implementation sends a earnings summary Notification (see Notifications sections) every 24hr.
To enable the plugin add AccountStats
to the plugins
config options, example:
plugins = AccountStats
There is an optional setting to change how frequently this plugin reports. By default, once per day. Example:
[ACCOUNTSTATS]
ReportInterval = 1800
Be aware that first initialization might take longer as the bot will fetch all the history.
2.12.2. Profit Charts Plugin¶
The Charts plugin dumps out the historical lending data to a JSON structure which is read by the new charts.html page. This page reads this dump data and constructs a Google Chart showing daily profit over time.
The AccountStats plugin must be enabled for the Charts plugin to function correctly.
To enable the plugin add Charts
to the plugins
config options, example:
plugins = AccountStats,Charts
There is an optional setting to change how frequently this plugin dumps data and where that data file is located. By default, four times per day. Example:
[CHARTS]
DumpInterval = 21600
HistoryFile = www/history.json
On a new installation, the AccountStats database may not be up to date on first iteration of the Charts plugin and no data will get dumped. Simply wait for the next interval or restart the bot after the AccountStats plugin is finished.
2.13. lendingbot.html options¶
You can pass options to statistics page by adding them to URL. Eg, http://localhost:8000/lendingbot.html?option1=value&option2=0
effrate
controls how effective loan rate is calculated. Yearly rates are calculated based on effective rate, so this option affects them as well. Last used mode remembered by browser, so you do not have to specify this option every time. By default, effective loan rate is calculated considering lent precentage (from total available coins) and poloniex 15% fee.- Allowed values:
lentperc
,onlyfee
. - Default value:
lentperc
. onlyfee
calculates effective rate without considering lent coin percentage.
- Allowed values:
displayUnit
controls BTC’s unit output.- Allowed values:
BTC
,mBTC
,Bits
,Satoshi
- Default value:
BTC
- This setting will change all display of Bitcoin to that unit. Ex. 1 BTC -> 1000 mBTC.
- Allowed values:
earningsInOutputCurrency
define which earnings are shown in the output currency.- Allowed values:
all
,summary
- Default value:
all
- Allowed values:
2.14. Notifications¶
The bot supports sending notifications for serveral different events on several different platforms. To enable notifications, you must first have a section in your config called [notifications]
, inside which you should enable at least one of the following events and also at least one notification platfom. The list of events you can notify about are:
2.14.1. Global Notification Settings¶
notify_new_loans
- Sends a notification each time a loan offer is filled.
notify_tx_coins
- This will send a notification if any coins are transferred from your exchange account, to your lending account. You must have
transferableCurrencies
enabled for this to work. Then you should setnotify_tx_coins = True
.
- This will send a notification if any coins are transferred from your exchange account, to your lending account. You must have
notify_xday_threshold
- This will send a notification every time a loan is created that is above your
xdaythreshold
config value. To enable you should setnotify_xday_threshold = True
.
- This will send a notification every time a loan is created that is above your
notify_summary_minutes
- This will send a summary of the current loans you have every X minutes. This is similar to the information you get in the log line when running the bot, or the line a the top of the web page. To enable this add
notify_summary_minutes = 120
. This will send you a notification every 2 hours (120 minutes).
- This will send a summary of the current loans you have every X minutes. This is similar to the information you get in the log line when running the bot, or the line a the top of the web page. To enable this add
notify_caught_exception
- This is more useful for developers and people wanting to help out by raising issues on github. This will send a notification every time there is an exception thrown in the bot that we don’t handle. To enable add
notify_caught_exception = True
.
- This is more useful for developers and people wanting to help out by raising issues on github. This will send a notification every time there is an exception thrown in the bot that we don’t handle. To enable add
notify_prefix
- This string, if set, will be prepended to any notifications. Useful if you are running multiple bots and need to differentiate the source.
Once you have decided which notifications you want to recive, you can then go about configuring platforms to send them on. Currently the bot supports:
2.14.2. Email notifications¶
This is probably the easiest to configure, though there can still be issues with gmail where you need to enable a few things. You can find out more about that here if you’re having problems. If you don’t wish to use gmail search google for the smtp settings of your email provider. To enable email you should configure the following:
email = True
email_login_address = me@gmail.com
email_login_password = secretPassword
email_smtp_server = smtp.gmail.com
email_smtp_port = 465
email_smtp_starttls = False
email_to_addresses = me@gmail.com,you@gmail.com
2.14.3. Slack notifications¶
Before you can post to slack you need to create an API token, to do this visit this page. Once you have a token you can then configure the bot as so:
slack = True
slack_token = xoxp-46351793751-46348393136-47931965411-a8757952e4
slack_channels = #cryptocurrency,@someUser
To post in a channel prefix with # and to post a dm to a user prefix with @. You can send to as many channels or users as you want.
2.14.4. Telegram notifications¶
- Quickstart
To have telegram notifications you need to get a bot id from the BotFather. You can do that here. Once you have a bot id you need to get your Chat ID or create a channel and invite the bot so it can chat there. Once you have all this in place you configure it like so:
telegram = True telegram_bot_id = 281421543:AGGB1TqP7XqhxhT7VOty0Aml8DV_R6kimHw telegram_chat_ids = 123456789,@cryptocurrency
- Detailed
Messages are sent to the telegram bot API using HTTPS requests. You can read more about it here.
Telegram Bots are special accounts that do not require an additional phone number to set up, they do however need a unique authentication token. This is the token we need to get and add to the lendingbot’s default.cfg. They are normally in the format
123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
.When we say we are creating a new telegram bot, all it means is that we are creating an account for the lendingbot to send message through. To create a bot and get a token, we must request it from the BotFather. This is telegram’s tool for creating new bots.
- These are the steps to carry out:
- Install the telegram desktop client from their site. Then set it up with your phone number and login.
- Start a conversation with The BotFather. When you click the link it should open up in the telegram desktop client.
- Once you have a conversation started type
/newbot
, you’ll then be asked what to call the bot and it’s username. The name of your bot is displayed in contact details and elsewhere. The Username is a short name, to be used in mentions and telegram.me links. When complete you’ll receive a token. - You can check everything is working OK by going to https://api.telegram.org/bot*YOURTOKEN*/getme, for example my test one is https://api.telegram.org/bot288427377:AAGB1TqL7XqhxhT7VOxu8Ams8DV_J6kimHw/getme. If that’s all working then move on to the next step.
- Now we need somewhere to send the messages, if you want to send a message to yourself, you first need your Chat ID. The easiest way I’ve found to get this is to send the bot a message from your desktop client and then use the getupdates method. So search for the bot in the desktop client’s search bar and start a conversation. Then in your browser go to https://api.telegram.org/bot*YOURTOKEN*/getupdates. You should see a few lines of text, the one we’re interested in looks like
"chat":{"id":123456789,"first_name":"Michael","last_name":"Robinson","type":"private"}
. The number after ID is your chat ID. - Again, just to check everything is working, lets send ourselves a message. You can do this by putting this in your browser https://api.telegram.org/bot*YOURTOKEN*/sendmessage?text=TEST%20BOT&chat_id=*YOUR_CHAT_ID* You should see a message in your desktop client. If so you have the right ID and we can move on.
- The last step to get it working is just adding the two values to your default.cfg file and turning on
telegram = True
. You should settelegram_bot_id
to the token you got from the BotFather, and set thetelegram_chat_ids
to a comma separated list of people you want to send messages to. - (optional) If you’d like a specific channel for the bot to send messages you can follow these steps.
- Open the desktop client and create a new channel
- Start a conversation with the BotFather and type /setjoingroups, then follow the questsions he asks.
- Click on the message we sent earlier from the bot, then click on the bot’s name in the conversation. You should see ‘Add To Group’. Click this and add it to the new group you created.
- Now you should be able to add the
@nameOfChannel
to yourdefault.cfg
file and post all the updates there too. Make sure the list is comma separated and you have the ‘@’ infront of the channel name. This is only done for names, not Chat IDs.
2.14.5. Pushbullet notifications¶
To enable Pushbullet notifications, you first need to create an API key and then discover your device ID.
Visit your Account Settings and click ‘Create Access Token’. Add this to the config file as shown below.
You then need to visit this documentation page and run the example curl command for listing your devices (be sure to substitute your API token as created in the previous step). Copy the value listed for ‘iden’ into the config file as shown below.:
pushbullet = True
pushbullet_token = l.2mDDvy4RRdzcQN9LEWSy22amS7u3LJZ1
pushbullet_deviceid = ujpah72o0sjAoRtnM0jb
2.14.6. IRC notifications¶
IRC is very easy to configure, if you are already interested in using it you’ll understand what each of the options are.
The main thing to note is that you need to have the python module ‘irc’ installed. You can git it from pip like so:
pip install irc
Once you have that installed you have access to the following options for configuration:
irc = True
irc_host = irc.freenode.net
irc_port = 6667
irc_nick = LendingBot
irc_ident = ledningbot
irc_realname = Poloniex lending bot
irc_target = #bitbotfactory
If you want to send a message directly to a user rather than a channel, you can specify it in the irc_target without the preceeding ‘#’. There is currently only support for one channel or user, but we can add more if there’s any interest for it.