Sign in

v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Transfer

Transfer between balances

The endpoint transfers the specified amount between main, trade and collateral balances.

<Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note> <Note> Also, fiat currencies can't be transferred without KYC verification. </Note>
post/api/v4/main-account/transfer

Request body

method'deposit' | 'withdraw' | 'collateral-deposit' | 'collateral-withdraw'

Transfer method.

⚠️ We highly recommend to use from and to fields, which provides more flexibility. This way will be deprecated in future.

Example: deposit to transfer from main to trade / withdraw to transfer from trade balance to main. For collateral balances use collateral-deposit to transfer from main to collateral and collateral-withdraw to transfer from collateral to main

Not required if from and to are set.

from'main' | 'spot' | 'collateral'

Balance FROM which funds will move to. Acceptable values: main, spot, collateral

Not required if method is set.

to'main' | 'spot' | 'collateral'

Balance TO which funds will move to. Acceptable values: main, spot, collateral

Not required if method is set.

tickerstring required

Currency's ticker. Example: BTC

amountstring required

Amount to transfer. Max precision = 8, value must be greater than zero and less than or equal to the available balance.

requeststring required

Request signature

nonceinteger required

Unique request identifier

Example request

{
  "method": "deposit",
  "from": "main",
  "to": "spot",
  "ticker": "XLM",
  "amount": "0.9",
  "request": "{{request}}",
  "nonce": 1594297865000
}

Response

All validations succeeded and creating transaction is started

{"stackTrail":"paths:/api/v4/main-account/transfer:post:responses:201:content:application/json:schema:items","oasType":"schema","type":"unknown"}