API Management

<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Bitsgap displays the current status of your connected API keys. Each status hints at what went wrong while connecting your keys to the platform. Let's take a closer look at each one of them.</p>
</div>
<div class="intercom-interblocks-heading intercom-interblocks-align-left">
<h2 id="h_2082f46e84">Statuses</h2>
</div>
<div class="intercom-interblocks-table">
<table style="width: 695px;">
<tbody>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-center">
<p><strong>Status</strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-center">
<p><strong>Description of the status</strong></p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-center">
<p><strong>Resolution</strong></p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Connected</strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Your key is connected and ready to be used.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-center">
<p>-</p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Expires in N* days</strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>The key will become inactive after the specified number of days.</p>
</div>
<div class="intercom-interblocks-horizontal-rule"><hr></div>
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>*N</strong> - number of days.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>On your exchange, <a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9948309520924" target="_blank" rel="noopener noreferrer">add our IP addresses</a> to the API key connected to Bitsgap.</p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Expired</strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Missing all the necessary permissions for the API key due to the security policy of the exchange.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Re-activate all requested permissions, renew the key, or <a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9948309520924" target="_blank" rel="noopener noreferrer">add our IP addresses</a> to the API key connected to Bitsgap.</p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Incorrect permissions </strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Missing or invalid API key permissions.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Check whether all required permissions are enabled, and compare them with the <a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9898682355868" target="_blank" rel="noopener noreferrer">instruction in our Help Center</a>.</p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Withdrawal enabled </strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>The API key can’t be used because the withdrawal permission is enabled.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Disable the withdrawal permission for the API key connected to Bitsgap.</p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Temporary issue </strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>The key is temporarily invalid due to issues on the exchange's side.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>No additional action is required; wait until the issue is resolved.</p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Invalid </strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>The key does not exist or cannot be used.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>The issue can be one of the following:<br>1. The key is not activated;<br>2. KYC check required on the exchange; <br>3. Your exchange account is frozen or disabled;</p>
</div>
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>To resolve this status, please contact the exchange's support team or create a new API key and try to connect it to Bitsgap <a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9898682355868" target="_blank" rel="noopener noreferrer">following our instructions in the Help Center</a>.</p>
</div>
</td>
</tr>
<tr>
<td style="width: 157.188px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p><strong>Inactive Futures</strong></p>
</div>
</td>
<td style="width: 256.3px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Your Binance API key does not allow futures trading.</p>
</div>
</td>
<td style="width: 248.312px;">
<div class="intercom-interblocks-paragraph no-margin intercom-interblocks-align-left">
<p>Register the Binance Futures account by following this <a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9919541399580" target="_blank" rel="noopener noreferrer">Help Center</a> article. If you have already opened the Futures account, check if the Futures trading permission is enabled for the connected API key.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="intercom-interblocks-horizontal-rule">&nbsp;</div>
<div class="intercom-interblocks-subheading4 intercom-interblocks-align-left">
<hr>
<h3 id="h_01JHXCVVA5V6VXV38JX7MKTBZB">What's Next?</h3>
<ul>
<li>
<strong><a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9948309520924" rel="noopener">Check Your API Settings</a></strong>: Ensure your API keys have the correct permissions for secure and uninterrupted trading.</li>
<li>
<strong><a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9807484280732">API Account Lock</a></strong>: Understand how Bitsgap safeguards your account with API restrictions.</li>
</ul>
<hr>
<h3 id="h_01JHXCVMEYK94JS9FQVGC6G8YV">Need Assistance?</h3>
<p>If you encounter any issues or have questions, don’t hesitate to contact the Bitsgap <a href="mailto:support@bitsgap.com"><span class="wysiwyg-underline" style="color: #1155cc;">Customer Support</span></a> Team.</p>
</div>

API Key Error Statuses

