POST
/
api
/
v1
/
portfolios
/
margin
Set portfolio margin override
curl --request POST \
  --url https://api.international.coinbase.com/api/v1/portfolios/margin \
  --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 '{
  "portfolio_id": "<string>",
  "margin_override": "<string>"
}'
{
  "portfolio_id": "t4umaqa-1-1",
  "margin_override": 0.2
}
PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
SetPortfolioMarginOverrideRequest request = new SetPortfolioMarginOverrideRequest.Builder().build();
SetPortfolioMarginOverrideResponse response = portfoliosService.setPortfolioMarginOverride(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
​
portfolio_id
string
required

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

​
margin_override
string
required

The margin override value for the portfolio. Specified as a decimal value representing notional requirement (e.g., 0.1 = 10% notional requirement, 0.25 = 25% notional requirement)

Response

Portfolio margin override set

​
portfolio_id
string<string>

The unique identifier of the portfolio the fill was executed under

Example:

"t4umaqa-1-1"

​
margin_override
number

The margin override value for the portfolio, indicating notional requirement to hold futures positions

Example:

0.2