HomeDocumentationAPI Reference
Log In
API Reference

Transfer

Method Name

private/transfer

Transfer assets from one subaccount to another.

Parameters

recipient_subaccount_id integer required
Subaccount_id of the recipient
subaccount_id integer required
Subaccount_id
recipient_details object required
Details of the recipient
recipient_details.nonce integer required
Unique nonce defined as (e.g. 1695836058725001, where 001 is the random number)
recipient_details.signature string required
Ethereum signature of the transfer
recipient_details.signature_expiry_sec integer required
Unix timestamp in seconds. Expiry MUST be >5min from now
recipient_details.signer string required
Ethereum wallet address that is signing the transfer
sender_details object required
Details of the sender
sender_details.nonce integer required
Unique nonce defined as (e.g. 1695836058725001, where 001 is the random number)
sender_details.signature string required
Ethereum signature of the transfer
sender_details.signature_expiry_sec integer required
Unix timestamp in seconds. Expiry MUST be >5min from now
sender_details.signer string required
Ethereum wallet address that is signing the transfer
transfers array of objects required
List of transfers
transfers.address string required
Ethereum address of the asset being transferred
transfers.amount string required
Amount to transfer
transfers.sub_id integer required
Sub ID of the asset being transferred
recipient_currency string
Base currency of the recipient subaccount (only for PM if creating a new subaccount)
recipient_margin_type string
PM (Portfolio Margin) or SM (Standard Margin) if creating a new subaccount. Can be omitted otherwise
enum PM SM

Response

id string or integer required
result object required
result.status string required
requested
result.transaction_id string required
Transaction id of the transfer

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}