API connections are great, though occasionally you may see indications in your account that an API sync has failed. While it can be frustrating, there are a few simple steps we can take to get that API up and running.
Please Note: If you see the message "Sync in progress" when you try to connect your API, this means that the API integration is actively working to bring over your transaction history. This can take some time, so please be patient!
In this article:
- How do I know if my API isn't syncing?
- What do I do when I notice a failed API connection?
-
How do I remove and reconnect an API connection in my account?
- Common causes of failed API connections
How do I know if my API isn't syncing?
To check whether or not your API or wallet connection is still synced, you can go to 'Sources' > Select the exchange or wallet you want to check > Look at the status message directly below that connection:
In that message, you'll see whether the last sync succeeded or failed, and the date and time the last sync was attempted. If your status message says 'Last Sync Failed on {date and time},” then your API connection is failing to sync.
What do I do when I notice a failed API connection?
You will see a message in your TaxBit account whenever your API connection fails to sync. That message will let you know what is causing your API sync to fail. Below are some of the messages that you may encounter and guidance on what you should do based on the message you see.
Please Note: The messages below say "API Connection" but in your TaxBit account, it will be specific to which API Connection is failing to sync. For example, if your ETH Wallet connection is failing to sync, a message will say something like: "An internal error occurred, we were unable to sync ETH Wallet".
If you encounter one of these following messages in your account, your next step will be to wait and then try to sync that API connection again later:
- "API Connection did not sync. Please wait a few hours and try again."
- "API Connection did not sync due to an error from the exchange. You can try again later or learn more."
- "API Connection did not sync. This is likely a temporary issue, so please try again later."
In regards to your API keys, if come across any of the following messages listed below here, your next steps will be to check your credentials, create new API Keys, or check that the correct permissions were given then run a sync again:
-
"API Connection did not sync because your login information is incorrect. Please update your credentials. Learn more."
- "API Connection did not sync because your API Keys have expired. Please update your API Keys. Learn more."
- "API Connection did not sync because we don’t have the right permissions. Please update your permissions and try again. Learn more"
If none of the messages you see are listed or you come across the following messages in your account, you should contact support if it involves a TaxBit Network API:
-
"Something happened during your last sync and your transaction data may not be accurate. Learn more."
- "While much of your data has synced successfully, some of your assets were not recognized in our system."
- "An internal error occurred, we were unable to sync API Connection. Learn more."
- "Some of your data has synced correctly, but a portion of your transactions did not sync due to an error. Learn more."
- "API Connection did not sync because it is not currently supported. Learn more."
-
"API Connection did not sync due to trying to import too many transactions. Contact customer support for help."
- "We were unable to sync API Connection. Learn More."
How do I remove and reconnect an API connection in my account?
To do this, navigate to 'Sources' > Select the exchange or wallet you want to remove > Select 'Manage' in the top right hand corner of the connection you are trying to remove.
From there, you'll select the trash can icon to remove that connection from your account.
You'll then see a pop up to select either keeping or removing the transactions that came from the API connection. After you've done that, go ahead and hit "Remove"
Next, pull up the matching API set up guide for the platform you're having issues with. These guides will walk you step-by-step through correctly setting up a successful API connection.
While setting up that connection, always follow the API set up guide when available to avoid some of these common mistakes:
- Entering the wrong credentials into the API set up fields. For example, entering your private key in the field labeled API key on TaxBit, and entering your API key into the field labeled private key.
- Giving the API key permissions beyond 'read only'. The terminology on a particular platform may be different, but generally speaking we don't want to be able to make any changes to the account you're trying to connect using that API key.
Common causes of failed API connections
In general, there are two reasons an API connection has failed:
- Authentication errors: Either the API you set up has expired, has been removed, or has been disabled by the platform. While this is not something TaxBit can fix, you can generally resolve this issue by setting up a new API key and connecting that new key to your account.
- Non-authentication errors: There are a multitude of potential causes, but generally it means we need our development team to look into the issue to determine if it's something we can fix on our end, or if the issue can only be fixed by the exchange.
For non-authentication errors, please be patient while we work with our dev team on this. We are continually working on release fixes to our API integrations to ensure the best possible experience for you. However, there may be delays as we often rely on the exchange to make the necessary changes for fixing the API connection.
If you need to import data into your account before we are able to release a fix, you can always manually format and import a CSV or manually add transactions to your account.
Still have questions? You can interact with our Chatbot by selecting the Chat Widget located at the bottom right side of your screen, or fill out this form HERE to submit a support inquiry request. Our team is happy to help!
Disclaimer: Keywords below are added to articles to enhance searching for content within our Help Center.
Keywords:
API Connection Sync Fail
API Failing to Sync
Sync Failed