Get current portfolio margin calculation parameters and options trading limits.

GET 
https://futures.kraken.com/derivatives/api/v3/portfolio-margining/parameters

Retrieve current portfolio margin calculation parameters.

Also includes user specific limits related to options trading.

Responses

200

Portfolio margining parameters

application/json

Schema

Schema

oneOf

Success Response

crossAssetNettingFactor doublerequired

extremePriceShockMultiplier doublerequired

volShockMultiplicationFactor doublerequired

volShockExponentFactor doublerequired

optionExpiryTimeShockHours uint64required

optionsInitialMarginFactor doublerequired

totalOptionOrdersConsideredInInitialMarginCalc uint64required

priceShockLevels double[]required

optionsUserLimits objectrequired

maxNetPositionDelta doublerequired

limitsPerBaseCurrency objectrequired

User limits per option contract base currency

property name* OptionsUserLimitsPerBaseCurrency

maxTotalPositionSize doublerequired

maxTotalOpenOrdersSize doublerequired

result stringrequired

Possible values: [success]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

ErrorResponse

errors Error (string)[]

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

error Error (string)required

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

result stringrequired

Possible values: [error]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

Authorization: APIKey

name: APIKeytype: apiKeydescription: General API key with at least **read-only** accessin: headerx-inlineDescription: true

name: Authenttype: apiKeydescription: Authentication stringin: headerx-inlineDescription: true

• curl
• python
• go
• nodejs

• CURL

curl -L 'https://futures.kraken.com/derivatives/api/v3/portfolio-margining/parameters' \
-H 'Accept: application/json' \
-H 'APIKey: <API_KEY_VALUE>' \
-H 'Authent: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://futures.kraken.com/derivatives/api/v3

Auth

general-api-key-read-only

authent