Olympus
Admin

Halt trading on an instrument

Halt trading on the specified instrument. No new orders will be accepted. Requires admin authentication.

POST
/api/v1/admin/instruments/{id}/halt

Halt trading on the specified instrument. No new orders will be accepted. Requires admin authentication.

Path Parameters

id*string

The instrument ID

Header Parameters

X-Admin-Key*string

Admin API key

Response Body

application/json

application/json

curl -X POST "http://localhost:3000/api/v1/admin/instruments/AAPL-USD/halt" \  -H "X-Admin-Key: string"
{
  "status": "halt_submitted"
}
{
  "error": "Invalid request: missing required field"
}