Skip to main content

Freeze or unfreeze a Hong Kong account

POST

{BASE_URL}/accounts/mode/freeze

Turns frozen mode on (status: true) or off (status: false) for a Hong Kong account that the API key can access.

While an account is frozen, every new order (including IPO subscriptions) and every modify request is rejected with 400 DisallowedOrderAction_Error ("account is in frozen mode"). Cancel requests are still accepted, and working orders are not cancelled. Orders placed by Atomic Vaults operations are not blocked.

status defaults to false, so a request without it unfreezes the account. Repeating a request has no further effect. On success the body is an empty JSON object.

Request​

Responses​

Account mode updated. The body is an empty JSON object.