Documentation contents

Connections

Connection wizard

The wizard opens with the "Add connection" button in the "Connections" section; the steps are "Exchange" and "Key".

"Exchange" — choosing the exchange and the "Name"; the "Fees" block is optional. "Next" is available once an exchange is chosen and a name is entered. An exchange that is not accepting new connections right now does not get past this step.

"Key":

  • the exchange's guide, collapsed (see "Exchange guides");
  • the "IP whitelist" card with the "Copy the addresses" button;
  • a warning if the exchange requires a Unified Trading Account;
  • the exchange's key fields (see "API key");
  • the checkbox accepting the terms and the "Read the terms" link;
  • the "Key check" block (after the test — "The exchange's answer") and the status line.

Buttons: "Cancel", "Back", "Test connection", "Save connection". Editing the key or changing the exchange resets the test result.

Permission check

The "Key check" block fills in after the test, one row per condition:

  • "Read and write on the futures market";
  • "Read and write on the spot market";
  • "Hedge position mode enabled".
Mark Meaning Can be saved
✓ the exchange confirmed the permission yes
✗ the key does not have the permission no
"No check" the exchange did not allow a check yes
⚠ "check failed" the exchange's response was not recognized yes
market not available for trading the exchange's market is closed in Profit Cloud yes

Permissions are checked from the exchange's data or by requests that create no orders and move no funds.

Hedge mode: ✓ — the account is in hedge mode, ✗ — in one-way mode; ⓘ explains how to switch. With one-way mode, the connection is not saved. If the mode cannot be chosen on the exchange or is set per instrument (see "What is Profit Cloud → Exchanges → Position mode"), the row shows "No check".

Consents

Before the test — the checkbox accepting the terms for creating and using connections; the terms open via the "Read the terms" link. Together with the connection, the server stores the time of acceptance, the terms version and the app language.

Connection test

"Test connection" is available when the consent checkbox is ticked, the account is not frozen and the exchange accepts connections. The app asks for the passcode and encrypts the key on the device (see "Security → Exchange keys → Key encryption").

The server checks, in order:

  1. the account is not frozen;
  2. the order executor has accepted the encrypted key;
  3. the exchange accepts the key — via a private read request, together with the exchange's account requirements;
  4. the key's permissions;
  5. the account is in hedge mode, if the exchange offers a choice.

The test result — the key is accepted or rejected, with the exchange's answer.

"Save connection" is available after a test with no rejections. Saving uses the key encrypted during the test — the passcode is not needed a second time; the encrypted key is valid for 10 minutes.

The test fails if:

Reason What to do
the time on the device is wrong turn on automatic time setting
the app version is outdated install the update
the server did not accept the key try again; if it fails again, contact support
the key has withdrawal permission and the exchange reports it recreate the key on the exchange without withdrawal permission
the device key is unavailable see "Security → Devices"
the account is frozen wait for the freeze to end