<p>Ensuring the security of your exchange account is a top priority. Some exchanges mandate IP whitelisting to use API keys with Bitsgap. Currently, this is required for <strong>Binance, KuCoin, Kraken, Crypto.com</strong>. This guide provides step-by-step instructions to update your API key permissions and include Bitsgap’s trusted IP addresses.</p>
<hr>
<h3 id="h_01JHXD8TXBM1T8ZDMJD17B2HT6">Overview</h3>
<ul>
<li><a href="#h_01JHXD7DNAWWA7CDHXJD8A95H0">Fast Replace (Binance, KuCoin &amp; OKX)</a></li>
<li><a href="#h_01JHXD7DNAG7Z4F5APEMAXHE3M">Manual Replace</a></li>
<li><a href="#h_01JHXD7DNA9ZK9AMZAWGMJP5C0">Adding Trusted IP Addresses to an Existing API Key</a></li>
</ul>
<hr>
<h3 id="h_01JHXD7DNAWWA7CDHXJD8A95H0">Fast Replace</h3>
<p><em>Fast Replace</em> simplifies updating API keys and is available for Binance, KuCoin and OKX exchanges. Follow these steps:</p>
<ol>
<li>
<strong>Go to the My Exchanges Page</strong><strong><br></strong>Navigate to <strong>Bitsgap &gt; My Exchanges</strong>, click the three dots (<strong>More</strong>) next to your exchange, and select <strong>Replace API key</strong>.</li>
</ol>
<p class="wysiwyg-indent1 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004921681436" width="536" height="275"></p>
<ol start="2">
<li>
<strong>Renew the API Key</strong><strong><br></strong>Click the <strong>Replace</strong> button to generate a new API key automatically.</li>
</ol>
<p class="wysiwyg-indent1 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004921681820" width="522" height="642"></p>
<ol start="3">
<li>
<strong>Check the Connection Status</strong><strong><br></strong>The system will create a new API key named “Bitsgap_com” with the required permissions and connect it to Bitsgap.</li>
</ol>
<p class="wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004921682204" width="691" height="285"></p>
<hr>
<h3 id="h_01JHXD7DNAG7Z4F5APEMAXHE3M">Manual Replace</h3>
<p>For exchanges that don’t support <a href="#h_01JHXD7DNAWWA7CDHXJD8A95H0"><em>Fast Replace</em></a>, follow these steps to manually update your API key.</p>
<ol>
<li>
<strong>Access the My Exchanges Page</strong><strong><br></strong>Go to <strong>Bitsgap &gt; My Exchanges</strong>, click the three dots (<strong>More</strong>) next to your exchange, and select <strong>Replace API key</strong>.</li>
</ol>
<p class="wysiwyg-indent1 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004879396636" width="624" height="321"></p>
<ol start="2">
<li>
<strong>Copy Bitsgap’s Trusted IP Addresses</strong><strong><br></strong>In the <em>Manual Replace</em> window, click the <strong>Copy</strong> icon to save the list of trusted IP addresses.</li>
</ol>
<p class="wysiwyg-indent1 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004921682716" width="292" height="435"></p>
<ol start="3">
<li>
<strong>Log In to Your Exchange</strong><strong><br></strong>Navigate to the API settings in your exchange account and <a href="https://bitsgap.com/helpdesk/category/9837454117788-Connect-your-exchange">create a new key.</a>
</li>
<li>
<strong>Set Permissions and Whitelist IPs</strong>
<ul>
<li>Adjust the API permissions. Refer to detailed permission settings for <a href="https://bitsgap.com/helpdesk/article/9898682355868-How-to-create-and-set-up-Binance-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Binance</span></strong></a>, <a href="https://bitsgap.com/helpdesk/article/9900297148188-How-to-create-and-set-up-Kucoin-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Kucoin</span></strong></a>, <a href="https://bitsgap.com/helpdesk/article/9932313131932-How-to-create-and-set-up-Kraken-Pro-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Kraken</span></strong></a> and <a href="https://bitsgap.com/helpdesk/article/10087762559260-How-to-create-and-set-up-Crypto-com-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Crypto.com</span></strong></a> and <a href="https://bitsgap.com/helpdesk/category/9837454117788-Connect-your-exchange"><span class="wysiwyg-underline" style="color: #1155cc;">other exchanges</span></a>.</li>
<li>Add the copied IP addresses to the whitelist.</li>
<li>Click <strong>Save</strong> or <strong>Submit</strong> to confirm the changes.</li>
</ul>
</li>
</ol>
<ol start="5">
<li>
<strong>Enter API Information in Bitsgap</strong>
<ul>
<li>Paste the API Key, Secret Key, and Passphrase (if required) into the <em>Manual Replace</em> window.</li>
<li>Click <strong>Replace</strong>.</li>
</ul>
</li>
</ol>
<p class="wysiwyg-indent2 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004921683356" width="367" height="475"></p>
<hr>
<h3 id="h_01JHXD7DNA9ZK9AMZAWGMJP5C0">Adding Trusted IP Addresses to an Existing API Key</h3>
<p>If you need to adjust permissions for an existing API key, follow these steps:</p>
<ol>
<li>
<strong>Access My Exchanges</strong><strong><br></strong>Go to <strong>Bitsgap &gt; My Exchanges</strong> and click the <strong>Fix</strong> button next to the API key.</li>
</ol>
<p class="wysiwyg-indent1 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004921684764" width="624" height="264"></p>
<ol start="2">
<li>
<strong>Copy Bitsgap’s Trusted IP Addresses</strong><strong><br></strong>Save the IP addresses provided in the pop-up window by clicking the <strong>Copy</strong> icon.</li>
</ol>
<p class="wysiwyg-indent1 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004921685020" width="253" height="339"></p>
<ol start="3">
<li>
<strong>Navigate to Your Exchange’s API Management</strong><strong><br></strong>Locate your API key in <a href="https://bitsgap.com/helpdesk/category/9837454117788-Connect-your-exchange">the exchange’s API management section</a> and click <strong>Edit</strong>.</li>
<li>
<strong>Update IP Restrictions and Permissions</strong>
<ul>
<li>Add the copied IP addresses to the whitelist.</li>
<li>Adjust permissions as required by Bitsgap. Refer to detailed permission settings for <a href="https://bitsgap.com/helpdesk/article/9898682355868-How-to-create-and-set-up-Binance-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Binance</span></strong></a>, <a href="https://bitsgap.com/helpdesk/article/9900297148188-How-to-create-and-set-up-Kucoin-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Kucoin</span></strong></a>, <a href="https://bitsgap.com/helpdesk/article/9932313131932-How-to-create-and-set-up-Kraken-Pro-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Kraken</span></strong></a>, <a href="https://bitsgap.com/helpdesk/article/10087762559260-How-to-create-and-set-up-Crypto-com-API-key"><strong><span class="wysiwyg-underline" style="color: #1155cc;">Crypto.com</span></strong></a> and <a href="https://bitsgap.com/helpdesk/category/9837454117788-Connect-your-exchange"><span class="wysiwyg-underline" style="color: #1155cc;">other exchanges</span></a>.</li>
<li>Save your changes.</li>
</ul>
</li>
<li>
<strong>Refresh the Connection in Bitsgap</strong>
<ul>
<li>Return to the <strong>My Exchanges</strong> page and click <strong>Refresh</strong>.</li>
</ul>
</li>
</ol>
<p class="wysiwyg-indent2 wysiwyg-text-align-center"><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/18004879401372" width="275" height="370"></p>
<hr>
<h3 id="h_01JHXEKX9BQXJTTPYZTJMZHYGD">What's Next?</h3>
<ul>
<li>
<strong><a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/13091203806364">Connect Your Exchange</a></strong>: Learn how to securely link your exchange accounts to Bitsgap using API keys.</li>
<li>
<strong><a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/13091210942364">Launch Your First Bot</a></strong>: Start automated trading with step-by-step instructions for setting up your first bot.</li>
</ul>
<hr>
<h3 id="h_01JHXDB7GYSWE86A0HP61PKGZM">Need Assistance?</h3>
<p>If you encounter any issues or have questions, don’t hesitate to contact the Bitsgap <a href="mailto:support@bitsgap.com"><span class="wysiwyg-underline" style="color: #1155cc;">Customer Support</span></a> Team.</p>

