{"openapi":"3.0.1","info":{"title":"DXtrade REST API","description":"DXtrade REST API Documentation","version":"1.0"},"servers":[{"url":"/dxsca-web","description":"DXtrade Server"}],"tags":[{"name":"Authentication","description":"Authentication operations"},{"name":"Accounts","description":"Account management operations"},{"name":"Orders","description":"Order management operations"},{"name":"Conversion","description":"Currency conversion operations"},{"name":"Instruments","description":"Instrument management operations"},{"name":"Market Data","description":"Market data operations"},{"name":"Users","description":"User management operations"}],"paths":{"/login":{"post":{"tags":["Authentication"],"summary":"Performs a token-based login","description":"This operation is related just to token authentication and useless for HMAC authentication","operationId":"loginByCredentials","requestBody":{"description":"Login request with username, domain and password","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/LoginRequest"}}}},"responses":{"401":{"description":"3, 3:Account has been locked due to multiple unsuccessful login attempts, 3:Account has been temporarily locked due to multiple unsuccessful login attempts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/loginByToken":{"post":{"tags":["Authentication"],"summary":"Performs a login by a short-lived SSO token","operationId":"loginBySsoToken","requestBody":{"description":"login request with username, domain and token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsoTokenLoginRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SsoTokenLoginRequest"}}}},"responses":{"401":{"description":"3","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/logout":{"post":{"tags":["Authentication"],"summary":"For clients authenticated with token authentication explicitly expires the authorization token","description":"This operation is related just to token authentication and is useless for HMAC authentication","operationId":"post","responses":{"200":{"description":"OK"},"401":{"description":"1:Authorization required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/ping":{"post":{"tags":["Authentication"],"summary":"For clients authenticated with token authentication resets the session expiration timeout","description":"This operation is related just to token authentication and is useless for HMAC authentication","operationId":"post_1","responses":{"401":{"description":"1:Authorization required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/events":{"get":{"tags":["Accounts"],"summary":"Retrieve account events for required account by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"limit","in":"query","description":"maximum number of events to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an event in the result set to output data","schema":{"type":"integer","format":"int32","default":0}},{"name":"of-type","in":"query","description":"filter for the event type (comma-separated)","schema":{"type":"string"}},{"name":"time-from","in":"query","description":"from time filter for the event timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"time-to","in":"query","description":"to time filter for the event timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"period","in":"query","description":"A shortcut filter for event timestamp. Possible values are: today, previous-day, week, previous-week","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"description":"ETag header","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountEventList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters, 34:No proper permission is configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/events":{"get":{"tags":["Accounts"],"summary":"Retrieve account events by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_1","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}},{"name":"limit","in":"query","description":"maximum number of events to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an event in the result set to output data","schema":{"type":"integer","format":"int32","default":0}},{"name":"of-type","in":"query","description":"filter for the event type (comma-separated)","schema":{"type":"string"}},{"name":"time-from","in":"query","description":"from time filter for the event timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"time-to","in":"query","description":"to time filter for the event timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"period","in":"query","description":"A shortcut filter for event timestamp. Possible values are: today, previous-day, week, previous-week","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"description":"ETag header","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountEventList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters, 34:No proper permission is configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/metrics":{"get":{"tags":["Accounts"],"summary":"Retrieve account metrics for required account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getMetricsForAccount","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"include-positions","in":"query","description":"if true, result will include individual per-position metrics","schema":{"type":"boolean","default":false}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/metrics":{"get":{"tags":["Accounts"],"summary":"Retrieve account metrics for specified accounts","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getMetricsForAccountList","parameters":[{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}},{"name":"include-positions","in":"query","description":"if true, result will include individual per-position metrics","schema":{"type":"boolean","default":false}},{"name":"include-offset","in":"query","description":"include offset accounts if no accounts are specified","schema":{"type":"boolean"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/portfolio":{"get":{"tags":["Accounts"],"summary":"Retrieve account portfolio for required account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_2","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPortfolioList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/portfolio":{"get":{"tags":["Accounts"],"summary":"Retrieve account portfolios for specified accounts","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_3","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}},{"name":"include-offset","in":"query","description":"include offset accounts if no accounts are specified","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPortfolioList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/close":{"post":{"tags":["Accounts"],"summary":"Closes open positions and/or cancels working orders on the specified account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"post_2","parameters":[{"name":"account","in":"path","description":"Unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}}],"requestBody":{"description":"Bulk close request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCloseRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BulkCloseRequest"}}}},"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 33:Incorrect request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"2:Entity not found at server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/orders/{order}":{"delete":{"tags":["Orders"],"summary":"Cancel order on an account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"delete","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"order","in":"path","description":"order code can be either a client order id or an internal code assigned by the system","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"2:Entity not found at server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 33:Incorrect request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/orders/group":{"delete":{"tags":["Orders"],"summary":"Cancel order on an account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"delete_1","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"order-codes","in":"query","description":"comma-separated list of client orders ids from group to cancel. Note, that order in list is *important* for IF-THEN and IF-THEN-OCO groups, first order in list is parent, next orders are children.","schema":{"type":"string"}},{"name":"contingency-type","in":"query","description":"contingency type order group to cancel","schema":{"type":"string"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"2:Entity not found at server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 33:Incorrect request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/transfers":{"get":{"tags":["Accounts"],"summary":"Retrieve cash transfers for required account by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_4","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"limit","in":"query","description":"maximum number of transfers to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an transfer in the result set to output data","schema":{"type":"integer","format":"int32","default":0}},{"name":"of-type","in":"query","description":"filter for the transaction type (comma-separated)","schema":{"type":"string"}},{"name":"time-from","in":"query","description":"from time filter for the transfer timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"time-to","in":"query","description":"to time filter for the transfer timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"period","in":"query","description":"A shortcut filter for transfer timestamp. Possible values are: today, previous-day, week, previous-week","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"description":"ETag header","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashTransferList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/transfers":{"get":{"tags":["Accounts"],"summary":"Retrieve cash transfers by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_5","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}},{"name":"limit","in":"query","description":"maximum number of transfers to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an transfer in the result set to output data","schema":{"type":"integer","format":"int32","default":0}},{"name":"of-type","in":"query","description":"filter for the transaction type (comma-separated)","schema":{"type":"string"}},{"name":"time-from","in":"query","description":"from time filter for the transfer timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"time-to","in":"query","description":"to time filter for the transfer timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"period","in":"query","description":"A shortcut filter for transfer timestamp. Possible values are: today, previous-day, week, previous-week","schema":{"type":"string"}},{"name":"include-offset","in":"query","description":"include offset accounts if no accounts are specified","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"description":"ETag header","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashTransferList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/conversionRates":{"get":{"tags":["Conversion"],"summary":"Returns the conversion rate from one currency to another","operationId":"getConversionRate","parameters":[{"name":"fromCurrency","in":"query","description":"From currency, else it's omitted, returned an array of conversion rates from any currency to given currency","schema":{"type":"string","default":"USD$"}},{"name":"toCurrency","in":"query","description":"To currency","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversionRates"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/eodmetrics/{date}":{"get":{"tags":["Accounts"],"summary":"Retrieve EOD account metrics for specified date and accounts","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_6","parameters":[{"name":"date","in":"path","description":"date","required":true,"schema":{"type":"string"}},{"name":"accounts","in":"query","description":"list of accounts codes to get metrics for, optional (either this or groups should be present)","schema":{"type":"string"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"35:Data not ready yet","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]},"post":{"tags":["Accounts"],"summary":"Retrieve EOD account metrics for specified date and accounts","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"post_3","parameters":[{"name":"date","in":"path","description":"date","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"accounts":{"type":"string","description":"list of accounts codes to get metrics for, optional (either this or groups should be present)"}}}}}},"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"35:Data not ready yet","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/orders/history":{"get":{"tags":["Orders"],"summary":"Retrieve orders for required account by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'. Query parameters 'page', 'page-size', 'completed-from' and 'completed-to' considered as deprecated","operationId":"get_7","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"limit","in":"query","description":"maximum number of orders to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"in-status","in":"query","description":"allows specifying filter for order statuses (comma-separated list)","schema":{"type":"string"}},{"name":"of-type","in":"query","description":"allows specifying filter for order types (comma-separated list)","schema":{"type":"string"}},{"name":"issued-from","in":"query","description":"from time filter for the order issue timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"issued-to","in":"query","description":"to time filter for the order issue timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"period","in":"query","description":"a shortcut filter for order issue timestamp","schema":{"type":"string"}},{"name":"completed-from","in":"query","description":"from time filter for the order completion timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"completed-to","in":"query","description":"to time filter for the order completion timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"at-least-version","in":"query","description":"filter for the account version related to the last order update (specified version or greater)","schema":{"type":"integer","format":"int32"}},{"name":"at-most-version","in":"query","description":"filter for the account version related to the last order update (specified version or smaller)","schema":{"type":"integer","format":"int32"}},{"name":"side","in":"query","description":"filter for order operation (buy or sell)","schema":{"type":"string"}},{"name":"with-client-id","in":"query","description":"filter for the order unique ids assigned by client (comma-separated list)","schema":{"type":"string"}},{"name":"with-order-id","in":"query","description":"filter for the order unique ids assigned by server (comma-separated list)","schema":{"type":"string"}},{"name":"for-instrument","in":"query","description":"filter for the order instrument (comma-separated list of symbols)","schema":{"type":"string"}},{"name":"transaction-from","in":"query","description":"from time filter for the order last modification timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"transaction-to","in":"query","description":"to time filter for the order last modification timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"include-links","in":"query","description":"include link orders for matched orders","schema":{"type":"boolean"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature,32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]},"post":{"tags":["Orders"],"summary":"Retrieve orders for required account by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'. Query parameters 'page', 'page-size', 'completed-from' and 'completed-to' considered as deprecated","operationId":"post_4","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"include-links","in":"query","description":"include link orders for matched orders","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"maximum number of orders to be returned by the query","format":"int32"},"in-status":{"type":"string","description":"allows specifying filter for order statuses (comma-separated list)"},"of-type":{"type":"string","description":"allows specifying filter for order types (comma-separated list)"},"issued-from":{"$ref":"#/components/schemas/UTCDateTime"},"issued-to":{"$ref":"#/components/schemas/UTCDateTime"},"period":{"type":"string","description":"a shortcut filter for order issue timestamp"},"completed-from":{"$ref":"#/components/schemas/UTCDateTime"},"completed-to":{"$ref":"#/components/schemas/UTCDateTime"},"at-least-version":{"type":"integer","description":"filter for the account version related to the last order update (specified version or greater)","format":"int32"},"at-most-version":{"type":"integer","description":"filter for the account version related to the last order update (specified version or smaller)","format":"int32"},"side":{"type":"string","description":"filter for order operation (buy or sell)"},"with-client-id":{"type":"string","description":"filter for the order unique ids assigned by client (comma-separated list)"},"with-order-id":{"type":"string","description":"filter for the order unique ids assigned by server (comma-separated list)"},"for-instrument":{"type":"string","description":"filter for the order instrument (comma-separated list of symbols)"},"transaction-from":{"$ref":"#/components/schemas/UTCDateTime"},"transaction-to":{"$ref":"#/components/schemas/UTCDateTime"}}}}}},"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature,32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/orders/history":{"get":{"tags":["Orders"],"summary":"Retrieve orders by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'. Query parameters 'page', 'page-size', 'completed-from' and 'completed-to' considered as deprecated","operationId":"get_8","parameters":[{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}},{"name":"limit","in":"query","description":"maximum number of orders to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"number of page, which allow to load orders by batches","schema":{"type":"integer","format":"int32"}},{"name":"page-size","in":"query","description":"size of page","schema":{"type":"integer","format":"int32"}},{"name":"in-status","in":"query","description":"allows specifying filter for order statuses (comma-separated list)","schema":{"type":"string"}},{"name":"of-type","in":"query","description":"allows specifying filter for order types (comma-separated list)","schema":{"type":"string"}},{"name":"issued-from","in":"query","description":"from time filter for the order issue timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"issued-to","in":"query","description":"to time filter for the order issue timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"period","in":"query","description":"a shortcut filter for order issue timestamp","schema":{"type":"string"}},{"name":"completed-from","in":"query","description":"from time filter for the order completion timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"completed-to","in":"query","description":"to time filter for the order completion timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"at-least-version","in":"query","description":"filter for the account version related to the last order update (specified version or greater)","schema":{"type":"integer","format":"int32"}},{"name":"at-most-version","in":"query","description":"filter for the account version related to the last order update (specified version or smaller)","schema":{"type":"integer","format":"int32"}},{"name":"side","in":"query","description":"filter for order operation (buy or sell)","schema":{"type":"string"}},{"name":"with-client-id","in":"query","description":"filter for the order unique ids assigned by client (comma-separated list)","schema":{"type":"string"}},{"name":"with-order-id","in":"query","description":"filter for the order unique ids assigned by server (comma-separated list)","schema":{"type":"string"}},{"name":"for-instrument","in":"query","description":"filter for the order instrument (comma-separated list of symbols)","schema":{"type":"string"}},{"name":"transaction-from","in":"query","description":"from time filter for the order last modification timestamp in UTC","schema":{"type":"string","example":"2020-01-01T00:00:00.00Z"}},{"name":"transaction-to","in":"query","description":"to time filter for the order last modification timestamp in UTC","schema":{"type":"string","example":"2020-01-01T23:59:59.99Z"}},{"name":"include-offset","in":"query","description":"include offset accounts if no accounts are specified","schema":{"type":"boolean"}},{"name":"include-links","in":"query","description":"include link orders for matched orders","schema":{"type":"boolean"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature,32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]},"post":{"tags":["Orders"],"summary":"Retrieve orders by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'. Query parameters 'page', 'page-size', 'completed-from' and 'completed-to' considered as deprecated","operationId":"post_5","parameters":[{"name":"includeOffset","in":"query","description":"include offset accounts","schema":{"type":"boolean"}},{"name":"include-links","in":"query","description":"include link orders for matched orders","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"accounts":{"type":"string","description":"comma-separated list of account codes"},"limit":{"type":"integer","description":"maximum number of orders to be returned by the query","format":"int32"},"page":{"type":"integer","description":"number of page, which allow to load orders by batches","format":"int32"},"page-size":{"type":"integer","description":"size of page","format":"int32"},"in-status":{"type":"string","description":"allows specifying filter for order statuses (comma-separated list)"},"of-type":{"type":"string","description":"allows specifying filter for order types (comma-separated list)"},"issued-from":{"$ref":"#/components/schemas/UTCDateTime"},"issued-to":{"$ref":"#/components/schemas/UTCDateTime"},"period":{"type":"string","description":"a shortcut filter for order issue timestamp"},"completed-from":{"$ref":"#/components/schemas/UTCDateTime"},"completed-to":{"$ref":"#/components/schemas/UTCDateTime"},"at-least-version":{"type":"integer","description":"filter for the account version related to the last order update (specified version or greater)","format":"int32"},"at-most-version":{"type":"integer","description":"filter for the account version related to the last order update (specified version or smaller)","format":"int32"},"side":{"type":"string","description":"filter for order operation (buy or sell)"},"with-client-id":{"type":"string","description":"filter for the order unique ids assigned by client (comma-separated list)"},"with-order-id":{"type":"string","description":"filter for the order unique ids assigned by server (comma-separated list)"},"for-instrument":{"type":"string","description":"filter for the order instrument (comma-separated list of symbols)"},"transaction-from":{"$ref":"#/components/schemas/UTCDateTime"},"transaction-to":{"$ref":"#/components/schemas/UTCDateTime"}}}}}},"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature,32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/instruments/{symbol}":{"get":{"tags":["Instruments"],"summary":"Retrieve instruments details for required account and symbol","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getInstrumentBySymbol","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"symbol","in":"path","description":"unique instrument symbol in the system","required":true,"schema":{"pattern":".+","type":"string"}},{"name":"limit","in":"query","description":"maximum number of instruments to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an instrument in the result set to output data","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/instruments/query":{"get":{"tags":["Instruments"],"summary":"Retrieve instruments details for required account by specified symbols and types","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getInstrumentBySymbol_1","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"symbols","in":"query","description":"Symbol(or its part) to filter instruments (comma-separated values). The * (asterisk) wildcard indicates any number of any characters.","schema":{"type":"string"}},{"name":"types","in":"query","description":"filter for the types of instruments (comma-separated)","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of instruments to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an instrument in the result set to output data","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/instruments/type/{type}":{"get":{"tags":["Instruments"],"summary":"Retrieve instruments details for required account and type","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getInstrumentsByType","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}},{"name":"type","in":"path","description":"type of the instrument in the systems","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of instruments to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an instrument in the result set to output data","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/instruments/{symbol}":{"get":{"tags":["Instruments"],"summary":"Retrieve instrument by symbol","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getBySymbol","parameters":[{"name":"symbol","in":"path","description":"unique instrument symbol in the system","required":true,"schema":{"pattern":".+","type":"string"}},{"name":"limit","in":"query","description":"maximum number of instruments to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an instrument in the result set to output data","schema":{"type":"integer","format":"int32","default":0}},{"name":"sort-by-asc","in":"query","description":"sort-by-asc specifies sorting in ascending direction (comma-separated values)","schema":{"type":"string"}},{"name":"sort-by-desc","in":"query","description":"sort-by-desc specifies sorting in descending direction (comma-separated values)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/instruments/query":{"get":{"tags":["Instruments"],"summary":"Retrieve instruments by specified types and symbols","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getBySymbolsAndTypes","parameters":[{"name":"symbols","in":"query","description":"Symbol(or its part) to filter instruments (comma-separated values). The * (asterisk) wildcard indicates any number of any characters.","schema":{"type":"string"}},{"name":"types","in":"query","description":"filter for the types of instruments (comma-separated)","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of instruments to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an instrument in the result set to output data","schema":{"type":"integer","format":"int32","default":0}},{"name":"sort-by-asc","in":"query","description":"sort-by-asc specifies sorting in ascending direction (comma-separated values)","schema":{"type":"string"}},{"name":"sort-by-desc","in":"query","description":"sort-by-desc specifies sorting in descending direction (comma-separated values)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/instruments/type/{type}":{"get":{"tags":["Instruments"],"summary":"Retrieve instruments by type","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getByType","parameters":[{"name":"type","in":"path","description":"type of the instrument in the systems","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of instruments to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an instrument in the result set to output data","schema":{"type":"integer","format":"int32","default":0}},{"name":"sort-by-asc","in":"query","description":"sort-by-asc specifies sorting in ascending direction (comma-separated values)","schema":{"type":"string"}},{"name":"sort-by-desc","in":"query","description":"sort-by-desc specifies sorting in descending direction (comma-separated values)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/marketdata":{"post":{"tags":["Market Data"],"summary":"Retrieve market data events by specified types and symbols","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_9","requestBody":{"description":"Market data request with symbols and event types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketDataRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MarketDataRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketDataList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters, 34:No proper permission is configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/orders":{"get":{"tags":["Orders"],"summary":"Retrieve open orders for specified account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_10","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"description":"ETag header","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]},"put":{"tags":["Orders"],"summary":"Edit order details on an account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"put","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}}],"requestBody":{"description":"A request to create an order or an order group. Note, that presented model is single order request. Example of order group request see in specification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleOrderRequest"}}},"required":true},"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"2:Entity not found at server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 33:Incorrect request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]},"post":{"tags":["Orders"],"summary":"Submit a new order or a group of orders on an account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"post_6","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}}],"requestBody":{"description":"A request to create an order or an order group. Note, that presented model is single order request. Example of order group request see in specification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleOrderRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"2:Entity not found at server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature,33:Incorrect request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"100:Entity already exists at server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/orders":{"get":{"tags":["Orders"],"summary":"Retrieve open orders for specified accounts","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_11","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}},{"name":"include-offset","in":"query","description":"include offset accounts if no accounts are specified","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"description":"ETag header","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/positions":{"get":{"tags":["Accounts"],"summary":"Retrieve open positions for required account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_12","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/positions":{"get":{"tags":["Accounts"],"summary":"Retrieve open positions for specified accounts","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"get_13","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}},{"name":"include-offset","in":"query","description":"include offset accounts if no accounts are specified","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/{account}/tvLoginInfo":{"get":{"tags":["Accounts"],"summary":"Retrieve login info about trading view sessions for required account","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getLoginInfoForAccount","parameters":[{"name":"account","in":"path","description":"unique code assigned to an account","required":true,"schema":{"type":"string","example":"default:account_1"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/accounts/tvLoginInfo":{"get":{"tags":["Accounts"],"summary":"Retrieve login info about trading view sessions for specified accounts","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'","operationId":"getLoginInfoForAccounts","parameters":[{"name":"accounts","in":"query","description":"comma-separated list of account codes","schema":{"type":"string","example":"default:account_1,default:account_2"}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/users":{"get":{"tags":["Users"],"summary":"Retrieve user details by specified parameters","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'. Query parameters 'last-updated-from' and 'last-updated-to' considered as deprecated.","operationId":"get_14","parameters":[{"name":"limit","in":"query","description":"maximum number of users to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an user in the result set to output data","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}},"/users/{username}":{"get":{"tags":["Users"],"summary":"Retrieve user details for specified user name","description":"Authorization header format: 1) for BASIC scheme: 'DXAPI &ltsession token&gt' 2) for HMAC scheme: 'DXAPI principal=\"&ltAPI principal&gt\", timestamp=&lttimestamp&gt, hash=\"&ltHMAC hash&gt\"'. Query parameters 'last-updated-from' and 'last-updated-to' considered as deprecated.","operationId":"get_15","parameters":[{"name":"If-None-Match","in":"header","description":"If-None-Match header","schema":{"type":"string"}},{"name":"username","in":"path","description":"full user name in a 'username@domain' format","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of users to be returned by the query","schema":{"type":"integer","format":"int32"}},{"name":"start-from","in":"query","description":"paging starting index of an user in the result set to output data","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"OK","headers":{"ETag":{"description":"ETag header","style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetailsList"}}}},"401":{"description":"1:Authorization required, 12:HMAC signature too old, 13:HMAC signature mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"400":{"description":"11:Malformed HMAC signature, 32:Incorrect request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":[]}]}}},"components":{"schemas":{"ApiError":{"type":"object","properties":{"errorCode":{"type":"string"},"description":{"type":"string"}}},"SessionToken":{"type":"object","properties":{"sessionToken":{"type":"string"},"timeout":{"type":"object","properties":{"seconds":{"type":"integer","format":"int64"},"zero":{"type":"boolean"},"nano":{"type":"integer","format":"int32"},"negative":{"type":"boolean"},"positive":{"type":"boolean"},"units":{"type":"array","items":{"type":"object","properties":{"durationEstimated":{"type":"boolean"},"timeBased":{"type":"boolean"},"dateBased":{"type":"boolean"}}}}}}}},"LoginRequest":{"type":"object","properties":{"username":{"type":"string","description":"Username","example":"master_dealer"},"domain":{"type":"string","description":"Domain","example":"default"},"password":{"type":"string","description":"Password","example":"test"}}},"SsoTokenLoginRequest":{"type":"object","properties":{"username":{"type":"string"},"domain":{"type":"string"},"token":{"type":"string"}}},"AccountCode":{"required":["account","clearing"],"type":"object","properties":{"clearing":{"type":"string"},"account":{"type":"string"}}},"AccountEvent":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"eventType":{"type":"string","enum":["LIQUIDATION","MARGIN_CALL"]},"riskLevelThreshold":{"type":"number","format":"double"},"actualRiskLevel":{"type":"number","format":"double"},"eventTime":{"$ref":"#/components/schemas/UTCDateTime"},"owner":{"$ref":"#/components/schemas/PrincipalKey"}}},"AccountEventList":{"type":"object","properties":{"accountEvents":{"type":"array","items":{"$ref":"#/components/schemas/AccountEvent"}},"nextPageEventTime":{"$ref":"#/components/schemas/UTCDateTime"}}},"PrincipalKey":{"required":["fullName"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"domain":{"type":"string"},"name":{"type":"string"},"checkedId":{"type":"integer","format":"int32"},"fullName":{"type":"string"}}},"UTCDateTime":{"type":"object"},"AccountMetrics":{"required":["account"],"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"equity":{"type":"number","format":"double"},"balance":{"type":"number","format":"double"},"availableBalance":{"type":"number","format":"double"},"availableFunds":{"type":"number","format":"double"},"allocatedFunds":{"type":"number","format":"double"},"credit":{"type":"number","format":"double"},"marginFree":{"type":"number","format":"double"},"openPL":{"type":"number","format":"double"},"totalPL":{"type":"number","format":"double"},"margin":{"type":"number","format":"double"},"unsettledFunds":{"type":"number","format":"double"},"settledFunds":{"type":"number","format":"double"},"openPositionsCount":{"type":"integer","format":"int32"},"openOrdersCount":{"type":"integer","format":"int32"},"positions":{"type":"array","items":{"$ref":"#/components/schemas/PositionMetrics"}},"balances":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyMetrics"}},"owner":{"$ref":"#/components/schemas/PrincipalKey"}}},"AccountMetricsList":{"type":"object","properties":{"metrics":{"type":"array","items":{"$ref":"#/components/schemas/AccountMetrics"}},"emptyAccounts":{"type":"array","items":{"$ref":"#/components/schemas/EmptyAccount"}}}},"CurrencyMetrics":{"type":"object","properties":{"version":{"type":"integer","format":"int64"},"symbol":{"type":"string"},"balance":{"type":"number","format":"double"},"allocatedFunds":{"type":"number","format":"double"},"availableFunds":{"type":"number","format":"double"},"availableBalanceForWithdrawal":{"type":"number","format":"double"},"convRate":{"type":"number","format":"double"},"precision":{"type":"number","format":"double"}}},"EmptyAccount":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"}}},"PositionMetrics":{"required":["symbol"],"type":"object","properties":{"positionCode":{"type":"string"},"version":{"type":"integer","format":"int32"},"symbol":{"type":"string"},"rate":{"type":"number","format":"double"},"fpl":{"type":"number","format":"double"},"convRate":{"type":"number","format":"double"},"bidOpen":{"type":"number","format":"double"},"askOpen":{"type":"number","format":"double"},"marginRate":{"type":"number","format":"double"},"margin":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"quantityNotional":{"type":"number","format":"double"},"openPrice":{"type":"number","format":"double"},"openPriceInstrumentCcy":{"type":"number","format":"double"},"fplInstrumentCcy":{"type":"number","format":"double"},"instrumentCurrency":{"type":"string"},"currentPriceInstrumentCcy":{"type":"number","format":"double"}}},"AccountPortfolio":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"balances":{"type":"array","items":{"$ref":"#/components/schemas/Balance"}},"positions":{"type":"array","items":{"$ref":"#/components/schemas/Position"}},"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"owner":{"$ref":"#/components/schemas/PrincipalKey"}}},"AccountPortfolioList":{"type":"object","properties":{"portfolios":{"type":"array","items":{"$ref":"#/components/schemas/AccountPortfolio"}}}},"Audit":{"type":"object","properties":{"ip":{"type":"string"},"userAgent":{"type":"string"}}},"Balance":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"value":{"type":"number","format":"double"},"currency":{"type":"string"}}},"CashTransaction":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"transactionCode":{"type":"string"},"orderCode":{"type":"string"},"tradeCode":{"type":"string"},"version":{"type":"integer","format":"int32"},"clientOrderId":{"type":"string"},"type":{"type":"string","enum":["COMMISSION","FINANCING","DEPOSIT","WITHDRAWAL","COST","SETTLEMENT","ADJUSTMENT","EX_DIVIDEND","REBATE","NEGATIVE_BALANCE_CORRECTION"]},"value":{"type":"number","format":"double"},"currency":{"type":"string"},"transactionTime":{"$ref":"#/components/schemas/UTCDateTime"},"createdTime":{"$ref":"#/components/schemas/UTCDateTime"},"positionCode":{"type":"string"},"orderId":{"type":"integer","format":"int64"}}},"Execution":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"executionCode":{"type":"string"},"orderCode":{"type":"string"},"updateOrderId":{"type":"integer","format":"int64"},"version":{"type":"integer","format":"int32"},"clientOrderId":{"type":"string"},"actionCode":{"type":"string"},"instrument":{"type":"string"},"status":{"type":"string","enum":["ACCEPTED","WORKING","CANCELED","COMPLETED","EXPIRED","REJECTED"]},"finalStatus":{"type":"boolean"},"filledQuantity":{"type":"number","format":"double"},"lastQuantity":{"type":"number","format":"double"},"filledQuantityNotional":{"type":"number","format":"double"},"lastQuantityNotional":{"type":"number","format":"double"},"remainingQuantity":{"type":"number","format":"double"},"lastPrice":{"type":"number","format":"double"},"averagePrice":{"type":"number","format":"double"},"transactionTime":{"$ref":"#/components/schemas/UTCDateTime"},"marginRate":{"type":"number","format":"double"},"rejectReason":{"type":"string"},"rejectCode":{"type":"string"},"executionContext":{"$ref":"#/components/schemas/ExecutionContext"}}},"ExecutionContext":{"type":"object","properties":{"clientBid":{"type":"number","format":"double"},"clientAsk":{"type":"number","format":"double"},"marketBid":{"type":"number","format":"double"},"marketAsk":{"type":"number","format":"double"},"executionStrategy":{"type":"string"},"spreadType":{"type":"string"},"spreadMarkup":{"$ref":"#/components/schemas/SpreadMarkup"}}},"Order":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"orderId":{"type":"integer","format":"int64"},"orderCode":{"type":"string"},"clientOrderId":{"type":"string"},"actionCode":{"type":"string"},"legCount":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["MARKET","LIMIT","STOP"]},"instrument":{"type":"string"},"status":{"type":"string","enum":["ACCEPTED","WORKING","CANCELED","COMPLETED","EXPIRED","REJECTED"]},"finalStatus":{"type":"boolean"},"legs":{"type":"array","items":{"$ref":"#/components/schemas/OrderLeg"}},"side":{"type":"string","enum":["BUY","SELL"]},"tif":{"type":"string","enum":["DAY","GTC","IOC","FOK","GTD"]},"expireDate":{"$ref":"#/components/schemas/UTCDateTime"},"marginRate":{"type":"number","format":"double"},"issueTime":{"$ref":"#/components/schemas/UTCDateTime"},"transactionTime":{"$ref":"#/components/schemas/UTCDateTime"},"links":{"type":"array","items":{"$ref":"#/components/schemas/OrderLink"}},"executions":{"type":"array","items":{"$ref":"#/components/schemas/Execution"}},"cashTransactions":{"type":"array","items":{"$ref":"#/components/schemas/CashTransaction"}},"priceOffset":{"type":"number","format":"double"},"priceLink":{"type":"string","enum":["TRIGGERED_STOP","TRIGGERED_LIMIT"]},"externalOrderId":{"type":"string"},"hedgedOrderId":{"type":"integer","format":"int64"},"audit":{"$ref":"#/components/schemas/Audit"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"OrderLeg":{"type":"object","properties":{"instrument":{"type":"string"},"positionEffect":{"type":"string","enum":["OPEN","CLOSE"]},"positionCode":{"type":"string"},"side":{"type":"string","enum":["BUY","SELL"]},"price":{"type":"number","format":"double"},"legRatio":{"type":"number","format":"double"},"quantity":{"type":"number","format":"double"},"filledQuantity":{"type":"number","format":"double"},"remainingQuantity":{"type":"number","format":"double"},"averagePrice":{"type":"number","format":"double"}}},"OrderLink":{"type":"object","properties":{"linkType":{"type":"string","enum":["PARENT","CHILD","OCO"]},"linkedOrder":{"type":"string"},"linkedClientOrderId":{"type":"string"}}},"Position":{"required":["lastUpdateTime","openTime","side","symbol"],"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"positionCode":{"type":"string"},"symbol":{"type":"string"},"quantity":{"type":"number","format":"double"},"side":{"type":"string","enum":["BUY","SELL"]},"quantityNotional":{"type":"number","format":"double"},"openTime":{"$ref":"#/components/schemas/UTCDateTime"},"openPrice":{"type":"number","format":"double"},"lastUpdateTime":{"$ref":"#/components/schemas/UTCDateTime"},"marginRate":{"type":"number","format":"double"},"takeProfitPrice":{"type":"number","format":"double"},"stopLossPrice":{"type":"number","format":"double"}}},"SpreadMarkup":{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"number","format":"double"}}},"BulkCloseRequest":{"type":"object","properties":{"account":{"type":"string","example":"default:account_1"},"instrument":{"type":"string","description":"Symbol of the instrument to filter positions to close and working orders to cancel"},"cancelPositions":{"type":"boolean","description":"Use isClosePositions() instead","deprecated":true},"closePositions":{"type":"boolean","description":"Whether to close positions"},"cancelOrders":{"type":"boolean","description":"Whether to cancel working orders"},"comment":{"type":"string","description":"Free-form comment for this close operation for audit purposes"}}},"OrderResponse":{"type":"object","properties":{"orderId":{"type":"integer","format":"int64"},"updateOrderId":{"type":"integer","format":"int64"}}},"OrderResponseList":{"type":"object","properties":{"orderResponses":{"type":"array","items":{"$ref":"#/components/schemas/OrderResponse"}}}},"CashTransfer":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"transferCode":{"type":"string"},"comment":{"type":"string"},"transactionTime":{"$ref":"#/components/schemas/UTCDateTime"},"createdTime":{"$ref":"#/components/schemas/UTCDateTime"},"cashTransactions":{"type":"array","items":{"$ref":"#/components/schemas/CashTransaction"}}}},"CashTransferList":{"type":"object","properties":{"cashTransfers":{"type":"array","items":{"$ref":"#/components/schemas/CashTransfer"}},"nextPageTransactionTime":{"$ref":"#/components/schemas/UTCDateTime"}}},"ConversionRates":{"type":"object","properties":{"fromCurrency":{"type":"string"},"toCurrency":{"type":"string"},"convRate":{"type":"number","format":"double"}}},"ConversionRatesList":{"type":"object","properties":{"conversionRates":{"type":"array","items":{"$ref":"#/components/schemas/ConversionRates"}}}},"EodAccountMetrics":{"required":["account","accountBaseCurrency"],"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"accountBaseCurrency":{"type":"string"},"usdConvRate":{"type":"number","format":"double"},"equity":{"type":"number","format":"double"},"balance":{"type":"number","format":"double"},"availableBalance":{"type":"number","format":"double"},"availableFunds":{"type":"number","format":"double"},"allocatedFunds":{"type":"number","format":"double"},"marginFree":{"type":"number","format":"double"},"margin":{"type":"number","format":"double"},"openPl":{"type":"number","format":"double"},"totalPl":{"type":"number","format":"double"},"settledPL":{"type":"number","format":"double"},"credit":{"type":"number","format":"double"},"openPositionsCount":{"type":"integer","format":"int32"},"openOrdersCount":{"type":"integer","format":"int32"},"commissions":{"type":"number","format":"double"},"financing":{"type":"number","format":"double"},"dividends":{"type":"number","format":"double"},"deposits":{"type":"number","format":"double"},"withdrawals":{"type":"number","format":"double"},"rebates":{"type":"number","format":"double"},"adjustments":{"type":"number","format":"double"}}},"EodAccountMetricsList":{"required":["eodMetrics"],"type":"object","properties":{"eodMetrics":{"type":"array","items":{"$ref":"#/components/schemas/EodAccountMetrics"}},"notFound":{"type":"array","items":{"$ref":"#/components/schemas/AccountCode"}}}},"OrderList":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"nextPageTransactionTime":{"$ref":"#/components/schemas/UTCDateTime"}}},"InstrumentDetails":{"required":["account","symbol","type"],"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"type":{"type":"string","enum":["CURRENCY","STOCK","FOREX","FUTURES","PRODUCT","INDEX","CFD","OPTION","SPREAD_BET","CFD_FUTURES","SB_FUTURES","FX_OPTION","FX_FORWARD","CFD_OPTION","SB_OPTION","CFD_STOCK","SB_STOCK","CFD_FOREX","SB_FOREX","SPREAD","WARRANT","ETF"]},"symbol":{"type":"string"},"tradingStatus":{"type":"string","enum":["FULL","CLOSE_ONLY","NO"]},"minOrderSize":{"type":"number","format":"double"},"maxOrderSize":{"$ref":"#/components/schemas/LimitValue"},"minOrderSizeIncrement":{"type":"number","format":"double"},"marginRate":{"$ref":"#/components/schemas/MarginRate"},"assetClass":{"type":"string"}}},"InstrumentDetailsList":{"type":"object","properties":{"instrumentDetails":{"type":"array","items":{"$ref":"#/components/schemas/InstrumentDetails"}}}},"LimitValue":{"required":["limitType"],"type":"object","properties":{"value":{"type":"number","format":"double"},"limitType":{"type":"string","enum":["LOTS","NOTIONAL_CURRENCY"]}}},"MarginRate":{"type":"object","properties":{"rateType":{"type":"string","enum":["FLAT","TIERED","TRADER_SELECTED"]},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/MarginTier"}},"availableMarginRates":{"$ref":"#/components/schemas/TraderSelectedMarginRates"}}},"MarginTier":{"type":"object","properties":{"endVolume":{"type":"number","format":"double"},"value":{"type":"number","format":"double"}}},"TraderSelectedMarginRates":{"type":"object","properties":{"minRate":{"type":"number","format":"double"},"maxRate":{"type":"number","format":"double"},"defaultValue":{"type":"number","format":"double"},"rateIncrement":{"type":"number","format":"double"}}},"ExpirationDetails":{"required":["expirationDate","lastTradeDate"],"type":"object","properties":{"maturityDate":{"type":"string"},"expirationDate":{"$ref":"#/components/schemas/UTCDate"},"lastTradeDate":{"$ref":"#/components/schemas/UTCDate"}}},"Instrument":{"required":["symbol","type"],"type":"object","properties":{"type":{"type":"string","enum":["CURRENCY","STOCK","FOREX","FUTURES","PRODUCT","INDEX","CFD","OPTION","SPREAD_BET","CFD_FUTURES","SB_FUTURES","FX_OPTION","FX_FORWARD","CFD_OPTION","SB_OPTION","CFD_STOCK","SB_STOCK","CFD_FOREX","SB_FOREX","SPREAD","WARRANT","ETF"]},"symbol":{"type":"string"},"version":{"type":"integer","format":"int32"},"description":{"type":"string"},"priceIncrement":{"type":"number","format":"double"},"pipSize":{"type":"number","format":"double"},"currency":{"type":"string"},"lotSize":{"type":"number","format":"double"},"multiplier":{"type":"number","format":"double"},"underlying":{"type":"string"},"product":{"type":"string"},"expirationDetails":{"$ref":"#/components/schemas/ExpirationDetails"},"settlementType":{"type":"string","enum":["CASH","PHYSICAL"]},"firstCurrency":{"type":"string"},"tradingHours":{"type":"array","items":{"$ref":"#/components/schemas/InstrumentSession"}},"holidays":{"type":"array","items":{"$ref":"#/components/schemas/InstrumentHoliday"}},"currencyType":{"type":"string","enum":["FIAT","CRYPTO_CURRENCY","CRYPTO_TOKEN"]},"quantityIncrement":{"type":"number","format":"double"},"lotName":{"type":"string"},"instrumentTreePath":{"type":"string"},"assetClass":{"type":"string"},"optionDetails":{"$ref":"#/components/schemas/OptionDetails"}}},"InstrumentHoliday":{"required":["date","durationType","holidayName"],"type":"object","properties":{"holidayName":{"type":"string"},"date":{"$ref":"#/components/schemas/UTCDate"},"durationType":{"type":"string","enum":["ALL_DAY","SHORT_DAY"]},"isRecurrent":{"type":"boolean"},"tradingHours":{"$ref":"#/components/schemas/InstrumentHolidayTradingHours"}}},"InstrumentHolidayTradingHours":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/UTCDateTime"},"to":{"$ref":"#/components/schemas/UTCDateTime"}}},"InstrumentList":{"type":"object","properties":{"instruments":{"type":"array","items":{"$ref":"#/components/schemas/Instrument"}}}},"InstrumentSession":{"required":["eventType","weekDay"],"type":"object","properties":{"weekDay":{"$ref":"#/components/schemas/UTCWeekTime"},"eventType":{"type":"string","enum":["SESSION_OPEN","SESSION_CLOSE"]}}},"LocalTime":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"second":{"type":"integer","format":"int32"},"nano":{"type":"integer","format":"int32"}}},"OptionDetails":{"type":"object","properties":{"displayedName":{"type":"string"},"side":{"type":"string","enum":["CALL","PUT"]},"strikePrice":{"type":"number","format":"double"},"settlementDate":{"$ref":"#/components/schemas/UTCDate"},"illiquid":{"type":"boolean"}}},"UTCDate":{"type":"object","properties":{"date":{"type":"string","format":"date"}}},"UTCWeekTime":{"type":"object","properties":{"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"time":{"$ref":"#/components/schemas/LocalTime"}}},"MarketDataList":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/MarketEvent"}}}},"MarketEvent":{"type":"object","properties":{"symbol":{"type":"string"},"type":{"type":"string"}}},"MarketDataRequest":{"type":"object","properties":{"symbols":{"type":"array","items":{"type":"string"}},"eventTypes":{"type":"array","items":{"$ref":"#/components/schemas/MarketEventRequestType"}},"account":{"type":"string","example":"default:account_1"}}},"MarketEventRequestType":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"}}},"SingleOrderRequest":{"type":"object","properties":{"account":{"type":"string","example":"default:account_1"},"orderCode":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"type":"string","enum":["MARKET","LIMIT","STOP"]},"instrument":{"type":"string"},"quantity":{"type":"number","format":"double"},"positionEffect":{"type":"string","enum":["OPEN","CLOSE"]},"positionCode":{"type":"string"},"side":{"type":"string","enum":["BUY","SELL"]},"limitPrice":{"type":"number","format":"double"},"stopPrice":{"type":"number","format":"double"},"priceOffset":{"type":"number","format":"double"},"priceLink":{"type":"string","enum":["TRIGGERED_STOP","TRIGGERED_LIMIT"]},"tif":{"type":"string","enum":["DAY","GTC","IOC","FOK","GTD"]},"marginRate":{"type":"number","format":"double"},"expireDate":{"$ref":"#/components/schemas/UTCDateTime"}}},"PositionList":{"type":"object","properties":{"positions":{"type":"array","items":{"$ref":"#/components/schemas/Position"}}}},"TvAccountLoginInformation":{"required":["account","initialLoginToTV","lastLoginToTV"],"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountCode"},"initialLoginToTV":{"$ref":"#/components/schemas/UTCDateTime"},"lastLoginToTV":{"$ref":"#/components/schemas/UTCDateTime"}}},"TvAccountLoginInformationList":{"required":["tvLoginInformation"],"type":"object","properties":{"tvLoginInformation":{"type":"array","items":{"$ref":"#/components/schemas/TvAccountLoginInformation"}}}},"AccountDetails":{"type":"object","properties":{"owner":{"type":"string"},"account":{"$ref":"#/components/schemas/AccountCode"},"version":{"type":"integer","format":"int32"},"baseCurrency":{"type":"string"},"registrationTime":{"$ref":"#/components/schemas/UTCDateTime"},"accountStatus":{"type":"string","enum":["FULL_TRADING","CLOSE_ONLY","NO_TRADING","TERMINATED","EXPIRED"]},"pricingStream":{"type":"string"},"positionBased":{"type":"boolean"}}},"UserDetails":{"type":"object","properties":{"login":{"type":"string"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32"},"fullName":{"type":"string"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountDetails"}},"username":{"type":"string"}}},"UserDetailsList":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/components/schemas/UserDetails"}}}}},"securitySchemes":{"Authorization":{"type":"apiKey","description":"DXAPI Authorization header. Format: 'Authorization: DXAPI {token}'","name":"Authorization","in":"header"}}}}