Documentation contents

Connections

API key

An API key is created on the exchange and entered in the connection wizard. It is stored encrypted, only by the order executor (see "Security → Exchange keys").

Fields depend on the exchange type:

Exchange type Fields
CEX PUBLIC KEY, SECRET KEY; on some exchanges — PASSPHRASE (the key passphrase)
DEX PUBLIC KEY — the account or API wallet address; SECRET KEY — the API wallet's private key

The fields and account requirements of a particular exchange — see "Exchange guides".

Permissions

Permission Requirement
reading and trading on the perpetual contract market required if the market is open for trading
reading and trading on the spot market required if the market is open for trading
withdrawal of funds not needed for trading

The connection test checks the key's permissions (see "Connection wizard → Permission check").

The account's position mode is hedge mode, if the exchange offers a choice (see "What is Profit Cloud → Exchanges → Position mode").

Address whitelist

The key is restricted to the addresses of the order executor that serves the exchange. The connection wizard shows them at the "Key" step in the "IP whitelist" card; "Copy the addresses" copies them in the exchange's format. The addresses come in the executor registry, signed with the Profit Cloud release key; the app verifies the signature itself.

The app does not check the key's whitelist: a key with wrong addresses fails "Test connection" with an exchange error. How many addresses a key accepts — see "Exchange guides".