Create Instrument

POST {{URL_ORIGIN}}/api/v2/instruments

This API allows to create a new instrument.

ID will be returned in the response, this ID is the unique identifier of the instrument and should be used when sending update commands.

Note: this ID can be retrieved via Get Instruments API.

Create Instrument- Error Codes

CodeMessage
1System is unavailable
101[FieldName] not found
101[FieldName] must be less than or equal to maxLong/10^ fieldPrecision
101[FieldName] must be more than or equal to minLong/10^ fieldPrecision
101Precision of [Fieldname] is greater than [quantityPrecision]
101Precision of [Fieldname] is greater than [pricePrecision]
101Precision of quantityIncrement must be [quantityPrecision] (quantityPrecision)
101minQuantity should be less than maxQuantity or equal to it
101minPrice should be less than maxPrice or equal to it
101maxQuantity should be less than maxDepth or equal to it
101Stop Date must be after Start Date
101Stop date must be in future
101underlyingInstrumentId/legsInstrumentIds not found
101Legs [price/quantity] precision must be equal to strategy price precision
102symbol already exists for id: [instrumentId]
105Legs [price/quantity] precision must be equal to strategy price precision
NEW v1.26.0
105
Strategies are not allowed as legs
2603[fieldName] of [fieldValue] is not allowed as instrument price precision is [instrumentPricePrecision]
2605[FieldName] must be less than maxLong/10^ pricePrecision
10001Permission denied

Request Body

{"symbol"=>"Test", "quoteCurrency"=>"USD", "calendarId"=>"600452872", "pricePrecision"=>"6", "quantityPrecision"=>"4", "minQuantity"=>"0.0001", "maxQuantity"=>"10000000", "activityStatus"=>"ACTIVE", "description"=>"Testing instrument"}

RESPONSES

status: OK

{"id":"12208","symbol":"Ins1","calendarId":"1234","activityStatus":"ACTIVE","minQuantity":"0.0001","maxQuantity":"10000000","pricePrecision":"6","quantityPrecision":"4","description":"instrument USD","quoteCurrency":"USD","tradingModels":["CLOB"]}