/synthetic/addInstrument

Add new Synthetic Instrument

Payload

POST /api/synthetic/addInstrument

{
    "legs": [
        {
            "name": "BTC-USD"
        },
        {
            "name": "USDT-USD"
        }
    ]
}

Parameter	Type	Description
legs.name	string	Name of Direct Instrument that forms Synthetic Instrument

Response 200 OK

{
    "content": {
        "id": 1,
        "name": "BTC-USD:USDT-USD",
        "legs": [
            {
                "name": "BTC-USD",
                "inverted": false
            },
            {
                "name": "USDT-USD",
                "inverted": true
            }
        ]
    },
    "error": 0
}

Parameter	Type	Description
error	Efx::ErrorCode	Operation result code. Possible values are in List of Error Codes
content.id	number	Id of a newly created Synthetic Instrument
content.name	string	Technical Name of a newly created Synthetic Instrument
content.legs.name	string	Name of Direct Instrument that forms Synthetic Instrument
content.legs.inverted	boolean	Flag that highlights if Direct Instrument is inverted within specified Synthetic Instrument. Defines how internal calculations related to Synthetic Instrument are made

Response NoOK

Any unsuccessful response

{
    "error": 9,
    "errorDescription": [
        "Instrument already exists"
    ]
}

Attribute	Type	Description
error	Efx::ErrorCode	Operation result code. Possible values are in List of Error Codes
errorDescription	string array	List of strings describing observed errors