CLclear-street
Margin Simulations

Get Reg-T simulation

Changed on

Get a Reg-T margin simluation that was previously created. Note, simulations are automatically deleted after 48-hours.

get/entities/{entity_id}/regt-margin-simulations/{simulation_id}

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

simulation_idstring uuid required

Unique ID for a simulation.

Example:6460030d-8ed4-19d3-818e-e87b36e90005

Simulation ID

Response

Reg-T margin simulation

created_atinteger required

Milliseconds since epoch.

namestring required

Name of a simulation.

simulation_idstring uuid required

Unique ID for a simulation.

Example response

{
  "simulation_id": "6460030d-8ed4-19d3-818e-e87b36e90005",
  "before": {
    "groups": [
      {
        "members": [
          {
            "symbol": "AAPL",
            "quantity": "100"
          }
        ]
      }
    ]
  },
  "after": {
    "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 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

    • warning

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