> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cdp.coinbase.com/llms.txt
> Use this file to discover all available pages before exploring further.
# private/get_leverage
> Retrieves the current user-configured custom leverage and effective maximum leverage for a specified active future instrument.
When `instrument_name` is supplied, returns a single leverage details object. When omitted, returns leverage details only for futures with a stored custom leverage override; instruments using the default maximum leverage are omitted. For `isolated=true`, regular subaccounts receive an empty object or array because isolated leverage configuration is visible only to the main account.
[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_leverage)
## OpenAPI
````yaml /api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_leverage
openapi: 3.1.0
info:
description: Coinbase Retail Advanced Trade API for derivatives trading.
title: Coinbase Retail Advanced Trade (Deribit) API
version: 2.1.1
servers:
- url: https://drb.coinbase.com/api/v2
security: []
tags:
- description: Can only be used over websockets.
name: WebSocket Only
- description: Public methods can be used without authentication.
name: Public
- description: >-
Private methods require authentication. All requests must include a
valid OAuth2 token.
A token can be requested using the /public/auth method.
When using the websockets protocol, the token must be included as a
parameter access_token in the message. When using REST (HTTP
GET), the token may also be passed in the Authorization
header.
name: Private
- name: Authentication
- name: Session Management
- description: >-
Subscription works as [notifications](#notifications), so users will
automatically (after subscribing) receive messages from the server.
Overview for each channel response format is described in
[subscriptions](#subscriptions) section.
name: Subscription Management
- name: Account Management
- name: Trading
- name: Market Data
- name: Wallet
paths:
/private/get_leverage:
get:
tags:
- Account Management
- Private
description: >+
Retrieves the current user-configured custom leverage and effective
maximum leverage for a specified active future instrument.
When `instrument_name` is supplied, returns a single leverage details
object. When omitted, returns leverage details only for futures with a
stored custom leverage override; instruments using the default maximum
leverage are omitted. For `isolated=true`, regular subaccounts receive
an empty object or array because isolated leverage configuration is
visible only to the main account.
[Try in API
console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_leverage)
parameters:
- name: instrument_name
in: query
description: Instrument name
required: false
schema:
$ref: '#/components/schemas/instrument_name'
- name: subaccount_id
in: query
description: >-
The user id for the subaccount. Available to retail-broker callers;
defaults to the authenticated account.
required: false
schema:
type: integer
- name: isolated
in: query
description: >-
If true, returns leverage settings for isolated margin mode (main
accounts only).
required: false
schema:
type: boolean
default: false
requestBody:
description: JSON-RPC request body
content:
application/json:
examples:
request:
description: JSON-RPC Request Example
value:
id: 1
jsonrpc: '2.0'
method: private/get_leverage
params:
instrument_name: BTC-PERPETUAL
responses:
'200':
$ref: '#/components/responses/PrivateGetLeverageResponse'
security:
- ApiKey:
- view
- OAuth2:
- wallet:accounts:read
components:
schemas:
instrument_name:
description: Unique instrument identifier
type: string
example: BTC-PERPETUAL
PrivateGetLeverageResponse:
type: object
properties:
id:
description: The id that was sent in the request
type: integer
jsonrpc:
description: The JSON-RPC version (2.0)
type: string
enum:
- '2.0'
result:
description: >-
Leverage details for one requested future, a list of futures with
stored custom leverage overrides, or an empty object/list when
isolated settings are hidden from a regular subaccount.
oneOf:
- properties:
instrument_name:
description: Instrument name
type: string
leverage:
description: >-
User-configured custom leverage, or null if defaulting to
max_leverage
type:
- number
- 'null'
max_leverage:
description: Effective maximum allowable leverage
type: number
required:
- instrument_name
- max_leverage
type: object
- items:
properties:
instrument_name:
description: Instrument name
type: string
leverage:
description: >-
User-configured custom leverage, or null if defaulting to
max_leverage
type:
- number
- 'null'
max_leverage:
description: Effective maximum allowable leverage
type: number
required:
- instrument_name
- max_leverage
type: object
type: array
- description: >-
Empty object returned when isolated leverage details are hidden
from a regular subaccount.
maxProperties: 0
type: object
required:
- jsonrpc
- result
responses:
PrivateGetLeverageResponse:
description: Success response
content:
application/json:
examples:
response:
description: Response example
value:
id: 1
jsonrpc: '2.0'
result:
instrument_name: BTC-PERPETUAL
leverage: 25
max_leverage: 100
schema:
$ref: '#/components/schemas/PrivateGetLeverageResponse'
securitySchemes:
ApiKey:
description: >-
Call `public/auth` with `grant_type: coinbase_cdp` and a CDP JWT. Send
the returned `access_token` as `Authorization: Bearer`.
scheme: bearer
type: http
OAuth2:
description: >-
Call `public/auth` with `grant_type: coinbase_oauth2` and an OAuth
access token. Send the returned `access_token` as `Authorization:
Bearer`.
flows:
authorizationCode:
authorizationUrl: https://login.coinbase.com/oauth2/auth
scopes:
wallet:accounts:read: View your accounts.
wallet:accounts:update: Authorize `wallet:accounts:update` operations.
wallet:buys:create: Place, edit, and cancel orders.
wallet:payment-methods:read: View your payment methods.
wallet:trades:create: Convert cryptocurrencies.
wallet:trades:read: View your cryptocurrency conversions.
wallet:transactions:read: View your transactions.
wallet:transactions:transfer: Transfer funds between accounts.
wallet:user:read: View your account information.
wallet:user:update: Update your account information.
tokenUrl: https://login.coinbase.com/oauth2/token
type: oauth2
````