Skip to main content

API Terminology & Key Concepts

deposit[Amount][Address][Memo][Coin][Network][Tx]: Refers to data about the coin the user is shifting from. For example, in a shift from BTC to ETH:

  • depositCoin: the ticker of the coin the user needs to send to SideShift.ai, or a token contract address for the selected depositNetwork, e.g. btc or 0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174
  • depositNetwork: the id of the depositCoin network, e.g. bitcoin or mainnet
  • depositAmount: the amount of BTC the user needs to deposit
  • depositAddress: the address the user needs to send the BTC to
  • depositMemo: The memo that the user needs to include when sending to the deposit address for some coins, e.g., XRP, XLM, ATOM, and KAVA

settle[Amount][Address][Memo][Coin][Network][Rate][Tx]: Refers to data about the coin the user is shifting to. For example:

  • settleCoin: the ticker of the coin SideShift.ai will send the user, e.g. eth
  • settleNetwork: the ID of the network of the settleCoin, e.g. ethereum or optimism
  • settleAmount: the amount of ETH SideShift.ai will send
  • settleRate: the rate at which the coins are exchanged. For example, if a user sends 0.1 BTC and receives 1 ETH, the settleRate is 10
  • settleAddress: The address SideShift.ai will send the ETH to
  • settleTx: details of the transaction SideShift.ai sent to the user
  • settleMemo: SideShift supports sending coins to addresses that require a memo on some chains, such as XRP, XLM, ATOM, KAVA, and ALGO

auth key (keypair): The Ed25519 keypair you generate to authenticate API requests. It is only used to sign API requests and has nothing to do with a crypto wallet. See Authentication.

  • secret key: the private half of the keypair. Keep it on your server and never send it in a request. The account page shows it as Private Key.
  • x-sideshift-key: your public key, hex encoded. Never send your secret key here.
  • x-sideshift-signature: the signature of timestamp + METHOD + path + body, made with the secret key of an auth key registered to your account. It is not a wallet or on-chain transaction signature.
  • x-sideshift-timestamp: the Unix time in milliseconds used in the signed message.
  • x-sideshift-secret: the legacy account secret. It still works during the migration period, but integrations should migrate to signing.

See the /v2/coins endpoint for a full list of coins and their respective networks supported by SideShift.ai.