Logo
Admin API API Documentation

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

Code Message
1 System 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
101 Precision of [Fieldname] is greater than [quantityPrecision]
101 Precision of [Fieldname] is greater than [pricePrecision]
101 Precision of quantityIncrement must be [quantityPrecision] (quantityPrecision)
101 minQuantity should be less than maxQuantity or equal to it
101 minPrice should be less than maxPrice or equal to it
101 maxQuantity should be less than maxDepth or equal to it
101 Stop Date must be after Start Date
101 Stop date must be in future
101 underlyingInstrumentId/legsInstrumentIds not found
101 Legs [price/quantity] precision must be equal to strategy price precision
102 symbol already exists for id: [instrumentId]
105 Legs [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
10001 Permission denied

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




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" ] }



Curl
curl -X POST 'URL_ORIGIN/api/v2/instruments' -d '{"symbol":"Test","quoteCurrency":"USD","calendarId":"600452872","pricePrecision":"6","quantityPrecision":"4","minQuantity":"0.0001","maxQuantity":"10000000","activityStatus":"ACTIVE","description":"Testing instrument"}'

ENDPOINTS