Estimate margin
GET/api/v2/estimate/margin
Estimate the margin that would be required for submitting this order
Request
Query Parameters
- SIDE_UNSPECIFIED: Default value, always invalid
- SIDE_BUY: Buy order
- SIDE_SELL: Sell order
- TYPE_UNSPECIFIED: Default value, always invalid
- TYPE_LIMIT: Used for Limit orders
- TYPE_MARKET: Used for Market orders
- TYPE_NETWORK: Used for orders where the initiating party is the network (with distressed parties)
Market ID for the order.
Party ID of the order.
Possible values: [SIDE_UNSPECIFIED
, SIDE_BUY
, SIDE_SELL
]
Default value: SIDE_UNSPECIFIED
Order side - indicator for Seller or Buyer side.
Possible values: [TYPE_UNSPECIFIED
, TYPE_LIMIT
, TYPE_MARKET
, TYPE_NETWORK
]
Default value: TYPE_UNSPECIFIED
Type of the order.
Size of order.
Price of the asset.
Responses
- 200
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
marginLevels object
Summary of the estimated margins for this order if it were to trade now.
Asset ID for which the margin levels apply.
Collateral release level value. This field is an unsigned integer scaled to the asset's decimal places.
Initial margin value. This field is an unsigned integer scaled to the asset's decimal places.
Maintenance margin value. This field is an unsigned integer scaled to the asset's decimal places.
Margin factor, relevant only for isolated margin, 0 otherwise.
Possible values: [MARGIN_MODE_UNSPECIFIED
, MARGIN_MODE_CROSS_MARGIN
, MARGIN_MODE_ISOLATED_MARGIN
]
Default value: MARGIN_MODE_UNSPECIFIED
Margin mode for the party, cross margin or isolated margin.
Market ID for which the margin levels apply.
Margin required to cover orders in isolated margin mode.
Party ID for whom the margin levels apply.
Margin search level value. This field is an unsigned integer scaled to the asset's decimal places.
Timestamp in Unix nanoseconds for when the ledger entry was created.
{
"marginLevels": {
"asset": "string",
"collateralReleaseLevel": "string",
"initialMargin": "string",
"maintenanceMargin": "string",
"marginFactor": "string",
"marginMode": "MARGIN_MODE_UNSPECIFIED",
"marketId": "string",
"orderMargin": "string",
"partyId": "string",
"searchLevel": "string",
"timestamp": "string"
}
}
An internal server error
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}