Logo
Admin API API Documentation

Update Instrument

PUT {{URL_ORIGIN}}/api/v2/instruments/:id

This API allows to update existing instrument.

Update Instrument- Error Codes

All validations in create instrument and the below

All validations in create instrument and the below

Code Message
100 Missing or invalid parameter: [FieldName]
101 [FieldName] not found
101 [Start Date/Stop Date Removed v1.25 / Category] can’t be changed after start date
101 No updates allowed after the stop date
101 Category can’t be changed for instrument that is underlying instrument
101 [FieldName] can’t be changed for strategy related instrument
NEW v1.30.0 105 Mass cancellation must be done before disabling the instrument
REMOVED v1.30.0 2402 [NumberOfOrders] active orders have quantity precision higher than [quantityPrecision]
REMOVED v1.30.0 2402 [NumberOfOrders] active orders have quantity higher than [maxLong/10^ quantityPrecision]
REMOVED v1.30.0 2403 [NumberOfOrders] active orders have price precision higher than [pricePrecision]
REMOVED v1.30.0 2403 [NumberOfOrders] active orders have price higher than [maxLong/10^ pricePrecision]
REMOVED v1.30.0 2404 Current total depth is higher than [maxLong/10^ quantityPrecision]. You should remove some depth or decrease the quantity precision
NEW v1.30.0 2402 Mass cancellation must be done before changing quantityPrecision
NEW v1.30.0 2402 Mass cancellation must be done before changing pricePrecision
10001 Permission denied

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "id": "12208", "symbol": "Instrument", "calendarId": "5", "activityStatus": "ACTIVE", "minQuantity": "2", "maxQuantity": "777", "pricePrecision": "9", "quantityPrecision": "4", "description": "testing instrument REST", "quoteCurrency": "USD", "tradingModels": [ "CLOB" ] }



Curl
curl -X PUT 'URL_ORIGIN/api/v2/instruments/:id' -d '{"symbol":"Instrument","quoteCurrency":"USD","calendarId":"600452872","pricePrecision":"9","quantityPrecision":"4","minQuantity":"2","maxQuantity":"777","activityStatus":"ACTIVE","tickSizeTableId":"2109981508","description":"testing instrument REST"}'

ENDPOINTS