Get maximum order size

GET 
/initialmargin/maxordersize

This endpoint is only supported for multi-collateral futures.

Request

Query Parameters

orderType stringrequired
Possible values: [lmt, mkt]
The order type:
• lmt - a limit order
• mkt - an immediate-or-cancel order with 1% price protection
symbol stringrequired

The symbol of the Futures.

limitPrice number

The limit price if orderType is lmt

Responses

200

The maximum order size

application/json

Schema

Schema

oneOf

Success Response

maxBuySize number

The maximum size of a buy order at the limit price or null if there is no market

maxSellSize number

The maximum size of a sell order at the limit price or null if there is no market

buyPrice number

The limit price of the buy order or null if the order type was mkt and there is no market

sellPrice number

The limit price of the sell order or null if the order type was mkt and there is no market

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)

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)

Loading...