Skip to content

Run Autoliquidation

POST
/autoliquidate

Simulates the auto-liquidation process (which normally runs automatically at 3:30PM EST on days of expiry) for a specified account.

Parameters

Header Parameters

X-API-KEY*
Type
string
Required

Request Body

application/json
JSON
{
  
"account_number": "MOCK_OMNI_AVSUAT_RQD_001",
  
"expiration_date": "2024-06-28"
}

Responses

Returns a list of positions pending autoliquidation and any positions we tried but failed to liquidate.

application/json
JSON
{
  
"positions_pending_autoliquidation": [
  
  
{
  
  
  
"account_id": "8c496d81-d0f4-4aa6-86f6-24bafab6b9e7",
  
  
  
"option": {
  
  
  
  
"Expiration": "2024-06-28",
  
  
  
  
"Strike": "180",
  
  
  
  
"SymbolRoot": "AAPL",
  
  
  
  
"Type": "put",
  
  
  
  
"StatusFractional": "inactive",
  
  
  
  
"StatusWhole": "active",
  
  
  
  
"ID": "9f808359-1136-41f6-82dc-5de291e5f05f",
  
  
  
  
"CreatedAt": "2024-05-22T17:26:32.55252Z",
  
  
  
  
"UpdatedAt": "2024-06-11T07:22:30.141536Z",
  
  
  
  
"DeletedAt": null
  
  
  
},
  
  
  
"quantity_pending_liquidation": "0.77"
  
  
},
  
  
{
  
  
  
"account_id": "8c496d81-d0f4-4aa6-86f6-24bafab6b9e7",
  
  
  
"option": {
  
  
  
  
"Expiration": "2024-06-28",
  
  
  
  
"Strike": "150",
  
  
  
  
"SymbolRoot": "TSLA",
  
  
  
  
"Type": "put",
  
  
  
  
"StatusFractional": "inactive",
  
  
  
  
"StatusWhole": "active",
  
  
  
  
"ID": "aef1f0f5-cbbb-49a8-85ed-93d0d0178789",
  
  
  
  
"CreatedAt": "2024-05-22T17:26:34.276256Z",
  
  
  
  
"UpdatedAt": "2024-06-11T07:22:30.141536Z",
  
  
  
  
"DeletedAt": null
  
  
  
},
  
  
  
"quantity_pending_liquidation": "2.45"
  
  
}
  
],
  
"failed_to_liquidate_positions": null
}

Playground

Headers
Body

Samples

Powered by VitePress OpenAPI