GEgemini
Derivatives

Get Account Margin

Roles

The API key you use to access this endpoint must have the Trader or Auditor role assigned. See <a href="/roles#roles">Roles</a> for more information.

The OAuth scope must have orders:read assigned to access this endpoint. See OAuth Scopes for more information.

post/v1/margin

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/margin
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Headers

X-GEMINI-APIKEYstring required

Your API key

X-GEMINI-SIGNATUREstring required

HEX-encoded HMAC-SHA384 of payload signed with API secret

X-GEMINI-PAYLOADstring required

Base64-encoded JSON payload

Content-Typestring
Content-Lengthstring
Cache-Controlstring

Request body

requeststring required

The API endpoint path

accountstring

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Specifies the account on which you intend to place the order. Only available for exchange accounts.

symbolstring required

Trading pair symbol. See symbols and minimums

Example request

{
  "request": "/v1/margin",
  "nonce": "1495127793000",
  "account": "primary"
}

Response

JSON object

margin_assets_valuestring decimal

The $ equivalent value of all the assets available in the current trading account that can contribute to funding a derivatives position.

initial_marginstring decimal

The $ amount that is being required by the accounts current positions and open orders.

available_marginstring decimal

The difference between the margin_assets_value and initial_margin.

margin_maintenance_limitstring decimal

The minimum amount of margin_assets_value required before the account is moved to liquidation status.

leveragestring decimal

The ratio of Notional Value to Margin Assets Value.

notional_valuestring decimal

The $ value of the current position.

estimated_liquidation_pricestring decimal

The estimated price for the asset at which liquidation would occur.

initial_margin_positionsstring decimal

The contribution to initial_margin from open positions.

reserved_marginstring decimal

The contribution to initial_margin from open orders.

reserved_margin_buysstring decimal

The contribution to initial_margin from open BUY orders.

reserved_margin_sellsstring decimal

The contribution to initial_margin from open SELL orders.

buying_powerstring decimal

The amount of that product the account could purchase based on current initial_margin and margin_assets_value.

selling_powerstring decimal

The amount of that product the account could sell based on current initial_margin and margin_assets_value.

Changes

No recorded changes to this operation across all 1 revision of this API.