CLclear-street
Margin

Get Reg-T margin

Changed on

Get the latest Reg-T margin calculation for the given entity

get/entities/{entity_id}/regt-margin

Request

  • Base URL
    https://api.clearstreet.io/studio/v2
  • Auth
    HTTP bearer

Path parameters

entity_idstring required

Entity ID for the legal entity.

Example:100000

Entity ID

Response

Reg-T margin

versionstring required

Unique identifier for this margin calculation.

timestampinteger required

Milliseconds since epoch.

net_market_valuenumber double required

Market value net of long and short market values.

effective_requirementnumber double required

The enforced margin requirement in effect.

effective_excessnumber double

The maring amount by taking the difference between total equity and the effective requirement. A negative number reflects an effective margin deficit.

house_requirementnumber double required

Margin requirements based on Clear Street's house margin methodology.

house_excessnumber double required

The margin amount by taking the difference between total equity and the house requirement. A negative number reflects a house margin deficit.

exchange_requirementnumber double required

Margin requirements based on regulatory rules.

exchange_excessnumber double

The margin amount by taking the difference between total equity and the exchange requirement. A negative number reflects an regulatory margin deficit.

smanumber double required

Special Memorandum Account (SMA). The regulatory line of credit amount for margin trading based on market value, trading activity, and available cash.

sod_buying_powernumber double required

The limit, or "up-to" amount, of securities value that can be day-traded for a given trading day.

overnight_buying_powernumber double required

The limit, or "up-to" amount, of securities value that can be purchased and held overnight.

day_trade_buying_powernumber double required

The remaining amount of start_of_day_buying_power that captures any day-trading activity.

Example response

{
  "groups": [
    {
      "members": [
        {
          "symbol": "AAPL",
          "quantity": "100"
        }
      ]
    }
  ]
}

Changes

  • 468b5da24bbfRevision changes
    • warning

      added the new currency enum value to the //// response property for the response status

    • warning

      added the new fund enum value to the //// response property for the response status