List margin levels

GET 
/api/v2/margin/levels

Get a list of margin levels that match the provided criteria. If no filter is provided, all margin levels will be returned.

Request

Query Parameters

partyId string

Party ID for which to list the margin levels.

marketId string

Market ID for which to list the margin levels.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

marginLevels object

Page of margin levels data and corresponding page information.

edges object[]

Page of margins data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Margin levels data that satisfy a list margin levels request.

asset string

Asset ID for which the margin levels apply.

collateralReleaseLevel string

Collateral release level value. This field is an unsigned integer scaled to the asset's decimal places.

initialMargin string

Initial margin value. This field is an unsigned integer scaled to the asset's decimal places.

maintenanceMargin string

Maintenance margin value. This field is an unsigned integer scaled to the asset's decimal places.

marginFactor string

Margin factor, relevant only for isolated margin, 0 otherwise.

marginMode - MARGIN_MODE_UNSPECIFIED: Never valid. - MARGIN_MODE_CROSS_MARGIN: Cross margin mode - margin is dynamically acquired and released as a position is marked to market - MARGIN_MODE_ISOLATED_MARGIN: Isolated margin mode - margin for any newly opened position volume is transferred to the margin account when the trade is executed (string)

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.

marketId string

Market ID for which the margin levels apply.

orderMargin string

Margin required to cover orders in isolated margin mode.

partyId string

Party ID for whom the margin levels apply.

searchLevel string

Margin search level value. This field is an unsigned integer scaled to the asset's decimal places.

timestamp int64

Timestamp in Unix nanoseconds for when the ledger entry was created.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "marginLevels": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "asset": "string",
          "collateralReleaseLevel": "string",
          "initialMargin": "string",
          "maintenanceMargin": "string",
          "marginFactor": "string",
          "marginMode": "MARGIN_MODE_UNSPECIFIED",
          "marketId": "string",
          "orderMargin": "string",
          "partyId": "string",
          "searchLevel": "string",
          "timestamp": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
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:
• 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.)
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.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
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:
• 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.)
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.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...