Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Call public/auth with grant_type: coinbase_cdp and a CDP JWT. Send the returned access_token as Authorization: Bearer.

Query Parameters

instrument_name
string
required

Instrument name Unique instrument identifier

Example:

"BTC-PERPETUAL"

leverage
number | null
required

Target custom leverage multiplier. Must be between 1 and max_leverage. Pass null to remove custom leverage and restore risk-profile default.

subaccount_id
integer

The user id for the subaccount. Available to retail-broker callers; defaults to the authenticated account.

isolated
boolean
default:false

If true, sets leverage for isolated margin scope (main account only).

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
number | null
required

The stored custom leverage value (or null if custom leverage was removed).

id
integer

The id that was sent in the request