Updating API Key Permissions with Trusted IP Addresses

<p>The <strong>API Account Lock</strong> algorithm ensures that one API key is not reused across multiple Bitsgap accounts. This feature optimizes API data verification and enhances the security of your exchange connections.</p>
<hr>
<h3 id="h_01JHXCFPFNYK2CPBWWN4TGCD5F">How It Works</h3>
<ul>
<li>The system <strong>prevents adding an API key</strong> if:
<ol>
<li>The key has been previously connected to another Bitsgap account.</li>
<li>More than 24 hours have passed since the key was removed from the platform.</li>
</ol>
</li>
</ul>
<hr>
<h3 id="h_01JHXCFPFN6PAA2X39D1ZTDB7X">What Happens If I Use the Same API Key?</h3>
<ol>
<li class="wysiwyg-text-align-center">You will receive an <strong>email notification</strong> sent to the account where the API key is already connected.<br><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/10422454844828" alt="Untitled (26).png">
</li>
<li class="wysiwyg-text-align-center">A <strong>pop-up notification</strong> will appear, indicating that the API key is linked to another Bitsgap account.<br><img src="https://bitsgap4907.zendesk.com/hc/article_attachments/10422454845980" alt="Untitled (27).png">
</li>
<li>The key will be flagged with an <strong>API error status</strong> on the "My Exchanges" page.</li>
</ol>
<hr>
<h3 id="h_01JHXCFPFNGJ239TCSKN4MAJYH">Resolving the "API Account Lock" Error</h3>
<ul>
<li>
<p><strong>For a new account</strong>:<br>Log in to your exchange, create a new API key, and connect it to your Bitsgap account.</p>
</li>
<li>
<p><strong>If you receive an error but haven’t linked the API key</strong>:</p>
<ol>
<li>Log in to your exchange account.</li>
<li>Delete all unused API keys.</li>
<li>Create a new API key for Bitsgap.</li>
</ol>
</li>
</ul>
<p><strong>Note</strong><br>The system will stop sending notifications if the correct key is connected. To close it, click the [<strong>Skip</strong>] button.</p>
<hr>
<h3 id="h_01JHXCHQ77H1TAR7KFKSZ8R89Q">What's Next?</h3>
<ul>
<li>
<strong><a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/9948309520924">Updating API Key Permissions</a></strong>: Learn how to configure permissions and ensure secure API connections.</li>
<li>
<strong><a href="https://bitsgap4907.zendesk.com/hc/en-us/articles/10044910693020">Troubleshooting API Errors</a></strong>: Get solutions for common API connection issues.</li>
</ul>
<hr>
<h3 id="h_01JHXCJ959A6TD27SVP9V0ATB2">Need Help?</h3>
<p>If you encounter any issues during the setup process, don’t hesitate to contact the Bitsgap <a href="mailto:support@bitsgap.com"><span class="wysiwyg-underline" style="color: #1155cc;">Customer Support</span></a> Team for assistance.</p>