Verifying an API

From Haasonline Software Wiki
Jump to: navigation, search

Sometimes, in some situations, we want to determine if an exchange API is currently operating or not. This could be difficult to find out, but using the following steps below, you should be able to verify if an API is working or not.


Step 1: Check the connection

Inside the API setup form, there is a field called "Is exchange connected". This field is checked when the software has accepted and stored your connection/authentication credentials. So if this is checked then in theory you should be proceed to the next step. If this field is not checked then you have to enter the your API credentials.

API credentials can be deleted by the software in case the credentials are wrong. If the software has tried to connect 3 times and all 3 times has failed, then and only then can the API credentials be deleted by the software itself.


Note

A connection to an exchange API is not accepted if there are no coins present on the exchange. It is a bit of strange rule, but we do not accept wallets that return empty (for checking the connections) because it might indicate the API is not running and therefore you could get a false reading. So we have hardcoded a limit for this. There must be at least a cent/satoshi/minimal amount of an altcoin inside your wallet to allow the API connection.


Note

Additional information about the connection and related messages is available inside the software its log viewer.


Step 2: Check the wallet

As soon as an exchange API is connected to the software, the software will begin to read the wallet. This wallet reading is done almost every minute, depending on how many bots you have running. It can scale to go faster and it can scale to go slower in update speed. But on average the update speed is every minute.

In general the wallet must always display the coins you have at the exchange, but there are a few situations where this might not be the case. These are the following:


1. The API has timed out and due to this, the wallet can temporarily not update its contents.

2. The API has dropped the connection and therefore the wallet could temporary not update.


In both cases, there is nothing you can do except wait. The software is able to restore the wallet reading but to do this, it requires a little time. In general, if the wallet is not there we recommend to check it again after 5 or 10 minutes to see if it has been restored. Generally, it to be expected everything restores itself.


If the situation arises where it does not restore itself, two things can be done. The API credentials can be setup again to refresh the entire connection or a simple restart of the software can resolve it. If both of these options fails, its recommended to contact us for support.


Note

If the wallet reading goes wrong because an API has changed or something then there should be an error message inside the software logs.


Step 3: Check trading

Once we have made sure the connection is valid and the wallet is read, we can proceed by checking the trade commands to the API. And in order to do this we have to begin to setup a trade-bot. Inside the trade-bot, we have to select a currency pair, trade-amount, coin position, and then we should be ready to do an test trade. Of course, the pair must have coins, the trade-amount must be correct and the coin position must be valid. The trade-bot will show some comments about it on the bottom on the screen.

If the trade-bots says "Perfect" (or an related perfect messages) then you should be able to press the "Buy now" or "Sell now" button (depending on your coin position of course). When you press one of those buttons, an order will be sent over and you will see an notification confirming this. The bot’s log will record the forced trade and the software’s logbook will save any details that will happen because of the trade.

We expect that this trade will happen normally. If it does not please proceed with the next 2 questions:


1. Does the trading pair (the coins) have any coins inside to trade?

2. Is the trade-amount and coin position valid?


If you are certain that this is accurate, then we have to find out why the trade does not happen. To do this we have to read the bot’s debug log to see why the trade has failed. We should also read the software logs to see if there are any messages in there. The software logs should have written down the exact details why the trade might not have happened.