> ## 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_pme_params
> Retrieves Portfolio Margin (PM) open-order restrictions and risk limits for the specified currency.
When Portfolio Margin is enabled, the response includes maximum order counts, aggregate futures and options order sizes, and the risk-reducing order limit. When Portfolio Margin is disabled, the response contains only `enabled: false`.
**📖 Related Article:** [Portfolio Margin](https://support.deribit.com/hc/en-us/articles/25944756247837-Portfolio-Margin)
[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_pme_params)
## OpenAPI
````yaml /api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json get /private/get_pme_params
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_pme_params:
get:
tags:
- Account Management
- Private
description: >+
Retrieves Portfolio Margin (PM) open-order restrictions and risk limits
for the specified currency.
When Portfolio Margin is enabled, the response includes maximum order
counts, aggregate futures and options order sizes, and the risk-reducing
order limit. When Portfolio Margin is disabled, the response contains
only `enabled: false`.
**📖 Related Article:** [Portfolio
Margin](https://support.deribit.com/hc/en-us/articles/25944756247837-Portfolio-Margin)
[Try in API
console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_pme_params)
parameters:
- name: currency
in: query
description: The currency symbol
required: true
schema:
$ref: '#/components/schemas/currency'
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_pme_params
params:
currency: BTC
responses:
'200':
$ref: '#/components/responses/PrivatePmeParamsResponse'
security:
- ApiKey:
- view
- OAuth2:
- wallet:accounts:read
components:
schemas:
currency:
description: Currency, i.e `"BTC"`, `"ETH"`, `"USDC"`
type: string
enum:
- BTC
- ETH
- USDC
- USDT
- EURR
PrivatePmeParamsResponse:
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: >-
Portfolio Margin order restrictions, or `enabled: false` when
Portfolio Margin is disabled.
type: object
oneOf:
- additionalProperties: false
properties:
enabled:
description: Portfolio Margin is enabled for the account.
type: boolean
enum:
- true
max_future_open_orders:
description: Maximum number of open futures orders.
type: integer
max_future_open_orders_size:
description: Maximum aggregate size of open futures orders.
type: number
max_option_open_orders:
description: Maximum number of open option orders.
type: integer
max_option_open_orders_size:
description: Maximum aggregate size of open option orders, in contracts.
type: number
max_risk_reducing_orders:
description: Maximum number of risk-reducing orders.
type: integer
max_total_open_orders:
description: Maximum total number of open derivatives orders.
type: integer
required:
- enabled
- max_total_open_orders
- max_future_open_orders
- max_option_open_orders
- max_future_open_orders_size
- max_option_open_orders_size
- max_risk_reducing_orders
type: object
- additionalProperties: false
properties:
enabled:
description: Portfolio Margin is disabled for the account.
type: boolean
enum:
- false
required:
- enabled
type: object
required:
- jsonrpc
- result
responses:
PrivatePmeParamsResponse:
description: Success response
content:
application/json:
examples:
response:
description: Response example
value:
id: 1
jsonrpc: '2.0'
result:
enabled: true
max_future_open_orders: 200
max_future_open_orders_size: 1000000
max_option_open_orders: 200
max_option_open_orders_size: 500
max_risk_reducing_orders: 5
max_total_open_orders: 300
schema:
$ref: '#/components/schemas/PrivatePmeParamsResponse'
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
````