Create Transfer

POST https://api.sfox.com/v1/account/transfer

Transfer funds between your account's trading and collateral wallets.

Hedge long positions: Transfer funds to your collateral wallet so you can open a short position on the same currency in your trading wallet.

Transfers from your collateral wallet to your trading wallet will automatically settle unsettled positions, if applicable, first. The remainder, if any, will be applied to your trading wallet.

Body Parameters

Name	Type	Description
currency required	String	Currency to be transferred
quantity required	String	Quantity to be transferred
from_wallet required	String	Wallet being transferred from. Possible values: trading: your account's trading wallet collateral: your account's collateral wallet
to_wallet required	String	Wallet being transferred to. Possible values: trading: your account's trading wallet collateral: your account's collateral wallet

Response Body

Key	Description
from_transaction_id	sFOX generated ID of the transaction debiting the source wallet of the transfer
to_transaction_id	sFOX generated ID of the transaction crediting the destination wallet of the transfer
currency	Currency that was transferred
quantity	Quantity of the currency that was transferred
from_wallet	Name of the source wallet (trading or collateral)
to_wallet	Name of the destination wallet (trading or collateral)

Responses

200

{
    "from_transaction_id": 5467771,
    "to_transaction_id": 5467772,
    "currency": "btc",
    "quantity": 1,
    "from_wallet": "trading",
    "to_wallet": "collateral"
}

Example Requests

Shell

curl -H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-X POST \
--data '{"currency": "btc", "quantity": "1", "from_wallet": "trading", "to_wallet": "collateral"}' \
https://api.sfox.com/v1/account/transfer

NodeJS

const axios = require('axios');

axios({
  method: 'post',
  url: 'https://api.sfox.com/v1/account/transfer',
  headers: {
    'Authorization': 'Bearer <API_KEY>'
  },
  data: { 
    currency: 'btc',
    quantity: 1,
    from_wallet: 'trading',
    to_wallet: 'collateral'
  }
}).then(response => {
  console.log(response)
}).catch(err => {
  console.error(err)
});

Python

import requests

data = requests.post(
  "https://api.sfox.com/v1/account/transfer",
  headers={
    "Authorization": "Bearer <API_KEY>",
  },
  data={
    "currency": "btc",
    "quantity": 1,
    "from_wallet": "trading",
    "to_wallet": "collateral"
  }
)
print(data)