Skip to main content
POST
/
api
/
v1
/
portfolios
/
transfer-position
Transfer positions between portfolios
curl --request POST \
  --url https://api.international.coinbase.com/api/v1/portfolios/transfer-position \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "<string>",
  "to": "<string>",
  "instrument": "<string>",
  "quantity": "<string>",
  "side": "<string>"
}
'
{
  "success": true
}

​
API Key Permissions

This endpoint requires an API key with trade permission.
  • Java
  • .NET
  • Python
  • TS/JS
PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
TransferPositionsRequest request = new TransferPositionsRequest.Builder()
    .from("portfolio_id_1")
    .to("portfolio_id_2")
    .instrument("BTC-PERP")
    .amount("1")
    .build();
TransferPositionsResponse response = portfoliosService.transferPositions(request);
For more information, please visit the INTX Java SDK.

Authorizations

​
CB-ACCESS-KEY
string
header
required

The Client ID that owns the API Key for the request

​
CB-ACCESS-PASSPHRASE
string
header
required

The pass phrase affiliated with the API Key

​
CB-ACCESS-SIGN
string
header
required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

​
CB-ACCESS-TIMESTAMP
string
header
required

The timestamp of when the request is being made

Body

application/json
​
from
string
required

Identifies the portfolio by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175) to transfer positions from

​
to
string
required

Identifies the portfolio by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175) to transfer positions to

​
instrument
string
required

Identifies the instrument by name (e.g., BTC-PERP), UUID (e.g., 291efb0f-2396-4d41-ad03-db3b2311cb2c), or instrument ID (e.g., 1482439423963469)

​
quantity
string
required

The full or partial quantity of the position being transferred

​
side
string
required

The side of the position being transferred, BUY or SELL

Response

Transfer processed

​
success
boolean

true if the transfer was successful

Example:

true