CryptoWebUI Trader WebSocket API

General principles

Websocket endpoint: /websocket/v1.

STOMP messaging protocol is used for websocket communication. STOMP versions 1.1 and 1.2 are supported by backend.

All subscriptions are sent to /user/... channels.
All RPC request are sent to /app/... channels. Their results are received via /user/v1/responses subscription.

Errors that occur in our code are returned via /user/v1/responses subscription.

In case of request error, STOMP MESSAGE will be returned with header status containing 4xx HTTP error code.
In case of server error, STOMP MESSAGE will be returned with header status containing 5xx HTTP error code.


Resources

name path method
- /user/v1/responses SUBSCRIBE
AccountController /app/v1/accounts SEND
/app/v1/accounts/properties/modify SEND
/user/v1/balances SUBSCRIBE
/user/v1/accounts SUBSCRIBE
BarController [/user/v1/current-bars/_id/](#userv1current-barssecurity_idperiodicity) SUBSCRIBE
/app/v1/historical-bars SEND
ChartController /app/v1/chart-lines SEND
[/user/v1/current-chart/_id/](#userv1current-chartline_idscale) SUBSCRIBE
/app/v1/historical-chart SEND
CurrencyController /app/v1/currencies SEND
[/app/v1/currencies/_id](#appv1currenciescurrency_id) SEND
/app/v1/currencies/_id/limits SEND
/app/v1/currencies/_id/commission_plans SEND
/app/v1/currencies/commission_plans/active/all SEND
/app/v1/currencies/_id/commission_plans/active SEND
/user/v1/currencies SUBSCRIBE
CustomServicesController [/app/v1/custom-services/_name](#appv1custom-servicesservice_name) SEND
/app/v1/custom-services SEND
/app/v1/custom-services/_name/request SEND
FeeController /user/v1/fees SUBSCRIBE
L2DataController [/user/v1/market-data/_id](#userv1market-datasecurity_id) SUBSCRIBE
/app/v1/trades SEND
[/app/v1/trades/_id](#appv1tradessecurity_id) SEND
LinkedUsersController /v1/linked/list SEND
LogController /app/v1/log SEND
PrimeBrokerController /app/v1/prime-broker/accounts SEND
RFQController /user/v1/rfq SUBSCRIBE
/app/v1/rfq/request SEND
/app/v1/rfq/cancel SEND
/app/v1/rfq/list SEND
SecurityController /app/v1/securities SEND
/app/v1/securities/statistics SEND
[/app/v1/securities/_id](#appv1securitiessecurity_id) SEND
/user/v1/securities SUBSCRIBE
/user/v1/securities/statistics SUBSCRIBE
SecurityV2Controller /app/v2/securities SEND
/app/v2/securities/info SEND
[/app/v2/securities/_id](#appv2securitiessecurity_id) SEND
/app/v2/securities/bar_info SEND
/app/v2/securities/_id/bar_info SEND
/app/v2/securities/commissions/all SEND
/app/v2/securities/commissions SEND
/app/v2/securities/_id/commissions SEND
/app/v2/securities/commission_plans SEND
/app/v2/securities/_id/commission_plans SEND
/app/v2/securities/commission_plans/active/all SEND
/app/v2/securities/commission_plans/active SEND
/app/v2/securities/_id/commission_plans/active SEND
/app/v2/securities/session SEND
/app/v2/securities/status SEND
/user/v2/securities SUBSCRIBE
/user/v2/securities/status SUBSCRIBE
StakingController /user/v1/staking SUBSCRIBE
SystemController /app/v1/global/settings SEND
/app/v1/trader/health SEND
/user/v1/time SUBSCRIBE
TradingController /user/v1/current-trading-statistics SUBSCRIBE
/user/v1/orders SUBSCRIBE
/user/v1/deals SUBSCRIBE
/app/v1/orders/create SEND
/app/v1/orders/modify SEND
/app/v1/orders/cancel SEND
/app/v1/orders/events SEND
/app/v1/orders/history SEND
/app/v1/deals/modify SEND
/app/v1/trading/limits SEND
/app/v1/orders/confirmation/description SEND
/app/v1/orders/schema SEND
/app/v1/orders/schema/modify SEND
/app/v1/orders/schema/pre-open SEND
/app/v1/orders/schema/pre-open/modify SEND
/app/v1/orders/schema/linked SEND
/app/v1/orders/schema/details SEND
TradingSessionController /app/v1/trading-sessions SEND
/user/v1/trading-sessions SUBSCRIBE
TransactionController /user/v1/transactions SUBSCRIBE
/app/v1/transactions/incomplete SEND
/app/v1/transactions/history SEND
/app/v1/transactions/complete SEND
TransferController /user/v1/transfers SUBSCRIBE
UserController /app/v1/user/settings/get SEND
/app/v1/user/settings/modify SEND


Data Types

type description
AccountDto Class that defines a user account.
AccountBalanceDto Class that defines a user account balance.
AccountBaseDto Class that defines user account core fields.
AccountStatus Status of the account.
ActiveCommissionPlansDto Class that contains current user’s commission plan for the security with the possible next plans.
ActiveCurrencyCommissionPlansDto Class that contains current user’s commission plan for the currency with the possible next plans.
AuthSettingsDto Class that defines authentication settings.
BarDto Describes price movements for a set period of time.
BarResponseDto Describes an aggregated bar with a list of bars per exchange.
ChangeAccountPropertiesDto Defines a request for changing account properties.
ChangePropertyDto Defines a change property request.
ChangePropertyType Type of change property request.
ChargeFlatCommissionTime Time of flat commission charging.
CommissionPlanDto Class that defines a commission plan.
CurrencyDto Class that defines a currency.
CurrencyActionDto Class that defines an action to a specific currency.
CurrencyCommissionPlanDto Class that defines a commission plan for deposits and withdrawals.
CurrencyLimitsDto Class that contains account’s withdrawal and deposit limits for the currency taking into account transactions already performed by the user.
CurrentTradingStatisticsDto Class that defines trading statistics for current period for specified user.
CustomServiceDto Class that defines a custom service.
DealDto Represents a user’s deal (position).
DealSide Side of the deal.
DescriptionTextDto Represents a description text.
EditUserSettingsDto Represents request for changing user settings.
EditableUserSettingsDto Class that defines user settings that can be changed by the user.
EntityAction Arbitrary object action
ExecutionExplanation Type of execution explanation.
ExternalCommissionDto Class that defines an external commission taken by the specified exchange.
FeeDto Approximate order fee. Note: fee depends on the book state at the calculation time so actual value may differ from the calculated one.
FilterInfoDto
GlobalSettingsDto Class that defines global application settings.
HealthStatusDto Class that defines a health status of the application.
HistoricalBarsRequestDto Represents request for getting historical bars.
HistoricalChartRequestDto Represents request for getting historical chart data.
HistoricalRequestDto Represents a request for the history of entries.
HistoricalTransactionRequestDto Represents a request for the history of transactions.
L2Action L2 action. This is the type of action that the receiver of market data should perform to the book.
L2EntryDto Represents L2 entry.
L2PackageDto Represents L2 package for the specified symbol.
L2PackageType Type of the L2 package.
LineDotDto Class that defines a line dot.
LineInfoDto Class that defines meta-information about chart line.
LineSectionDto Class that defines a line section.
LinkedOrderSchemaDto Represents a linked order schema.
LinkedUserDto Class that defines a user to which the user can switch.
LogDto Represents request for collecting log message.
LogLevel Log level.
NewOrderDto Represents request for creating or modifying order.
OperationStatus Specifies current status of any operation.
OrderDto Represents user’s order as returned by the API.
OrderConfirmationTextRequestDto Represents request for getting an order confirmation description text.
OrderEventDto Represents events related to the order like order creation, changing, execution, cancellation etc.
OrderEventType Type of the order event.
OrderEventsRequestDto Represents request for getting user’s order events.
OrderStatus Status of the order.
OrderUpdateDto Represents update for the order with the list of events, that has changed it from the previous state.
Periodicity Represents bar periodicity.
PrimeBrokerAccountDto
ProductType Defines type of settlement.
PropertyDto Key-value pair.
QuoteDto Class that defines a suggested quote.
QuoteRequestDto Class that defines a request for quote.
QuoteSubscriptionDto Class that defines a subscription for quotes.
RFQRequestIdDto Represents RFQ request identifier.
SecurityDto Class that defines a security with the user-specific settings.
SecurityActionDto Class that defines an action to a specific security.
SecurityBarsDto Class that defines security bars.
SecurityCommissionsDto Class that defines security commissions.
SecurityDisplayMethod Security price display method.
SecurityStatisticsDto Class that defines security current prices and statistics.
SecurityStatusDto Class that defines current security status.
SecurityType Type of the instrument.
SecurityV2Dto Class that defines a security with the user-specific settings.
SecurityV2ActionDto
SessionStatus Trading session status.
Side Side of the order.
StakingDto Class that defines a staking.
StakingCancellationType Defines type of staking cancellation.
TimeInForce Specifies how long the order remains in effect.
TotalStatisticsDto Class that defines transaction statistics.
TradingCommissionAccount Account from which trading commission will be taken.
TradingCommissionMethod Method of computation of trading commission.
TradingCurrency Determines what account to use for trading.
TradingLimitsDto Class that defines trading statistics.
TradingSessionDto Class that defines a trading session.
TransactionDto Class that defines a transaction.
TransactionType Type of the transaction.
TransferDto Class that defines an internal transfer.
TransferType Type of internal transfer.
UserIdentifier Field that is used for user identification.
UserSettingsDto Class that defines user settings returned by the API.
WalletAddressDto Class that defines a saved wallet address.


Home/Resources Details


/user/v1/responses

General subscription for receiving results of RPC requests.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/responses
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0


Home/Resources/AccountController


/app/v1/accounts

Returns accounts list for specified user or single account if X-Deltix-Account-ID parameter is specified. Additionally will return account statistics in each of the currencies specified in X-Deltix-Currency-IDs parameter (NOTE: only currencies from UserSettingsDto.measurement_currencies are allowed in this parameter).


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Account-ID header Id of the account to receive. Optional parameter.
X-Deltix-Currency-IDs header Comma-separated list of currency IDs each of which will be used as a target currency to calculate account statistics in it. Each currency ID must be from UserSettingsDto.measurement_currencies, otherwise an error will be raised. Optional parameter. Example: USD,BTC.

Response Body

media type data type description
application/json array of AccountDto Class that defines a user account.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/accounts
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "currency_id" : "...",
  "status" : "suspended",
  "name" : "...",
  "withdrawal_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "succeeded",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "approved",
    "reason" : "..."
  } ],
  "deposit_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "pending",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "cancelled",
    "reason" : "..."
  } ],
  "measurement_currency_id" : "...",
  "balance" : "123.4",
  "available_for_trading" : "123.4",
  "available_for_withdrawal" : "123.4",
  "enter_average_price" : "123.4",
  "current_price" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "total_statistics" : [ {
    "type" : "execution",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  }, {
    "type" : "withdrawal",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  } ],
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
}, {
  "id" : "...",
  "currency_id" : "...",
  "status" : "suspended",
  "name" : "...",
  "withdrawal_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "in_progress",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "cancelled",
    "reason" : "..."
  } ],
  "deposit_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "failed",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "failed",
    "reason" : "..."
  } ],
  "measurement_currency_id" : "...",
  "balance" : "123.4",
  "available_for_trading" : "123.4",
  "available_for_withdrawal" : "123.4",
  "enter_average_price" : "123.4",
  "current_price" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "total_statistics" : [ {
    "type" : "interest_commission",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  }, {
    "type" : "credit",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  } ],
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
} ]


/app/v1/accounts/properties/modify

Changes account’s properties.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json ChangeAccountPropertiesDto Defines a request for changing account properties.

Response Body

media type data type description
application/json AccountDto Class that defines a user account.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/accounts/properties/modify
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "account_id" : "...",
  "property_changes" : [ {
    "type" : "insert",
    "index" : 12345,
    "key" : "...",
    "value" : "..."
  }, {
    "type" : "update",
    "index" : 12345,
    "key" : "...",
    "value" : "..."
  } ]
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "currency_id" : "...",
  "status" : "suspended",
  "name" : "...",
  "withdrawal_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "pending",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "pending",
    "reason" : "..."
  } ],
  "deposit_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "failed",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "rejected",
    "reason" : "..."
  } ],
  "measurement_currency_id" : "...",
  "balance" : "123.4",
  "available_for_trading" : "123.4",
  "available_for_withdrawal" : "123.4",
  "enter_average_price" : "123.4",
  "current_price" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "total_statistics" : [ {
    "type" : "transfer_receive",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  }, {
    "type" : "withdrawal",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  } ],
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
}


/user/v1/balances

Subscription for account balances changes.

Additionally will send updates for account statistics in each of the currencies specified in X-Deltix-Currency-IDs parameter (NOTE: only currencies from UserSettingsDto.measurement_currencies are allowed in this parameter). Updates will be sent each time any change not related to currenct price change occurs.

NOTE: this subscription will NOT send any updates on the changes caused by the current price change. Such changes must be made manually on the API client side.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Currency-IDs header Comma-separated list of currency IDs each of which will be used as a target currency to calculate account statistics in it. Each currency ID must be from UserSettingsDto.measurement_currencies, otherwise an error will be raised. Optional parameter. Example: USD,BTC.

Message Body

media type data type description
application/json array of AccountBalanceDto Class that defines a user account balance.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/balances
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/balances
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "account_id" : "...",
  "currency_id" : "...",
  "measurement_currency_id" : "...",
  "balance" : "123.4",
  "available_for_trading" : "123.4",
  "available_for_withdrawal" : "123.4",
  "enter_average_price" : "123.4",
  "current_price" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "total_statistics" : [ {
    "type" : "credit",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  }, {
    "type" : "balance_correction",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  } ],
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
} ]


/user/v1/accounts

Subscription for account changes.

NOTE: this subscription will NOT send any balance updates.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json AccountBaseDto Class that defines user account core fields.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/accounts
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/accounts
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "currency_id" : "...",
  "status" : "active",
  "name" : "...",
  "withdrawal_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "cancelled",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "pending",
    "reason" : "..."
  } ],
  "deposit_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "failed",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "rejected",
    "reason" : "..."
  } ]
}


Home/Resources/BarController


/user/v1/current-bars/{security_id}/{periodicity}

Subscription for current bar of the specified security and periodicity. Periodically sends current unfinished bar. When current bars closes, sends finished bar before the new one.

Security can be specified either by path, or by header X-Deltix-Security-Id. The second way is preferred. If X-Deltix-Security-Id header is specified, the path value can be any unique string, only used to distinguish different subscriptions.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Aggregated-Exchanges header List of exchanges to be aggregated. Optional parameter.
X-Deltix-Separate-Exchanges header List of exchanges that will be returned separately. Optional parameter.
X-Deltix-Security-Id header Instrument for bar filtering.
security_id path Instrument for bar filtering. When X-Deltix-Security-Id header is specified, this can be any unique string. required
periodicity path Bar periodicity. Periodicity required

Message Body

media type data type description
application/json BarResponseDto Describes an aggregated bar with a list of bars per exchange.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/current-bars/BTCUSD/minute
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/current-bars/BTCUSD/minute
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "timestamp" : 12345,
  "aggregated_bar" : {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  },
  "exchange_bars" : [ {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  } ]
}


/app/v1/historical-bars

Returns the list of the user’s price bars of the specified instrument and periodicity within specified time interval. Can include current not complete bar. Cannot return more than max_bars_count bars. Time gaps (i.e. bars for non-trading time) must be filled with ‘empty’ bars - bars with all price and volume fields set to null.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json HistoricalBarsRequestDto Represents request for getting historical bars.

Response Body

media type data type description
application/json array of BarResponseDto Describes an aggregated bar with a list of bars per exchange.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/historical-bars
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "security_id" : "...",
  "periodicity" : "hour4",
  "start_time" : 12345,
  "end_time" : 12345,
  "aggregated_exchanges" : [ "...", "..." ],
  "separate_exchanges" : [ "...", "..." ]
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "timestamp" : 12345,
  "aggregated_bar" : {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  },
  "exchange_bars" : [ {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  } ]
}, {
  "timestamp" : 12345,
  "aggregated_bar" : {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  },
  "exchange_bars" : [ {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  } ]
} ]


Home/Resources/ChartController


/app/v1/chart-lines

Returns the list of all chart lines available for the user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of LineInfoDto Class that defines meta-information about chart line.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/chart-lines
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "name" : "...",
  "min_time" : 12345,
  "filters" : [ {
    "name" : "...",
    "values" : [ "...", "..." ]
  }, {
    "name" : "...",
    "values" : [ "...", "..." ]
  } ]
}, {
  "id" : "...",
  "name" : "...",
  "min_time" : 12345,
  "filters" : [ {
    "name" : "...",
    "values" : [ "...", "..." ]
  }, {
    "name" : "...",
    "values" : [ "...", "..." ]
  } ]
} ]


/user/v1/current-chart/{line_id}/{scale}

Subscription for current line dots. Periodically sends current unfinished line dot. When current dot closes, sends finished dot before the new one.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
line_id path Line’s unique identifier. required
scale path Line scale factor. required

Message Body

media type data type description
application/json LineDotDto Class that defines a line dot.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/current-chart/Line-1/60000
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/current-chart/Line-1/60000
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "time" : 12345,
  "value" : "123.4"
}


/app/v1/historical-chart

Returns the list of the user’s chart lines’ historical data. The number of actual returned dots in a line can be lower that the provided count parameter, depending on server’s configuration.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json array of HistoricalChartRequestDto Represents request for getting historical chart data.

Response Body

media type data type description
application/json array of LineSectionDto Class that defines a line section.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/historical-chart
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

[ {
  "line_id" : "...",
  "scale" : 12345,
  "filters" : [ "...", "..." ],
  "from" : 12345,
  "count" : 12345
}, {
  "line_id" : "...",
  "scale" : 12345,
  "filters" : [ "...", "..." ],
  "from" : 12345,
  "count" : 12345
} ]

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "dots" : [ {
    "time" : 12345,
    "value" : "123.4"
  }, {
    "time" : 12345,
    "value" : "123.4"
  } ]
}, {
  "dots" : [ {
    "time" : 12345,
    "value" : "123.4"
  }, {
    "time" : 12345,
    "value" : "123.4"
  } ]
} ]


Home/Resources/CurrencyController


/app/v1/currencies

Returns the list of all supported currencies.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of CurrencyDto Class that defines a currency.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/currencies
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "name" : "...",
  "type" : "...",
  "precision" : 12345,
  "icon" : "...",
  "icon_type" : "...",
  "sign" : "...",
  "daily_deposit_threshold" : "123.4",
  "daily_withdrawal_threshold" : "123.4",
  "weekly_deposit_threshold" : "123.4",
  "weekly_withdrawal_threshold" : "123.4",
  "monthly_deposit_threshold" : "123.4",
  "monthly_withdrawal_threshold" : "123.4",
  "yearly_deposit_threshold" : "123.4",
  "yearly_withdrawal_threshold" : "123.4",
  "daily_deposit_limit" : "123.4",
  "daily_withdrawal_limit" : "123.4",
  "weekly_deposit_limit" : "123.4",
  "weekly_withdrawal_limit" : "123.4",
  "monthly_deposit_limit" : "123.4",
  "monthly_withdrawal_limit" : "123.4",
  "yearly_deposit_limit" : "123.4",
  "yearly_withdrawal_limit" : "123.4",
  "limits_currency" : "...",
  "withdrawal_commission_progressive" : "123.4",
  "withdrawal_commission_flat" : "123.4",
  "deposit_commission_progressive" : "123.4",
  "deposit_commission_flat" : "123.4",
  "minimal_withdrawal" : "123.4",
  "withdrawals_allowed" : true,
  "deposits_allowed" : true,
  "allowed_account_properties" : [ "...", "..." ],
  "available_networks" : [ "...", "..." ],
  "use_abbreviations" : false,
  "custom_data" : "...",
  "custom_data2" : "..."
} ]


/app/v1/currencies/{currency_id}

Returns currency by id.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
currency_id path Requested currency identifier. required

Response Body

media type data type description
application/json CurrencyDto Class that defines a currency.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/currencies/BTC
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "name" : "...",
  "type" : "...",
  "precision" : 12345,
  "icon" : "...",
  "icon_type" : "...",
  "sign" : "...",
  "daily_deposit_threshold" : "123.4",
  "daily_withdrawal_threshold" : "123.4",
  "weekly_deposit_threshold" : "123.4",
  "weekly_withdrawal_threshold" : "123.4",
  "monthly_deposit_threshold" : "123.4",
  "monthly_withdrawal_threshold" : "123.4",
  "yearly_deposit_threshold" : "123.4",
  "yearly_withdrawal_threshold" : "123.4",
  "daily_deposit_limit" : "123.4",
  "daily_withdrawal_limit" : "123.4",
  "weekly_deposit_limit" : "123.4",
  "weekly_withdrawal_limit" : "123.4",
  "monthly_deposit_limit" : "123.4",
  "monthly_withdrawal_limit" : "123.4",
  "yearly_deposit_limit" : "123.4",
  "yearly_withdrawal_limit" : "123.4",
  "limits_currency" : "...",
  "withdrawal_commission_progressive" : "123.4",
  "withdrawal_commission_flat" : "123.4",
  "deposit_commission_progressive" : "123.4",
  "deposit_commission_flat" : "123.4",
  "minimal_withdrawal" : "123.4",
  "withdrawals_allowed" : false,
  "deposits_allowed" : true,
  "allowed_account_properties" : [ "...", "..." ],
  "available_networks" : [ "...", "..." ],
  "use_abbreviations" : false,
  "custom_data" : "...",
  "custom_data2" : "..."
}


/app/v1/currencies/{currency_id}/limits

Returns currency withdrawal and deposit limits taking into account transactions already performed by the user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
currency_id path Requested currency identifier. required

Response Body

media type data type description
application/json CurrencyLimitsDto Class that contains account’s withdrawal and deposit limits for the currency taking into account transactions already performed by the user.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/currencies/BTC/limits
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "withdrawal_limit" : "123.4",
  "deposit_limit" : "123.4"
}


/app/v1/currencies/{currency_id}/commission_plans

Returns a list of commission plans for a specific currency.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
currency_id path Requested currency identifier. required

Response Body

media type data type description
application/json array of CurrencyCommissionPlanDto Class that defines a commission plan for deposits and withdrawals.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/currencies/BTC/commission_plans
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "average_balance" : "123.4",
  "total_volume" : "123.4",
  "invited_users_count" : 12345,
  "withdrawal_commission_progressive" : "123.4",
  "withdrawal_commission_flat" : "123.4",
  "deposit_commission_progressive" : "123.4",
  "deposit_commission_flat" : "123.4"
}, {
  "average_balance" : "123.4",
  "total_volume" : "123.4",
  "invited_users_count" : 12345,
  "withdrawal_commission_progressive" : "123.4",
  "withdrawal_commission_flat" : "123.4",
  "deposit_commission_progressive" : "123.4",
  "deposit_commission_flat" : "123.4"
} ]


/app/v1/currencies/commission_plans/active/all

Returns active commission plans for all currencies available to the user: current commission plans and possible next commission plans.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of ActiveCurrencyCommissionPlansDto Class that contains current user’s commission plan for the currency with the possible next plans.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/currencies/commission_plans/active/all
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "currency_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  }
}, {
  "currency_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  }
} ]


/app/v1/currencies/{currency_id}/commission_plans/active

Returns active commission plans of the user for the specified currency: current commission plan and possible next commission plans.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
currency_id path Requested currency identifier. required

Response Body

media type data type description
application/json ActiveCurrencyCommissionPlansDto Class that contains current user’s commission plan for the currency with the possible next plans.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/currencies/BTC/commission_plans/active
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "currency_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  }
}


/user/v1/currencies

Subscription for currency changes. First snapshot will contain all currencies available to the user. The following snapshots will only contain the currencies that have changed since the last time.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json array of CurrencyActionDto Class that defines an action to a specific currency.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/currencies
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/currencies
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "action" : "insert",
  "currency" : {
    "id" : "...",
    "name" : "...",
    "type" : "...",
    "precision" : 12345,
    "icon" : "...",
    "icon_type" : "...",
    "sign" : "...",
    "daily_deposit_threshold" : "123.4",
    "daily_withdrawal_threshold" : "123.4",
    "weekly_deposit_threshold" : "123.4",
    "weekly_withdrawal_threshold" : "123.4",
    "monthly_deposit_threshold" : "123.4",
    "monthly_withdrawal_threshold" : "123.4",
    "yearly_deposit_threshold" : "123.4",
    "yearly_withdrawal_threshold" : "123.4",
    "daily_deposit_limit" : "123.4",
    "daily_withdrawal_limit" : "123.4",
    "weekly_deposit_limit" : "123.4",
    "weekly_withdrawal_limit" : "123.4",
    "monthly_deposit_limit" : "123.4",
    "monthly_withdrawal_limit" : "123.4",
    "yearly_deposit_limit" : "123.4",
    "yearly_withdrawal_limit" : "123.4",
    "limits_currency" : "...",
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4",
    "minimal_withdrawal" : "123.4",
    "withdrawals_allowed" : false,
    "deposits_allowed" : true,
    "allowed_account_properties" : [ "...", "..." ],
    "available_networks" : [ "...", "..." ],
    "use_abbreviations" : true,
    "custom_data" : "...",
    "custom_data2" : "..."
  }
}, {
  "id" : "...",
  "action" : "delete",
  "currency" : {
    "id" : "...",
    "name" : "...",
    "type" : "...",
    "precision" : 12345,
    "icon" : "...",
    "icon_type" : "...",
    "sign" : "...",
    "daily_deposit_threshold" : "123.4",
    "daily_withdrawal_threshold" : "123.4",
    "weekly_deposit_threshold" : "123.4",
    "weekly_withdrawal_threshold" : "123.4",
    "monthly_deposit_threshold" : "123.4",
    "monthly_withdrawal_threshold" : "123.4",
    "yearly_deposit_threshold" : "123.4",
    "yearly_withdrawal_threshold" : "123.4",
    "daily_deposit_limit" : "123.4",
    "daily_withdrawal_limit" : "123.4",
    "weekly_deposit_limit" : "123.4",
    "weekly_withdrawal_limit" : "123.4",
    "monthly_deposit_limit" : "123.4",
    "monthly_withdrawal_limit" : "123.4",
    "yearly_deposit_limit" : "123.4",
    "yearly_withdrawal_limit" : "123.4",
    "limits_currency" : "...",
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4",
    "minimal_withdrawal" : "123.4",
    "withdrawals_allowed" : true,
    "deposits_allowed" : false,
    "allowed_account_properties" : [ "...", "..." ],
    "available_networks" : [ "...", "..." ],
    "use_abbreviations" : false,
    "custom_data" : "...",
    "custom_data2" : "..."
  }
} ]


Home/Resources/CustomServicesController


/app/v1/custom-services/{service_name}

Returns the configuration of the custom service, if exists.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
service_name path Name of the target custom service. required

Response Body

media type data type description
application/json string

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/custom-services/SORPreview

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

...


/app/v1/custom-services

Returns a list of custom services available to the user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required

Response Body

media type data type description
application/json array of CustomServiceDto Class that defines a custom service.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/custom-services

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "name" : "...",
  "source_id" : 12345
}, {
  "name" : "...",
  "source_id" : 12345
} ]


/app/v1/custom-services/{service_name}/request

Sends a RPC request to the specified custom service and returns result.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
service_name path Name of the target custom service. required

Request Body

media type data type description
application/json string

Response Body

media type data type description
application/json string

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/custom-services/SORPreview/request

...

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

...


Home/Resources/FeeController


/user/v1/fees

Subscription for order’s fee changes. Maximum number of orders per user is limitted.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-ID header Order’s security. required
X-Deltix-Side header Order’s side. Side required
X-Deltix-Type header Order’s type. required
X-Deltix-Destination header Order’s destination. required
X-Deltix-Quantity header Order’s quantity. This is a string containing a decimal floating-point value. required
X-Deltix-Limit-Price header Order’s limit price. Only required for some types of orders. This is a string containing a decimal floating-point value.
X-Deltix-Stop-Price header Order’s stop price. Only required for some types of orders. This is a string containing a decimal floating-point value.

Message Body

media type data type description
application/json FeeDto Approximate order fee. Note: fee depends on the book state at the calculation time so actual value may differ from the calculated one.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/fees
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-ID:BTCUSD
X-Deltix-Side:buy
X-Deltix-Type:market
X-Deltix-Destination:DELTIX
X-Deltix-Quantity:1.0

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/fees
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "fee" : "123.4",
  "cost" : "123.4",
  "average_price" : "123.4",
  "comment" : "..."
}


Home/Resources/L2DataController


/user/v1/market-data/{security_id}

Subscription for market data updates.

Security can be specified either by path, or by header X-Deltix-Security-Id. The second way is preferred. If X-Deltix-Security-Id header is specified, the path value can be any unique string, only used to distinguish different subscriptions.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument L2 updates are for.
security_id path Instrument L2 updates are for. When X-Deltix-Security-Id header is specified, this can be any unique string. required

Message Body

media type data type description
application/json L2PackageDto Represents L2 package for the specified symbol.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/market-data/BTCUSD
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/market-data/BTCUSD
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "timestamp" : 12345,
  "security_id" : "...",
  "type" : "snapshot_full_refresh",
  "entries" : [ {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "sell",
    "action" : "update",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  }, {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "sell",
    "action" : "trade",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  } ],
  "sequence_number" : 12345
}


/app/v1/trades

Returns batch of last trades for specified symbol. Order is not guaranteed. This is the preferred way.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument trades are for. required

Response Body

media type data type description
application/json L2PackageDto Represents L2 package for the specified symbol.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/trades
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "timestamp" : 12345,
  "security_id" : "...",
  "type" : "incremental_update",
  "entries" : [ {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "buy",
    "action" : "delete",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  }, {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "buy",
    "action" : "update",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  } ],
  "sequence_number" : 12345
}


/app/v1/trades/{security_id}

Returns batch of last trades for specified symbol. Order is not guaranteed.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
security_id path Instrument trades are for. required

Response Body

media type data type description
application/json L2PackageDto Represents L2 package for the specified symbol.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/trades/BTCUSD
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "timestamp" : 12345,
  "security_id" : "...",
  "type" : "snapshot_full_refresh",
  "entries" : [ {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "sell",
    "action" : "insert",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  }, {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "buy",
    "action" : "delete",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  } ],
  "sequence_number" : 12345
}


Home/Resources/LinkedUsersController


/v1/linked/list

Returns a list of linked users.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of LinkedUserDto Class that defines a user to which the user can switch.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/v1/linked/list
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "username" : "...",
  "user_type" : "...",
  "public_id" : "...",
  "is_main" : true
}, {
  "id" : "...",
  "username" : "...",
  "user_type" : "...",
  "public_id" : "...",
  "is_main" : false
} ]


Home/Resources/LogController


/app/v1/log

Writes log message.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json LogDto Represents request for collecting log message.

Response Body

media type data type description
application/json string

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/log
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "logger" : "...",
  "message" : "...",
  "level" : "error"
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

"..."


Home/Resources/PrimeBrokerController


/app/v1/prime-broker/accounts

Returns a list of prime broker accounts, available for the user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of PrimeBrokerAccountDto

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/prime-broker/accounts
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "name" : "...",
  "custom_data" : "..."
}, {
  "id" : "...",
  "name" : "...",
  "custom_data" : "..."
} ]


Home/Resources/RFQController


/user/v1/rfq

Subscription for quotes updates.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json QuoteDto Class that defines a suggested quote.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/rfq
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/rfq
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "request_id" : "...",
  "id" : "...",
  "source" : "...",
  "bid_price" : "123.4",
  "bid_size" : "123.4",
  "ask_price" : "123.4",
  "ask_size" : "123.4",
  "currency_id" : "...",
  "valid_until_time" : 12345
}


/app/v1/rfq/request

Sends request for quotes. Returns request_id.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json QuoteRequestDto Class that defines a request for quote.

Response Body

media type data type description
application/json RFQRequestIdDto Represents RFQ request identifier.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/rfq/request
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "security_id" : "...",
  "side" : "buy",
  "size" : "123.4",
  "currency" : "...",
  "destination" : "...",
  "prime_broker_account" : "...",
  "settlement_date" : 12345,
  "tenor" : "...",
  "message" : "..."
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "request_id" : "..."
}


/app/v1/rfq/cancel

Cancels request for quotes with the specified request_id.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json RFQRequestIdDto Represents RFQ request identifier.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/rfq/cancel
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "request_id" : "..."
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916


/app/v1/rfq/list

Returns a list of quote requests for the user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of QuoteSubscriptionDto Class that defines a subscription for quotes.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/rfq/list
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "security_id" : "...",
  "side" : "buy",
  "size" : "123.4",
  "currency" : "...",
  "destination" : "...",
  "prime_broker_account" : "...",
  "settlement_date" : 12345,
  "tenor" : "...",
  "message" : "...",
  "request_id" : "...",
  "expire_time" : 12345,
  "last_quote" : {
    "request_id" : "...",
    "id" : "...",
    "source" : "...",
    "bid_price" : "123.4",
    "bid_size" : "123.4",
    "ask_price" : "123.4",
    "ask_size" : "123.4",
    "currency_id" : "...",
    "valid_until_time" : 12345
  }
}, {
  "security_id" : "...",
  "side" : "sell",
  "size" : "123.4",
  "currency" : "...",
  "destination" : "...",
  "prime_broker_account" : "...",
  "settlement_date" : 12345,
  "tenor" : "...",
  "message" : "...",
  "request_id" : "...",
  "expire_time" : 12345,
  "last_quote" : {
    "request_id" : "...",
    "id" : "...",
    "source" : "...",
    "bid_price" : "123.4",
    "bid_size" : "123.4",
    "ask_price" : "123.4",
    "ask_size" : "123.4",
    "currency_id" : "...",
    "valid_until_time" : 12345
  }
} ]


Home/Resources/SecurityController


/app/v1/securities

Returns a list of securities with user settings.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of SecurityDto Class that defines a security with the user-specific settings.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/securities
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "calendar_id" : "...",
  "name" : "...",
  "security_type" : "bond",
  "type" : "...",
  "tick_size" : "123.4",
  "multiplier" : "123.4",
  "base_currency" : "...",
  "term_currency" : "...",
  "trading_currency" : "base",
  "price_precision" : 12345,
  "quantity_precision" : 12345,
  "display_method" : "pips_highlight",
  "pips_highlight_start" : 12345,
  "pips_highlight_end" : 12345,
  "main_fraction" : 12345,
  "sub_fraction" : 12345,
  "number_of_fraction_decimals" : 12345,
  "max_bars_count" : 12345,
  "first_bar_timestamp" : 12345,
  "last_bar_timestamp" : 12345,
  "order_types" : [ "...", "..." ],
  "linked_order_types" : [ "...", "..." ],
  "time_in_forces" : [ "fok", "day" ],
  "default_time_in_force" : "gtd",
  "market_time_in_forces" : [ "good_till_crossing", "gtd" ],
  "default_market_time_in_force" : "gtd",
  "pre_open_time_in_forces" : [ "gtd", "fok" ],
  "default_pre_open_time_in_force" : "at_the_close",
  "minimum_quantity" : "123.4",
  "maximum_quantity" : "123.4",
  "default_quantity" : "123.4",
  "quantity_increment" : "123.4",
  "target_price_minimum" : "123.4",
  "target_price_maximum" : "123.4",
  "target_price_increment" : "123.4",
  "show_exchange_id" : false,
  "adjust_book" : false,
  "execution_explanation" : "commission",
  "available_book_exchanges" : [ "...", "..." ],
  "available_trade_exchanges" : [ "...", "..." ],
  "available_destinations" : [ "...", "..." ],
  "default_destination" : "...",
  "order_max_ttl" : 12345,
  "buyer_taker_commission_flat" : "123.4",
  "buyer_taker_commission_progressive" : "123.4",
  "seller_taker_commission_flat" : "123.4",
  "seller_taker_commission_progressive" : "123.4",
  "buyer_maker_commission_flat" : "123.4",
  "buyer_maker_commission_progressive" : "123.4",
  "buyer_flat_commission_method" : "exact_value",
  "buyer_progressive_commission_method" : "quantity_percent",
  "buyer_commission_account" : "source_account",
  "seller_maker_commission_flat" : "123.4",
  "seller_maker_commission_progressive" : "123.4",
  "seller_flat_commission_method" : "exact_value",
  "seller_progressive_commission_method" : "quantity_percent",
  "seller_commission_account" : "abc_account",
  "charge_flat_commission_at" : "acknowledgment",
  "taker_reserve_multiplier" : "123.4",
  "external_commissions" : [ {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  }, {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  } ],
  "prime_broker_accounts" : [ "...", "..." ],
  "is_rfq_allowed" : true,
  "custom_data" : "...",
  "custom_data2" : "...",
  "modification_time" : 12345
} ]


/app/v1/securities/statistics

Returns a list of securities statistics.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of SecurityStatisticsDto Class that defines security current prices and statistics.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/securities/statistics
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "security_id" : "...",
  "bid" : "123.4",
  "ask" : "123.4",
  "price_24h_change" : "123.4",
  "volume_24h_change" : "123.4",
  "price_24h_max" : "123.4",
  "price_24h_min" : "123.4",
  "last_trade_price" : "123.4"
}, {
  "security_id" : "...",
  "bid" : "123.4",
  "ask" : "123.4",
  "price_24h_change" : "123.4",
  "volume_24h_change" : "123.4",
  "price_24h_max" : "123.4",
  "price_24h_min" : "123.4",
  "last_trade_price" : "123.4"
} ]


/app/v1/securities/{security_id}

Returns a specific security with user settings.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
security_id path Instrument for bar filtering. required

Response Body

media type data type description
application/json SecurityDto Class that defines a security with the user-specific settings.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/securities/BTCUSD
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "calendar_id" : "...",
  "name" : "...",
  "security_type" : "nft",
  "type" : "...",
  "tick_size" : "123.4",
  "multiplier" : "123.4",
  "base_currency" : "...",
  "term_currency" : "...",
  "trading_currency" : "side",
  "price_precision" : 12345,
  "quantity_precision" : 12345,
  "display_method" : "plain_text",
  "pips_highlight_start" : 12345,
  "pips_highlight_end" : 12345,
  "main_fraction" : 12345,
  "sub_fraction" : 12345,
  "number_of_fraction_decimals" : 12345,
  "max_bars_count" : 12345,
  "first_bar_timestamp" : 12345,
  "last_bar_timestamp" : 12345,
  "order_types" : [ "...", "..." ],
  "linked_order_types" : [ "...", "..." ],
  "time_in_forces" : [ "gtc", "good_till_crossing" ],
  "default_time_in_force" : "at_the_opening",
  "market_time_in_forces" : [ "day", "good_till_crossing" ],
  "default_market_time_in_force" : "good_till_crossing",
  "pre_open_time_in_forces" : [ "gtd", "ioc" ],
  "default_pre_open_time_in_force" : "ioc",
  "minimum_quantity" : "123.4",
  "maximum_quantity" : "123.4",
  "default_quantity" : "123.4",
  "quantity_increment" : "123.4",
  "target_price_minimum" : "123.4",
  "target_price_maximum" : "123.4",
  "target_price_increment" : "123.4",
  "show_exchange_id" : false,
  "adjust_book" : false,
  "execution_explanation" : "price",
  "available_book_exchanges" : [ "...", "..." ],
  "available_trade_exchanges" : [ "...", "..." ],
  "available_destinations" : [ "...", "..." ],
  "default_destination" : "...",
  "order_max_ttl" : 12345,
  "buyer_taker_commission_flat" : "123.4",
  "buyer_taker_commission_progressive" : "123.4",
  "seller_taker_commission_flat" : "123.4",
  "seller_taker_commission_progressive" : "123.4",
  "buyer_maker_commission_flat" : "123.4",
  "buyer_maker_commission_progressive" : "123.4",
  "buyer_flat_commission_method" : "exact_value",
  "buyer_progressive_commission_method" : "exact_value",
  "buyer_commission_account" : "source_account",
  "seller_maker_commission_flat" : "123.4",
  "seller_maker_commission_progressive" : "123.4",
  "seller_flat_commission_method" : "exact_value",
  "seller_progressive_commission_method" : "exact_value",
  "seller_commission_account" : "destination_account",
  "charge_flat_commission_at" : "first_fill",
  "taker_reserve_multiplier" : "123.4",
  "external_commissions" : [ {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  }, {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  } ],
  "prime_broker_accounts" : [ "...", "..." ],
  "is_rfq_allowed" : true,
  "custom_data" : "...",
  "custom_data2" : "...",
  "modification_time" : 12345
}


/user/v1/securities

Subscription for security changes. First snapshot will contain all securities available to the user. The following snapshots will only contain the securities that have changed since the last time.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json array of SecurityActionDto Class that defines an action to a specific security.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/securities
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/securities
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "action" : "delete",
  "security" : {
    "id" : "...",
    "calendar_id" : "...",
    "name" : "...",
    "security_type" : "cfd",
    "type" : "...",
    "tick_size" : "123.4",
    "multiplier" : "123.4",
    "base_currency" : "...",
    "term_currency" : "...",
    "trading_currency" : "side",
    "price_precision" : 12345,
    "quantity_precision" : 12345,
    "display_method" : "fractions",
    "pips_highlight_start" : 12345,
    "pips_highlight_end" : 12345,
    "main_fraction" : 12345,
    "sub_fraction" : 12345,
    "number_of_fraction_decimals" : 12345,
    "max_bars_count" : 12345,
    "first_bar_timestamp" : 12345,
    "last_bar_timestamp" : 12345,
    "order_types" : [ "...", "..." ],
    "linked_order_types" : [ "...", "..." ],
    "time_in_forces" : [ "day", "ioc" ],
    "default_time_in_force" : "fok",
    "market_time_in_forces" : [ "gtc", "fok" ],
    "default_market_time_in_force" : "gtd",
    "pre_open_time_in_forces" : [ "ioc", "day" ],
    "default_pre_open_time_in_force" : "at_the_opening",
    "minimum_quantity" : "123.4",
    "maximum_quantity" : "123.4",
    "default_quantity" : "123.4",
    "quantity_increment" : "123.4",
    "target_price_minimum" : "123.4",
    "target_price_maximum" : "123.4",
    "target_price_increment" : "123.4",
    "show_exchange_id" : false,
    "adjust_book" : true,
    "execution_explanation" : "price",
    "available_book_exchanges" : [ "...", "..." ],
    "available_trade_exchanges" : [ "...", "..." ],
    "available_destinations" : [ "...", "..." ],
    "default_destination" : "...",
    "order_max_ttl" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "buyer_flat_commission_method" : "quantity_percent",
    "buyer_progressive_commission_method" : "quantity_percent",
    "buyer_commission_account" : "abc_account",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4",
    "seller_flat_commission_method" : "exact_value",
    "seller_progressive_commission_method" : "quantity_percent",
    "seller_commission_account" : "destination_account",
    "charge_flat_commission_at" : "first_fill",
    "taker_reserve_multiplier" : "123.4",
    "external_commissions" : [ {
      "exchange_id" : "...",
      "commission_currency" : "...",
      "maker_commission" : "123.4",
      "taker_commission" : "123.4"
    }, {
      "exchange_id" : "...",
      "commission_currency" : "...",
      "maker_commission" : "123.4",
      "taker_commission" : "123.4"
    } ],
    "prime_broker_accounts" : [ "...", "..." ],
    "is_rfq_allowed" : false,
    "custom_data" : "...",
    "custom_data2" : "...",
    "modification_time" : 12345
  }
}, {
  "id" : "...",
  "action" : "delete",
  "security" : {
    "id" : "...",
    "calendar_id" : "...",
    "name" : "...",
    "security_type" : "futures",
    "type" : "...",
    "tick_size" : "123.4",
    "multiplier" : "123.4",
    "base_currency" : "...",
    "term_currency" : "...",
    "trading_currency" : "side",
    "price_precision" : 12345,
    "quantity_precision" : 12345,
    "display_method" : "fractions",
    "pips_highlight_start" : 12345,
    "pips_highlight_end" : 12345,
    "main_fraction" : 12345,
    "sub_fraction" : 12345,
    "number_of_fraction_decimals" : 12345,
    "max_bars_count" : 12345,
    "first_bar_timestamp" : 12345,
    "last_bar_timestamp" : 12345,
    "order_types" : [ "...", "..." ],
    "linked_order_types" : [ "...", "..." ],
    "time_in_forces" : [ "at_the_opening", "ioc" ],
    "default_time_in_force" : "gtd",
    "market_time_in_forces" : [ "fok", "ioc" ],
    "default_market_time_in_force" : "at_the_opening",
    "pre_open_time_in_forces" : [ "at_the_close", "gtd" ],
    "default_pre_open_time_in_force" : "gtd",
    "minimum_quantity" : "123.4",
    "maximum_quantity" : "123.4",
    "default_quantity" : "123.4",
    "quantity_increment" : "123.4",
    "target_price_minimum" : "123.4",
    "target_price_maximum" : "123.4",
    "target_price_increment" : "123.4",
    "show_exchange_id" : true,
    "adjust_book" : true,
    "execution_explanation" : "price",
    "available_book_exchanges" : [ "...", "..." ],
    "available_trade_exchanges" : [ "...", "..." ],
    "available_destinations" : [ "...", "..." ],
    "default_destination" : "...",
    "order_max_ttl" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "buyer_flat_commission_method" : "quantity_percent",
    "buyer_progressive_commission_method" : "quantity_percent",
    "buyer_commission_account" : "source_account",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4",
    "seller_flat_commission_method" : "exact_value",
    "seller_progressive_commission_method" : "term_ticks",
    "seller_commission_account" : "abc_account",
    "charge_flat_commission_at" : "first_fill",
    "taker_reserve_multiplier" : "123.4",
    "external_commissions" : [ {
      "exchange_id" : "...",
      "commission_currency" : "...",
      "maker_commission" : "123.4",
      "taker_commission" : "123.4"
    }, {
      "exchange_id" : "...",
      "commission_currency" : "...",
      "maker_commission" : "123.4",
      "taker_commission" : "123.4"
    } ],
    "prime_broker_accounts" : [ "...", "..." ],
    "is_rfq_allowed" : false,
    "custom_data" : "...",
    "custom_data2" : "...",
    "modification_time" : 12345
  }
} ]


/user/v1/securities/statistics

Subscription for all securities prices and statistics change. First snapshot will contain all securities available to the user. The following snapshots will only contain the securities that have changed since the last time.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json array of SecurityStatisticsDto Class that defines security current prices and statistics.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/securities/statistics
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/securities/statistics
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "security_id" : "...",
  "bid" : "123.4",
  "ask" : "123.4",
  "price_24h_change" : "123.4",
  "volume_24h_change" : "123.4",
  "price_24h_max" : "123.4",
  "price_24h_min" : "123.4",
  "last_trade_price" : "123.4"
}, {
  "security_id" : "...",
  "bid" : "123.4",
  "ask" : "123.4",
  "price_24h_change" : "123.4",
  "volume_24h_change" : "123.4",
  "price_24h_max" : "123.4",
  "price_24h_min" : "123.4",
  "last_trade_price" : "123.4"
} ]


Home/Resources/SecurityV2Controller


/app/v2/securities

Returns a list of securities with user settings.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of SecurityV2Dto Class that defines a security with the user-specific settings.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "calendar_id" : "...",
  "name" : "...",
  "security_type" : "cfd",
  "type" : "...",
  "tick" : "123.4",
  "mul" : "123.4",
  "base" : "...",
  "term" : "...",
  "trade_curr" : "base",
  "p_prec" : 12345,
  "q_prec" : 12345,
  "display" : "plain_text",
  "pips" : [ 12345, 12345 ],
  "fract" : [ 12345, 12345 ],
  "o_types" : [ "...", "..." ],
  "lo_types" : [ "...", "..." ],
  "tif" : [ "ioc", "gtd" ],
  "tif_def" : "good_till_crossing",
  "m_tif" : [ "good_till_crossing", "ioc" ],
  "m_tif_def" : "at_the_opening",
  "po_tif" : [ "at_the_close", "at_the_opening" ],
  "po_tif_def" : "fok",
  "qty" : [ "123.4", "123.4" ],
  "price" : [ "123.4", "123.4" ],
  "show_exch" : true,
  "adjust_book" : false,
  "explain" : "none",
  "book_exch" : [ "...", "..." ],
  "trade_exch" : [ "...", "..." ],
  "dest" : [ "...", "..." ],
  "dest_def" : "...",
  "o_ttl" : 12345,
  "pb_acc" : [ "...", "..." ],
  "is_rfq" : false,
  "custom" : "...",
  "custom2" : "...",
  "time" : 12345
} ]


/app/v2/securities/info

Returns a specific security with user settings. This is the preferred way.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Response Body

media type data type description
application/json SecurityV2Dto Class that defines a security with the user-specific settings.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/info
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "id" : "...",
  "calendar_id" : "...",
  "name" : "...",
  "security_type" : "simple_option",
  "type" : "...",
  "tick" : "123.4",
  "mul" : "123.4",
  "base" : "...",
  "term" : "...",
  "trade_curr" : "side",
  "p_prec" : 12345,
  "q_prec" : 12345,
  "display" : "pips_highlight",
  "pips" : [ 12345, 12345 ],
  "fract" : [ 12345, 12345 ],
  "o_types" : [ "...", "..." ],
  "lo_types" : [ "...", "..." ],
  "tif" : [ "good_till_crossing", "at_the_close" ],
  "tif_def" : "day",
  "m_tif" : [ "gtc", "at_the_opening" ],
  "m_tif_def" : "day",
  "po_tif" : [ "at_the_opening", "fok" ],
  "po_tif_def" : "ioc",
  "qty" : [ "123.4", "123.4" ],
  "price" : [ "123.4", "123.4" ],
  "show_exch" : false,
  "adjust_book" : false,
  "explain" : "price",
  "book_exch" : [ "...", "..." ],
  "trade_exch" : [ "...", "..." ],
  "dest" : [ "...", "..." ],
  "dest_def" : "...",
  "o_ttl" : 12345,
  "pb_acc" : [ "...", "..." ],
  "is_rfq" : true,
  "custom" : "...",
  "custom2" : "...",
  "time" : 12345
}


/app/v2/securities/{security_id}

Returns a specific security with user settings. Deprecated. Use /app/v2/securities/info instead.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
security_id path Instrument required

Response Body

media type data type description
application/json SecurityV2Dto Class that defines a security with the user-specific settings.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/BTCUSD
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "calendar_id" : "...",
  "name" : "...",
  "security_type" : "nft",
  "type" : "...",
  "tick" : "123.4",
  "mul" : "123.4",
  "base" : "...",
  "term" : "...",
  "trade_curr" : "term",
  "p_prec" : 12345,
  "q_prec" : 12345,
  "display" : "pips_highlight",
  "pips" : [ 12345, 12345 ],
  "fract" : [ 12345, 12345 ],
  "o_types" : [ "...", "..." ],
  "lo_types" : [ "...", "..." ],
  "tif" : [ "day", "gtc" ],
  "tif_def" : "ioc",
  "m_tif" : [ "gtc", "ioc" ],
  "m_tif_def" : "at_the_opening",
  "po_tif" : [ "at_the_opening", "ioc" ],
  "po_tif_def" : "ioc",
  "qty" : [ "123.4", "123.4" ],
  "price" : [ "123.4", "123.4" ],
  "show_exch" : true,
  "adjust_book" : false,
  "explain" : "price",
  "book_exch" : [ "...", "..." ],
  "trade_exch" : [ "...", "..." ],
  "dest" : [ "...", "..." ],
  "dest_def" : "...",
  "o_ttl" : 12345,
  "pb_acc" : [ "...", "..." ],
  "is_rfq" : false,
  "custom" : "...",
  "custom2" : "...",
  "time" : 12345
}


/app/v2/securities/bar_info

Returns security bar info for a specific security. This is the preferred way.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Response Body

media type data type description
application/json SecurityBarsDto Class that defines security bars.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/bar_info
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "max_bars_count" : 12345,
  "first_bar_timestamp" : 12345,
  "last_bar_timestamp" : 12345
}


/app/v2/securities/{security_id}/bar_info

Returns security bar info for a specific security. Deprecated. Use /app/v2/securities/bar_info instead.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
security_id path Instrument required

Response Body

media type data type description
application/json SecurityBarsDto Class that defines security bars.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/BTCUSD/bar_info
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "max_bars_count" : 12345,
  "first_bar_timestamp" : 12345,
  "last_bar_timestamp" : 12345
}


/app/v2/securities/commissions/all

Returns security commissions for all securities available to the user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of SecurityCommissionsDto Class that defines security commissions.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/commissions/all
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "security_id" : "...",
  "buyer_flat_commission_method" : "quantity_percent",
  "buyer_progressive_commission_method" : "quantity_percent",
  "buyer_commission_account" : "destination_account",
  "seller_flat_commission_method" : "exact_value",
  "seller_progressive_commission_method" : "exact_value",
  "seller_commission_account" : "source_account",
  "charge_flat_commission_at" : "first_fill",
  "taker_reserve_multiplier" : "123.4",
  "external_commissions" : [ {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  }, {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  } ],
  "current_commission_plan" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
} ]


/app/v2/securities/commissions

Returns security commissions for a specific security. This is the preferred way.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Response Body

media type data type description
application/json SecurityCommissionsDto Class that defines security commissions.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/commissions
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "security_id" : "...",
  "buyer_flat_commission_method" : "quantity_percent",
  "buyer_progressive_commission_method" : "quantity_percent",
  "buyer_commission_account" : "abc_account",
  "seller_flat_commission_method" : "term_ticks",
  "seller_progressive_commission_method" : "exact_value",
  "seller_commission_account" : "abc_account",
  "charge_flat_commission_at" : "first_fill",
  "taker_reserve_multiplier" : "123.4",
  "external_commissions" : [ {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  }, {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  } ],
  "current_commission_plan" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
}


/app/v2/securities/{security_id}/commissions

Returns security commissions for a specific security. Deprecated. Use /app/v2/securities/commissions instead.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
security_id path Instrument required

Response Body

media type data type description
application/json SecurityCommissionsDto Class that defines security commissions.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/BTCUSD/commissions
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "security_id" : "...",
  "buyer_flat_commission_method" : "exact_value",
  "buyer_progressive_commission_method" : "quantity_percent",
  "buyer_commission_account" : "destination_account",
  "seller_flat_commission_method" : "exact_value",
  "seller_progressive_commission_method" : "term_ticks",
  "seller_commission_account" : "destination_account",
  "charge_flat_commission_at" : "acknowledgment",
  "taker_reserve_multiplier" : "123.4",
  "external_commissions" : [ {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  }, {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  } ],
  "current_commission_plan" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
}


/app/v2/securities/commission_plans

Returns a list of commission plans for a specific security. This is the preferred way.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Response Body

media type data type description
application/json array of CommissionPlanDto Class that defines a commission plan.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/commission_plans
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

[ {
  "average_balance" : "123.4",
  "total_volume" : "123.4",
  "invited_users_count" : 12345,
  "buyer_taker_commission_flat" : "123.4",
  "buyer_taker_commission_progressive" : "123.4",
  "seller_taker_commission_flat" : "123.4",
  "seller_taker_commission_progressive" : "123.4",
  "buyer_maker_commission_flat" : "123.4",
  "buyer_maker_commission_progressive" : "123.4",
  "seller_maker_commission_flat" : "123.4",
  "seller_maker_commission_progressive" : "123.4"
} ]


/app/v2/securities/{security_id}/commission_plans

Returns a list of commission plans for a specific security. Deprecated. Use /app/v2/securities/commission_plans instead.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
security_id path Instrument required

Response Body

media type data type description
application/json array of CommissionPlanDto Class that defines a commission plan.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/BTCUSD/commission_plans
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "average_balance" : "123.4",
  "total_volume" : "123.4",
  "invited_users_count" : 12345,
  "buyer_taker_commission_flat" : "123.4",
  "buyer_taker_commission_progressive" : "123.4",
  "seller_taker_commission_flat" : "123.4",
  "seller_taker_commission_progressive" : "123.4",
  "buyer_maker_commission_flat" : "123.4",
  "buyer_maker_commission_progressive" : "123.4",
  "seller_maker_commission_flat" : "123.4",
  "seller_maker_commission_progressive" : "123.4"
} ]


/app/v2/securities/commission_plans/active/all

Returns active commission plans for all securities available to the user: current commission plans and possible next commission plans.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of ActiveCommissionPlansDto Class that contains current user’s commission plan for the security with the possible next plans.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/commission_plans/active/all
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "security_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
}, {
  "security_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
} ]


/app/v2/securities/commission_plans/active

Returns active commission plans of the user for the specified security: current commission plan and possible next commission plans. This is the preferred way.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Response Body

media type data type description
application/json ActiveCommissionPlansDto Class that contains current user’s commission plan for the security with the possible next plans.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/commission_plans/active
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "security_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
}


/app/v2/securities/{security_id}/commission_plans/active

Returns active commission plans of the user for the specified security: current commission plan and possible next commission plans. Deprecated. Use /app/v2/securities/commission_plans/active instead.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
security_id path Instrument required

Response Body

media type data type description
application/json ActiveCommissionPlansDto Class that contains current user’s commission plan for the security with the possible next plans.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/BTCUSD/commission_plans/active
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "security_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
}


/app/v2/securities/session

Returns current trading session for a specific security, if present.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Response Body

media type data type description
application/json TradingSessionDto Class that defines a trading session.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/session
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "calendar_id" : "...",
  "pre_open" : 12345,
  "start" : 12345,
  "end" : 12345,
  "current_status" : "non_trading"
}


/app/v2/securities/status

Returns status for a specific security.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Response Body

media type data type description
application/json SecurityStatusDto Class that defines current security status.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v2/securities/status
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "session_status" : "non_trading"
}


/user/v2/securities

Subscription for security changes. First snapshot will contain all securities available to the user. The following snapshots will only contain the securities that have changed since the last time.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json array of SecurityV2ActionDto

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v2/securities
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v2/securities
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "action" : "delete",
  "security" : {
    "id" : "...",
    "calendar_id" : "...",
    "name" : "...",
    "security_type" : "simple_option",
    "type" : "...",
    "tick" : "123.4",
    "mul" : "123.4",
    "base" : "...",
    "term" : "...",
    "trade_curr" : "term",
    "p_prec" : 12345,
    "q_prec" : 12345,
    "display" : "fractions",
    "pips" : [ 12345, 12345 ],
    "fract" : [ 12345, 12345 ],
    "o_types" : [ "...", "..." ],
    "lo_types" : [ "...", "..." ],
    "tif" : [ "gtc", "gtc" ],
    "tif_def" : "day",
    "m_tif" : [ "at_the_close", "ioc" ],
    "m_tif_def" : "fok",
    "po_tif" : [ "day", "good_till_crossing" ],
    "po_tif_def" : "good_till_crossing",
    "qty" : [ "123.4", "123.4" ],
    "price" : [ "123.4", "123.4" ],
    "show_exch" : false,
    "adjust_book" : true,
    "explain" : "commission",
    "book_exch" : [ "...", "..." ],
    "trade_exch" : [ "...", "..." ],
    "dest" : [ "...", "..." ],
    "dest_def" : "...",
    "o_ttl" : 12345,
    "pb_acc" : [ "...", "..." ],
    "is_rfq" : true,
    "custom" : "...",
    "custom2" : "...",
    "time" : 12345
  }
}, {
  "id" : "...",
  "action" : "insert",
  "security" : {
    "id" : "...",
    "calendar_id" : "...",
    "name" : "...",
    "security_type" : "futures",
    "type" : "...",
    "tick" : "123.4",
    "mul" : "123.4",
    "base" : "...",
    "term" : "...",
    "trade_curr" : "base",
    "p_prec" : 12345,
    "q_prec" : 12345,
    "display" : "fractions",
    "pips" : [ 12345, 12345 ],
    "fract" : [ 12345, 12345 ],
    "o_types" : [ "...", "..." ],
    "lo_types" : [ "...", "..." ],
    "tif" : [ "good_till_crossing", "good_till_crossing" ],
    "tif_def" : "gtd",
    "m_tif" : [ "at_the_opening", "gtd" ],
    "m_tif_def" : "good_till_crossing",
    "po_tif" : [ "at_the_opening", "at_the_close" ],
    "po_tif_def" : "ioc",
    "qty" : [ "123.4", "123.4" ],
    "price" : [ "123.4", "123.4" ],
    "show_exch" : true,
    "adjust_book" : true,
    "explain" : "price",
    "book_exch" : [ "...", "..." ],
    "trade_exch" : [ "...", "..." ],
    "dest" : [ "...", "..." ],
    "dest_def" : "...",
    "o_ttl" : 12345,
    "pb_acc" : [ "...", "..." ],
    "is_rfq" : false,
    "custom" : "...",
    "custom2" : "...",
    "time" : 12345
  }
} ]


/user/v2/securities/status

Subscription for security status changes. First message will return current security status.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument required

Message Body

media type data type description
application/json array of SecurityStatusDto Class that defines current security status.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v2/securities/status
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Unsubscribe:

UNSUBSCRIBE
id:sub-0
X-Deltix-Security-Id:BTCUSD

Message:

MESSAGE
status:200
destination:/user/v2/securities/status
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

[ {
  "session_status" : "non_trading"
}, {
  "session_status" : "pre_trading"
} ]


Home/Resources/StakingController


/user/v1/staking

Subscription for staking changes.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json StakingDto Class that defines a staking.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/staking
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/staking
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "staking_plan_id" : "...",
  "currency" : "...",
  "account_id" : "...",
  "period_ms" : 12345,
  "bonding_period" : 12345,
  "unbonding_period" : 12345,
  "safe_period" : 12345,
  "annual_interest" : "123.4",
  "fee" : "123.4",
  "standard_cancellation_return" : "123.4",
  "instant_cancellation_return" : "123.4",
  "infinite" : true,
  "returnable" : false,
  "partially_returnable" : false,
  "auto_stake" : false,
  "stake_more" : true,
  "minimum_amount" : "123.4",
  "description" : "...",
  "amount" : "123.4",
  "start_time" : 12345,
  "end_time" : 12345,
  "gainings" : "123.4",
  "cumulative_gainings" : "123.4",
  "fee_amount" : "123.4",
  "cumulative_fee_amount" : "123.4",
  "is_unbonding" : false,
  "cancellation_type" : "standard",
  "reason" : "...",
  "status" : "cancelled",
  "creation_time" : 12345,
  "modification_time" : 12345
}


Home/Resources/SystemController


/app/v1/global/settings

Returns global application settings.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required

Response Body

media type data type description
application/json GlobalSettingsDto Class that defines global application settings.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/global/settings

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "auth_settings" : {
    "provider" : "...",
    "discovery_url" : "...",
    "client_id" : "...",
    "audience" : "...",
    "scopes" : "..."
  },
  "keepalive_timeout" : 12345
}


/app/v1/trader/health

Returns application health status.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required

Response Body

media type data type description
application/json HealthStatusDto Class that defines a health status of the application.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/trader/health

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "timestamp" : 12345,
  "application" : "...",
  "version" : "...",
  "is_alive" : false,
  "users" : 12345,
  "logins" : 12345
}


/user/v1/time

Subscribes for retrieving server time. Returns current server time in milliseconds since midnight, January 1, 1970 UTC approximately once per second.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required

Message Body

media type data type description
application/json number

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/time
X-Deltix-Nonce:12345

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/time
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

12345


Home/Resources/TradingController


/user/v1/current-trading-statistics

Subscription for current trading statistics. Returns statistics on each update for the current period.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json CurrentTradingStatisticsDto Class that defines trading statistics for current period for specified user.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/current-trading-statistics
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/current-trading-statistics
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "current_volume" : "123.4",
  "current_average_balance" : "123.4",
  "current_invited_users_count" : 12345,
  "current_trading_commission" : "123.4",
  "statistics_time" : 12345
}


/user/v1/orders

Subscription for active orders updates. Returns all user active orders on subscription. After that sends order updates.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json OrderUpdateDto Represents update for the order with the list of events, that has changed it from the previous state.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/orders
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/orders
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "order" : {
    "client_order_id" : "...",
    "security_id" : "...",
    "quote_id" : "...",
    "type" : "...",
    "side" : "sell",
    "quantity" : "123.4",
    "time_in_force" : "at_the_close",
    "limit_price" : "123.4",
    "stop_price" : "123.4",
    "peg_difference" : "123.4",
    "min_quantity" : "123.4",
    "display_quantity" : "123.4",
    "leverage" : "123.4",
    "expire_time" : 12345,
    "submission_time" : 12345,
    "destination" : "...",
    "exchange_id" : "...",
    "source" : "...",
    "currency" : "...",
    "text" : "...",
    "properties" : [ {
      "key" : "...",
      "value" : "..."
    }, {
      "key" : "...",
      "value" : "..."
    } ],
    "id" : "...",
    "correlation_id" : "...",
    "timestamp" : 12345,
    "status" : "replaced",
    "trader_name" : "...",
    "product_type" : "spot",
    "cumulative_quantity" : "123.4",
    "remaining_quantity" : "123.4",
    "average_price" : "123.4",
    "receipt_time" : 12345,
    "close_time" : 12345,
    "last_timestamp" : 12345,
    "last_trade_price" : "123.4",
    "counterparty_code" : "...",
    "settlement_date" : 12345,
    "reason" : "..."
  },
  "events" : [ {
    "id" : "...",
    "event_id" : "...",
    "type" : "trade",
    "sequence_number" : 12345,
    "timestamp" : 12345,
    "reason" : "...",
    "client_order_id" : "...",
    "security_id" : "...",
    "order_type" : "...",
    "order_side" : "sell",
    "quantity" : "123.4",
    "time_in_force" : "good_till_crossing",
    "limit_price" : "123.4",
    "stop_price" : "123.4",
    "average_price" : "123.4",
    "leverage" : "123.4",
    "expire_time" : 12345,
    "destination" : "...",
    "currency" : "...",
    "exchange_id" : "...",
    "text" : "...",
    "properties" : [ {
      "key" : "...",
      "value" : "..."
    }, {
      "key" : "...",
      "value" : "..."
    } ],
    "order_id" : "...",
    "order_status" : "pending_replace",
    "cumulative_quantity" : "123.4",
    "remaining_quantity" : "123.4",
    "original_client_order_id" : "...",
    "trade_quantity" : "123.4",
    "trade_price" : "123.4",
    "is_agressor" : true,
    "commission" : "123.4",
    "commission_currency" : "..."
  } ]
}


/user/v1/deals

Subscription for active deals (positions) updates.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json DealDto Represents a user’s deal (position).

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/deals
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/deals
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "security_id" : "...",
  "side" : "short",
  "quantity" : "123.4",
  "open_quantity_in_abc" : "123.4",
  "open_quantity_in_urc" : "123.4",
  "good_till_date" : 12345,
  "sequence_number" : 12345,
  "open_order_id" : "...",
  "open_price" : "123.4",
  "open_time" : 12345,
  "open_reason" : "...",
  "rollover_commission" : "123.4",
  "trading_commission" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "margin_used" : "123.4",
  "leverage" : "123.4",
  "liquidation_price" : "123.4",
  "take_profit_price" : "123.4"
}


/app/v1/orders/create

Creates an order for the specified user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json NewOrderDto Represents request for creating or modifying order.

Response Body

media type data type description
application/json OrderDto Represents user’s order as returned by the API.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/create
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "sell",
  "quantity" : "123.4",
  "time_in_force" : "gtc",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "buy",
  "quantity" : "123.4",
  "time_in_force" : "day",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "id" : "...",
  "correlation_id" : "...",
  "timestamp" : 12345,
  "status" : "pending_new",
  "trader_name" : "...",
  "product_type" : "spot",
  "cumulative_quantity" : "123.4",
  "remaining_quantity" : "123.4",
  "average_price" : "123.4",
  "receipt_time" : 12345,
  "close_time" : 12345,
  "last_timestamp" : 12345,
  "last_trade_price" : "123.4",
  "counterparty_code" : "...",
  "settlement_date" : 12345,
  "reason" : "..."
}


/app/v1/orders/modify

Modifies an order for the specified user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Order-ID header Order identifier. required

Request Body

media type data type description
application/json NewOrderDto Represents request for creating or modifying order.

Response Body

media type data type description
application/json OrderDto Represents user’s order as returned by the API.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/modify
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Order-ID:01234567-8910-1112-1314-151617181920

{
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "buy",
  "quantity" : "123.4",
  "time_in_force" : "at_the_opening",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "sell",
  "quantity" : "123.4",
  "time_in_force" : "ioc",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "id" : "...",
  "correlation_id" : "...",
  "timestamp" : 12345,
  "status" : "new",
  "trader_name" : "...",
  "product_type" : "pre_spot",
  "cumulative_quantity" : "123.4",
  "remaining_quantity" : "123.4",
  "average_price" : "123.4",
  "receipt_time" : 12345,
  "close_time" : 12345,
  "last_timestamp" : 12345,
  "last_trade_price" : "123.4",
  "counterparty_code" : "...",
  "settlement_date" : 12345,
  "reason" : "..."
}


/app/v1/orders/cancel

Cancels active order by id or by client id. One of X-Deltix-Order-ID or X-Deltix-Client-Order-ID must be specified.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Order-ID header Order identifier.
X-Deltix-Client-Order-ID header Order identifier, defined by client.
X-Deltix-Source header Source from where the order cancellation was sent. Must be alphanumeric-encodable. If missing, default source will be used.

Response Body

media type data type description
application/json OrderDto Represents user’s order as returned by the API.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/cancel
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "sell",
  "quantity" : "123.4",
  "time_in_force" : "good_till_crossing",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "id" : "...",
  "correlation_id" : "...",
  "timestamp" : 12345,
  "status" : "suspended",
  "trader_name" : "...",
  "product_type" : "pre_spot",
  "cumulative_quantity" : "123.4",
  "remaining_quantity" : "123.4",
  "average_price" : "123.4",
  "receipt_time" : 12345,
  "close_time" : 12345,
  "last_timestamp" : 12345,
  "last_trade_price" : "123.4",
  "counterparty_code" : "...",
  "settlement_date" : 12345,
  "reason" : "..."
}


/app/v1/orders/events

Returns a batch of order events starting from the time specified ordered by OrderEventDto.timestamp. The last returned event is guarantied to be the last event with its timestamp. In order to receive events starting from the next sequential event, you need to set startTime parameter to last event timestamp increased by 1 ms in case of direct order, or last event timestamp decreased by 1 ms in case of reversed order.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json OrderEventsRequestDto Represents request for getting user’s order events.

Response Body

media type data type description
application/json array of OrderEventDto Represents events related to the order like order creation, changing, execution, cancellation etc.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/events
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "start_time" : 12345,
  "reversed" : true,
  "current_session" : false,
  "skip_replaced" : false,
  "count" : 12345
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "id" : "...",
  "event_id" : "...",
  "type" : "cancel",
  "sequence_number" : 12345,
  "timestamp" : 12345,
  "reason" : "...",
  "client_order_id" : "...",
  "security_id" : "...",
  "order_type" : "...",
  "order_side" : "buy",
  "quantity" : "123.4",
  "time_in_force" : "day",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "average_price" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "destination" : "...",
  "currency" : "...",
  "exchange_id" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "order_id" : "...",
  "order_status" : "completely_filled",
  "cumulative_quantity" : "123.4",
  "remaining_quantity" : "123.4",
  "original_client_order_id" : "...",
  "trade_quantity" : "123.4",
  "trade_price" : "123.4",
  "is_agressor" : false,
  "commission" : "123.4",
  "commission_currency" : "..."
} ]


/app/v1/orders/history

Returns a batch of closed order starting from the time specified ordered by OrderDto.timestamp and filtered by it. The last returned event is guarantied to be the last event with its timestamp. In order to receive events starting from the next sequential event, you need to set startTime parameter to last event timestamp increased by 1 ms in case of direct order, or last event timestamp decreased by 1 ms in case of reversed order.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json OrderEventsRequestDto Represents request for getting user’s order events.

Response Body

media type data type description
application/json array of OrderDto Represents user’s order as returned by the API.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/history
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "start_time" : 12345,
  "reversed" : true,
  "current_session" : true,
  "skip_replaced" : true,
  "count" : 12345
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "buy",
  "quantity" : "123.4",
  "time_in_force" : "gtc",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "id" : "...",
  "correlation_id" : "...",
  "timestamp" : 12345,
  "status" : "completely_filled",
  "trader_name" : "...",
  "product_type" : "spot",
  "cumulative_quantity" : "123.4",
  "remaining_quantity" : "123.4",
  "average_price" : "123.4",
  "receipt_time" : 12345,
  "close_time" : 12345,
  "last_timestamp" : 12345,
  "last_trade_price" : "123.4",
  "counterparty_code" : "...",
  "settlement_date" : 12345,
  "reason" : "..."
} ]


/app/v1/deals/modify

Modifies a deal for the specified user.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json DealDto Represents a user’s deal (position).

Response Body

media type data type description
application/json DealDto Represents a user’s deal (position).

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/deals/modify
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "id" : "...",
  "security_id" : "...",
  "side" : "short",
  "quantity" : "123.4",
  "open_quantity_in_abc" : "123.4",
  "open_quantity_in_urc" : "123.4",
  "good_till_date" : 12345,
  "sequence_number" : 12345,
  "open_order_id" : "...",
  "open_price" : "123.4",
  "open_time" : 12345,
  "open_reason" : "...",
  "rollover_commission" : "123.4",
  "trading_commission" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "margin_used" : "123.4",
  "leverage" : "123.4",
  "liquidation_price" : "123.4",
  "take_profit_price" : "123.4"
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "id" : "...",
  "security_id" : "...",
  "side" : "long",
  "quantity" : "123.4",
  "open_quantity_in_abc" : "123.4",
  "open_quantity_in_urc" : "123.4",
  "good_till_date" : 12345,
  "sequence_number" : 12345,
  "open_order_id" : "...",
  "open_price" : "123.4",
  "open_time" : 12345,
  "open_reason" : "...",
  "rollover_commission" : "123.4",
  "trading_commission" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "margin_used" : "123.4",
  "leverage" : "123.4",
  "liquidation_price" : "123.4",
  "take_profit_price" : "123.4"
}


/app/v1/trading/limits

Returns trading limits and current user’s values, if present.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json TradingLimitsDto Class that defines trading statistics.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/trading/limits
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "currency_id" : "...",
  "daily_volume_limit" : "123.4",
  "weekly_volume_limit" : "123.4",
  "monthly_volume_limit" : "123.4",
  "yearly_volume_limit" : "123.4",
  "daily_volume" : "123.4",
  "weekly_volume" : "123.4",
  "monthly_volume" : "123.4",
  "yearly_volume" : "123.4",
  "total_volume" : "123.4"
}


/app/v1/orders/confirmation/description

Returns a description shown to the user on order confirmation.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json OrderConfirmationTextRequestDto Represents request for getting an order confirmation description text.

Response Body

media type data type description
application/json DescriptionTextDto Represents a description text.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/confirmation/description
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "security_id" : "...",
  "side" : "..."
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "text" : "..."
}


/app/v1/orders/schema

Returns a json schema for orders. Specification: https://tools.ietf.org/html/draft-handrews-json-schema-01


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument identifier.

Response Body

media type data type description
application/json DescriptionTextDto Represents a description text.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/schema
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "text" : "..."
}


/app/v1/orders/schema/modify

Returns a json schema for modifying orders. Specification: https://tools.ietf.org/html/draft-handrews-json-schema-01


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument identifier.

Response Body

media type data type description
application/json DescriptionTextDto Represents a description text.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/schema/modify
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "text" : "..."
}


/app/v1/orders/schema/pre-open

Returns a json schema for pre-open orders. Specification: https://tools.ietf.org/html/draft-handrews-json-schema-01


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument identifier.

Response Body

media type data type description
application/json DescriptionTextDto Represents a description text.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/schema/pre-open
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "text" : "..."
}


/app/v1/orders/schema/pre-open/modify

Returns a json schema for modifying pre-open orders. Specification: https://tools.ietf.org/html/draft-handrews-json-schema-01


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument identifier.

Response Body

media type data type description
application/json DescriptionTextDto Represents a description text.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/schema/pre-open/modify
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

{
  "text" : "..."
}


/app/v1/orders/schema/linked

Returns a list of json schemas for linked orders. Specification: https://tools.ietf.org/html/draft-handrews-json-schema-01


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-Security-Id header Instrument identifier.

Response Body

media type data type description
application/json array of LinkedOrderSchemaDto Represents a linked order schema.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/schema/linked
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920
X-Deltix-Security-Id:BTCUSD

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916
X-Deltix-Security-Id:BTCUSD

[ {
  "type" : "...",
  "view" : "...",
  "send" : "..."
}, {
  "type" : "...",
  "view" : "...",
  "send" : "..."
} ]


/app/v1/orders/schema/details

Returns a json schema for orders details. Specification: https://tools.ietf.org/html/draft-handrews-json-schema-01


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json DescriptionTextDto Represents a description text.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/orders/schema/details
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "text" : "..."
}


Home/Resources/TradingSessionController


/app/v1/trading-sessions

Returns the list of all trading sessions active for the current moment.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of TradingSessionDto Class that defines a trading session.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/trading-sessions
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "calendar_id" : "...",
  "pre_open" : 12345,
  "start" : 12345,
  "end" : 12345,
  "current_status" : "pre_trading"
}, {
  "calendar_id" : "...",
  "pre_open" : 12345,
  "start" : 12345,
  "end" : 12345,
  "current_status" : "pre_trading"
} ]


/user/v1/trading-sessions

Subscription for active orders updates. Returns all user active orders on subscription. After that sends order updates.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.
X-Deltix-From header Left border of current trading sessions interval in milliseconds. Must be between 0 and one week. Optional. Default value is 0.
X-Deltix-Till header Right border of current trading sessions interval in milliseconds. Must be between 0 and one week. Optional. Default value is 0.

Message Body

media type data type description
application/json array of TradingSessionDto Class that defines a trading session.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/trading-sessions
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/trading-sessions
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "calendar_id" : "...",
  "pre_open" : 12345,
  "start" : 12345,
  "end" : 12345,
  "current_status" : "trading"
}, {
  "calendar_id" : "...",
  "pre_open" : 12345,
  "start" : 12345,
  "end" : 12345,
  "current_status" : "non_trading"
} ]


Home/Resources/TransactionController


/user/v1/transactions

Subscription for transaction-in-progress changes.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json TransactionDto Class that defines a transaction.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/transactions
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/transactions
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "account_id" : "...",
  "currency_id" : "...",
  "id" : "...",
  "type" : "interest_commission",
  "amount" : "123.4",
  "post_balance" : "123.4",
  "status" : "succeeded",
  "reason" : "...",
  "address" : "...",
  "internal_transaction_id" : "...",
  "network" : "...",
  "transaction_id" : "...",
  "confirmations" : 12345,
  "confirmations_needed" : 12345,
  "external_currency_id" : "...",
  "external_conversion_price" : "123.4",
  "creation_time" : 12345,
  "modification_time" : 12345
}


/app/v1/transactions/incomplete

Gets the list of incomplete user transactions (transfers).


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json array of TransactionDto Class that defines a transaction.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/transactions/incomplete
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "account_id" : "...",
  "currency_id" : "...",
  "id" : "...",
  "type" : "trading_commission",
  "amount" : "123.4",
  "post_balance" : "123.4",
  "status" : "rejected",
  "reason" : "...",
  "address" : "...",
  "internal_transaction_id" : "...",
  "network" : "...",
  "transaction_id" : "...",
  "confirmations" : 12345,
  "confirmations_needed" : 12345,
  "external_currency_id" : "...",
  "external_conversion_price" : "123.4",
  "creation_time" : 12345,
  "modification_time" : 12345
} ]


/app/v1/transactions/history

Gets a batch of user transfers starting from the specified time.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json HistoricalTransactionRequestDto Represents a request for the history of transactions.

Response Body

media type data type description
application/json array of TransactionDto Class that defines a transaction.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/transactions/history
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "start_time" : 12345,
  "reversed" : false,
  "count" : 12345,
  "transaction_types" : [ "withdrawal_reservation", "rollover_commission" ]
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "account_id" : "...",
  "currency_id" : "...",
  "id" : "...",
  "type" : "withdrawal",
  "amount" : "123.4",
  "post_balance" : "123.4",
  "status" : "succeeded",
  "reason" : "...",
  "address" : "...",
  "internal_transaction_id" : "...",
  "network" : "...",
  "transaction_id" : "...",
  "confirmations" : 12345,
  "confirmations_needed" : 12345,
  "external_currency_id" : "...",
  "external_conversion_price" : "123.4",
  "creation_time" : 12345,
  "modification_time" : 12345
} ]


/app/v1/transactions/complete

Gets a batch of complete user transactions starting from the specified time.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json HistoricalTransactionRequestDto Represents a request for the history of transactions.

Response Body

media type data type description
application/json array of TransactionDto Class that defines a transaction.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/transactions/complete
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "start_time" : 12345,
  "reversed" : true,
  "count" : 12345,
  "transaction_types" : [ "interest", "withdrawal" ]
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

[ {
  "account_id" : "...",
  "currency_id" : "...",
  "id" : "...",
  "type" : "transfer_send",
  "amount" : "123.4",
  "post_balance" : "123.4",
  "status" : "in_progress",
  "reason" : "...",
  "address" : "...",
  "internal_transaction_id" : "...",
  "network" : "...",
  "transaction_id" : "...",
  "confirmations" : 12345,
  "confirmations_needed" : 12345,
  "external_currency_id" : "...",
  "external_conversion_price" : "123.4",
  "creation_time" : 12345,
  "modification_time" : 12345
} ]


Home/Resources/TransferController


/user/v1/transfers

Subscription for transfer-in-progress changes.


Request Parameters

name type description constraints
id header Subscription identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Message Body

media type data type description
application/json TransferDto Class that defines an internal transfer.

Example

Subscribe:

SUBSCRIBE
id:sub-0
destination:/user/v1/transfers
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Unsubscribe:

UNSUBSCRIBE
id:sub-0

Message:

MESSAGE
status:200
destination:/user/v1/transfers
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "account_id" : "...",
  "currency_id" : "...",
  "id" : "...",
  "type" : "request_receive",
  "amount" : "123.4",
  "counterparty_id" : "...",
  "status" : "cancelled",
  "reason" : "...",
  "creation_time" : 12345,
  "modification_time" : 12345
}


Home/Resources/UserController


/app/v1/user/settings/get

Request for user settings.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Response Body

media type data type description
application/json UserSettingsDto Class that defines user settings returned by the API.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/user/settings/get
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "is_using_2fa_for_login" : false,
  "is_using_2fa_for_withdrawal" : false,
  "is_allow_show_exchange_codes" : false,
  "client_user_id" : "...",
  "username" : "...",
  "measurement_currencies" : [ "...", "..." ],
  "trading_statistics_currency" : "...",
  "login_2fa_enabled" : false,
  "login_2fa_mandatory" : false,
  "withdrawal_2fa_enabled" : false,
  "withdrawal_2fa_mandatory" : false,
  "basic_advanced_switcher_enabled" : true,
  "password_for_user_settings_change_required" : true,
  "password_for_api_key_change_required" : true,
  "withdrawal_address_validation_required" : false,
  "user_identifier" : "user_id"
}


/app/v1/user/settings/modify

Modifies user settings.


Request Parameters

name type description constraints
correlation-id header Request identifier. required
destination header Destination path. required
X-Deltix-Nonce header A number that must increase between requests within one session. Recommended value is timestamp in milliseconds. required
X-Deltix-User header A unique identifier of the linked user on behalf of which the request is being sent. Optional. If missing or equal to the identifier of the logged-in user, the request is sent on behalf of the logged-in user itself.

Request Body

media type data type description
application/json EditUserSettingsDto Represents request for changing user settings.

Response Body

media type data type description
application/json UserSettingsDto Class that defines user settings returned by the API.

Example

Request:

SEND
correlation-id:anjmeuxm55
destination:/app/v1/user/settings/modify
X-Deltix-Nonce:12345
X-Deltix-User:12345678-9010-1112-1314-151617181920

{
  "is_using_2fa_for_login" : false,
  "is_using_2fa_for_withdrawal" : false,
  "is_allow_show_exchange_codes" : true,
  "token" : "..."
}

Response:

MESSAGE
status:200
correlation-id:anjmeuxm55
destination:/user/v1/responses
content-type:application/json;charset=UTF-8
subscription:sub-0
message-id:4e91-586562
content-length:4916

{
  "is_using_2fa_for_login" : true,
  "is_using_2fa_for_withdrawal" : true,
  "is_allow_show_exchange_codes" : true,
  "client_user_id" : "...",
  "username" : "...",
  "measurement_currencies" : [ "...", "..." ],
  "trading_statistics_currency" : "...",
  "login_2fa_enabled" : true,
  "login_2fa_mandatory" : true,
  "withdrawal_2fa_enabled" : true,
  "withdrawal_2fa_mandatory" : false,
  "basic_advanced_switcher_enabled" : false,
  "password_for_user_settings_change_required" : false,
  "password_for_api_key_change_required" : true,
  "withdrawal_address_validation_required" : false,
  "user_identifier" : "username"
}


Home/Data Types Details


Home/Data Types/AccountDto

Class that defines a user account.


Properties

name data type description
measurement_currency_id string Currency in which all the statistics are recalculated. Optional. If missing - all statistics are nominated in account currency.
balance decimal Account balance. This is a string containing a decimal floating-point value.
available_for_trading decimal Free balance, available for trading. This is a string containing a decimal floating-point value.
available_for_withdrawal decimal Free balance, available for withdrawal. This is a string containing a decimal floating-point value.
enter_average_price decimal Average price of entering the position. Optional.
current_price decimal Current price used for converting statistics from account currency to measurement currency. Optional.
unrealized_pnl decimal Current unrealized profit and loss in measurement currency. Optional.
realized_pnl decimal Accumulative realized profit and loss in measurement currency. This contains a sum of all realized PnLs calculated from the beginning. Optional.
total_statistics array of TotalStatisticsDto List of total statistics per transaction type.
properties array of PropertyDto Account position type-specific fields. Optional. List of supported properties is implementation-specific.

Properties inherited from AccountBaseDto

name data type description
id string Implementation-specific user account identifier.
currency_id string Account currency.
status AccountStatus Account status.
name string Account name.
deposit_wallet_address string Wallet address for deposits, if specified. Optional. This is deprecated. Use DepositWalletAddresses instead.
withdrawal_wallet_addresses array of WalletAddressDto List of saved wallet addresses for withdrawals. Can be empty.
deposit_wallet_addresses array of WalletAddressDto List of saved wallet addresses for deposits. Can be empty.

Example

{
  "id" : "...",
  "currency_id" : "...",
  "status" : "active",
  "name" : "...",
  "withdrawal_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "succeeded",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "in_progress",
    "reason" : "..."
  } ],
  "deposit_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "failed",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "approved",
    "reason" : "..."
  } ],
  "measurement_currency_id" : "...",
  "balance" : "123.4",
  "available_for_trading" : "123.4",
  "available_for_withdrawal" : "123.4",
  "enter_average_price" : "123.4",
  "current_price" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "total_statistics" : [ {
    "type" : "transfer_receive",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  }, {
    "type" : "rollover_commission",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  } ],
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
}


Home/Data Types/AccountBalanceDto

Class that defines a user account balance.


Properties

name data type description
account_id string Implementation-specific user account identifier.
currency_id string Account currency.
measurement_currency_id string Currency in which all the statistics are recalculated. Optional. If missing - all statistics are nominated in account currency.
balance decimal Account’s balance.
available_for_trading decimal Free balance, available for trading.
available_for_withdrawal decimal Free balance, available for withdrawal.
enter_average_price decimal Average price of entering the position. Optional.
current_price decimal Current price used for converting statistics from account currency to measurement currency. Optional.
unrealized_pnl decimal Current unrealized profit and loss in measurement currency. Optional.
realized_pnl decimal Accumulative realized profit and loss in measurement currency. This contains a sum of all realized PnLs calculated from the beginning. Optional.
total_statistics array of TotalStatisticsDto List of total statistics per transaction type.
properties array of PropertyDto Account position type-specific fields. Optional. List of supported properties in implementation-specific.

Example

{
  "account_id" : "...",
  "currency_id" : "...",
  "measurement_currency_id" : "...",
  "balance" : "123.4",
  "available_for_trading" : "123.4",
  "available_for_withdrawal" : "123.4",
  "enter_average_price" : "123.4",
  "current_price" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "total_statistics" : [ {
    "type" : "execution",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  }, {
    "type" : "balance_correction",
    "total" : "123.4",
    "total_this_day" : "123.4",
    "total_this_week" : "123.4",
    "total_this_month" : "123.4",
    "total_this_year" : "123.4"
  } ],
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
}


Home/Data Types/AccountBaseDto

Class that defines user account core fields.

Subtypes:


Properties

name data type description
id string Implementation-specific user account identifier.
currency_id string Account currency.
status AccountStatus Account status.
name string Account name.
deposit_wallet_address string Wallet address for deposits, if specified. Optional. This is deprecated. Use DepositWalletAddresses instead.
withdrawal_wallet_addresses array of WalletAddressDto List of saved wallet addresses for withdrawals. Can be empty.
deposit_wallet_addresses array of WalletAddressDto List of saved wallet addresses for deposits. Can be empty.

Example

{
  "id" : "...",
  "currency_id" : "...",
  "status" : "active",
  "name" : "...",
  "withdrawal_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "succeeded",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "approved",
    "reason" : "..."
  } ],
  "deposit_wallet_addresses" : [ {
    "address" : "...",
    "network" : "...",
    "status" : "pending",
    "reason" : "..."
  }, {
    "address" : "...",
    "network" : "...",
    "status" : "cancelled",
    "reason" : "..."
  } ]
}


Home/Data Types/AccountStatus

Status of the account.


Values

value description
active Account is active.
suspended Account is suspended.


Home/Data Types/ActiveCommissionPlansDto

Class that contains current user’s commission plan for the security with the possible next plans.


Properties

name data type description
security_id string Implementation-specific security identifier.
current CommissionPlanDto Current user’s commission plan for the security.
next CommissionPlanDto Next user’s commission plan for the security, if nothing happens. Can be missing.
next_by_volume CommissionPlanDto Next possible user’s commission plan for the security, if the user increases the total trade volume. Can be missing.
next_by_balance CommissionPlanDto Next possible user’s commission plan for the security, if the user increases the total balance. Can be missing.
next_by_invited_users_count CommissionPlanDto Next possible user’s commission plan for the security, if the user increases the total number of invited users. Can be missing.

Example

{
  "security_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
}


Home/Data Types/ActiveCurrencyCommissionPlansDto

Class that contains current user’s commission plan for the currency with the possible next plans.


Properties

name data type description
currency_id string Implementation-specific currency identifier.
current CurrencyCommissionPlanDto Current user’s commission plan for the currency.
next CurrencyCommissionPlanDto Next user’s commission plan for the currency, if nothing happens. Can be missing.
next_by_volume CurrencyCommissionPlanDto Next possible user’s commission plan for the currency, if the user increases the total trade volume. Can be missing.
next_by_balance CurrencyCommissionPlanDto Next possible user’s commission plan for the currency, if the user increases the total balance. Can be missing.
next_by_invited_users_count CurrencyCommissionPlanDto Next possible user’s commission plan for the currency, if the user increases the total number of invited users. Can be missing.

Example

{
  "currency_id" : "...",
  "current" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_volume" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_balance" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  },
  "next_by_invited_users_count" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4"
  }
}


Home/Data Types/AuthSettingsDto

Class that defines authentication settings.


Properties

name data type description
provider string Auth provider’s key name.
discovery_url string OAuth2 discovery URL.
client_id string OAuth2 ClientID.
audience string Audience request parameter if needed by the auth provider.
scopes string Space-separated list of scopes needed for the token request.

Example

{
  "provider" : "...",
  "discovery_url" : "...",
  "client_id" : "...",
  "audience" : "...",
  "scopes" : "..."
}


Home/Data Types/BarDto

Describes price movements for a set period of time.


Properties

name data type description
timestamp number Bar timestamp - closing time of the interval. This is a number containing time in milliseconds since January 1, 1970 UTC.
open_ask decimal Opening ask price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
high_ask decimal Maximum ask price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
low_ask decimal Minimum ask price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
close_ask decimal Closing ask price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
open_bid decimal Opening bid price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
high_bid decimal Maximum bid price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
low_bid decimal Minimum bid price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
close_bid decimal Closing bid price. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
volume decimal Trading volume for the time period described by this bar. Can be absent if no bars with the requested parameters found for the requested time interval. This is a string containing a decimal floating-point value.
exchange_id string Unique identifier of the exchange this bar is from. This field is absent for the aggregated bars.

Example

{
  "timestamp" : 12345,
  "open_ask" : "123.4",
  "high_ask" : "123.4",
  "low_ask" : "123.4",
  "close_ask" : "123.4",
  "open_bid" : "123.4",
  "high_bid" : "123.4",
  "low_bid" : "123.4",
  "close_bid" : "123.4",
  "volume" : "123.4",
  "exchange_id" : "..."
}


Home/Data Types/BarResponseDto

Describes an aggregated bar with a list of bars per exchange.


Properties

name data type description
timestamp number Time of all bars. This is a number containing time in milliseconds since January 1, 1970 UTC.
aggregated_bar BarDto Aggregated bar. Can be absent if no exchanges for aggregation were provided in the request.
exchange_bars array of BarDto List of bars for separate exchanges. Can be empty if no exchanges for separate results were provided in the request.

Example

{
  "timestamp" : 12345,
  "aggregated_bar" : {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  },
  "exchange_bars" : [ {
    "timestamp" : 12345,
    "open_ask" : "123.4",
    "high_ask" : "123.4",
    "low_ask" : "123.4",
    "close_ask" : "123.4",
    "open_bid" : "123.4",
    "high_bid" : "123.4",
    "low_bid" : "123.4",
    "close_bid" : "123.4",
    "volume" : "123.4",
    "exchange_id" : "..."
  } ]
}


Home/Data Types/ChangeAccountPropertiesDto

Defines a request for changing account properties.


Properties

name data type description
account_id string Implementation-specific user account identifier.
property_changes array of ChangePropertyDto List of changes that should be done to the account properties in this exact order. Can only change properties with keys defined in CurrencyDto.allowed_account_properties.

Example

{
  "account_id" : "...",
  "property_changes" : [ {
    "type" : "insert",
    "index" : 12345,
    "key" : "...",
    "value" : "..."
  }, {
    "type" : "update",
    "index" : 12345,
    "key" : "...",
    "value" : "..."
  } ]
}


Home/Data Types/ChangePropertyDto

Defines a change property request.


Properties

name data type description
type ChangePropertyType Request type.
index number Zero-based index of the attribute inside attribute list.
key string Property key. For in insert request this will define a new property key. For update and delete requests it must be the same as the original property key. Can only change keys allowed for the user.
value string Property value. For insert and update requests this defines a new property value. For delete request this field is not used.

Example

{
  "type" : "delete",
  "index" : 12345,
  "key" : "...",
  "value" : "..."
}


Home/Data Types/ChangePropertyType

Type of change property request.


Values

value description
insert Insert a new property.
update Update an existing property.
delete Delete an existing property.


Home/Data Types/ChargeFlatCommissionTime

Time of flat commission charging.


Values

value description
acknowledgment Flat Commission will charge after order acknowledgment.
first_fill Flat Commission will charge after the first order filling.


Home/Data Types/CommissionPlanDto

Class that defines a commission plan.


Properties

name data type description
average_balance decimal Minimum average user balance for this commission plan.
total_volume decimal Minimum total trade volume for this commission plan.
invited_users_count number Minimum total number of invited users, that have reached the target, for this commission plan.
buyer_taker_commission_flat decimal Fixed value to be taken as buyer taker trading commission for this commission plan. Zero means no commission.
buyer_taker_commission_progressive decimal Percent of order quantity to be taken as buyer taker trading commission for this commission plan. Zero means no commission.
seller_taker_commission_flat decimal Fixed value to be taken as seller taker trading commission for this commission plan. Zero means no commission.
seller_taker_commission_progressive decimal Percent of order quantity to be taken as seller taker trading commission for this commission plan. Zero means no commission.
buyer_maker_commission_flat decimal Fixed value to be taken as buyer maker trading commission for this commission plan. Zero means no commission.
buyer_maker_commission_progressive decimal Percent of order quantity to be taken as buyer maker trading commission for this commission plan. Zero means no commission.
seller_maker_commission_flat decimal Percent of order quantity to be taken as seller maker trading commission for this commission plan. Zero means no commission.
seller_maker_commission_progressive decimal Percent of order quantity to be taken as seller maker trading commission for this commission plan. Zero means no commission.

Example

{
  "average_balance" : "123.4",
  "total_volume" : "123.4",
  "invited_users_count" : 12345,
  "buyer_taker_commission_flat" : "123.4",
  "buyer_taker_commission_progressive" : "123.4",
  "seller_taker_commission_flat" : "123.4",
  "seller_taker_commission_progressive" : "123.4",
  "buyer_maker_commission_flat" : "123.4",
  "buyer_maker_commission_progressive" : "123.4",
  "seller_maker_commission_flat" : "123.4",
  "seller_maker_commission_progressive" : "123.4"
}


Home/Data Types/CurrencyDto

Class that defines a currency.


Properties

name data type description
id string Currency code as defined by ISO 4217.
name string Human-readable name of this currency.
type string Type of this currency.
precision number This currency precision. This defines the maximum number of decimal places for the quantities in this currency.
icon binary Currency icon, if exists.
icon_type string Currency icon content type, if icon exists.
sign string Currency sign (symbol). Optional.
daily_deposit_threshold decimal The amount of currency the user can deposit within a single day without manual confirmation from an operator. This is a string containing a decimal floating-point value.
daily_withdrawal_threshold decimal The amount of currency the user can withdraw within a single day without manual confirmation from an operator. This is a string containing a decimal floating-point value.
weekly_deposit_threshold decimal The amount of currency the user can deposit within a single week without manual confirmation from an operator. This is a string containing a decimal floating-point value.
weekly_withdrawal_threshold decimal the amount of currency the user can withdraw within a single week without manual confirmation from an operator. This is a string containing a decimal floating-point value.
monthly_deposit_threshold decimal The amount of currency the user can deposit within a single month without manual confirmation from an operator. This is a string containing a decimal floating-point value.
monthly_withdrawal_threshold decimal The amount of currency the user can withdraw within a single month without manual confirmation from an operator. This is a string containing a decimal floating-point value.
yearly_deposit_threshold decimal The amount of currency the user can deposit within a single year without manual confirmation from an operator. This is a string containing a decimal floating-point value.
yearly_withdrawal_threshold decimal The amount of currency the user can withdraw within a single year without manual confirmation from an operator. This is a string containing a decimal floating-point value.
daily_deposit_limit decimal The amount of currency the user can deposit within a single day. This is a string containing a decimal floating-point value.
daily_withdrawal_limit decimal The amount of currency the user can withdraw within a single day. This is a string containing a decimal floating-point value.
weekly_deposit_limit decimal The amount of currency the user can deposit within a single week. This is a string containing a decimal floating-point value.
weekly_withdrawal_limit decimal The amount of currency the user can withdraw within a single week. This is a string containing a decimal floating-point value.
monthly_deposit_limit decimal The amount of currency the user can deposit within a single month. This is a string containing a decimal floating-point value.
monthly_withdrawal_limit decimal The amount of currency the user can withdraw within a single month. This is a string containing a decimal floating-point value.
yearly_deposit_limit decimal The amount of currency the user can deposit within a single year. This is a string containing a decimal floating-point value.
yearly_withdrawal_limit decimal The amount of currency the user can withdraw within a single year. This is a string containing a decimal floating-point value.
limits_currency string Id of the currency in which limits are calculated.
withdrawal_commission_progressive decimal A percent of withdrawal to be taken as a commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
withdrawal_commission_flat decimal A fixed value to be taken as a commission. Zero means no flat commission. This is a string containing a decimal floating-point value.
deposit_commission_progressive decimal A percent of deposit to be taken as a commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
deposit_commission_flat decimal A fixed value to be taken as a commission. Zero means no flat commission. This is a string containing a decimal floating-point value.
available_for_withdrawal decimal The amount of currency available for withdrawal right now. This is a string containing a decimal floating-point value. This is deprecated. Will contain invalid value if limits currency differs from account currency. Use CurrencyLimitsDto.
available_for_deposit decimal The amount of currency available for deposit right now. This is a string containing a decimal floating-point value. This is deprecated. Will contain invalid value if limits currency differs from account currency. Use CurrencyLimitsDto.
minimal_withdrawal decimal Minimal withdrawal amount.
withdrawals_allowed bool Flag that defines if withdrawals are allowed for the account.
deposits_allowed bool Flag that defines if deposits are allowed for the account.
allowed_account_properties array of string Defines a list of keys for which the user is allowed to create, update and delete account properties of the accounts in the specified currency.
available_networks array of string List of networks available for external transactions. Can be empty. If non-empty, only networks from this list are allowed for deposit/withdrawal operations and one must be provided in the corresponding API.
use_abbreviations bool Indicates whether to show abbreviated quantity and amount or not.
custom_data string Custom data.
custom_data2 string Second field containing custom data.

Example

{
  "id" : "...",
  "name" : "...",
  "type" : "...",
  "precision" : 12345,
  "icon" : "...",
  "icon_type" : "...",
  "sign" : "...",
  "daily_deposit_threshold" : "123.4",
  "daily_withdrawal_threshold" : "123.4",
  "weekly_deposit_threshold" : "123.4",
  "weekly_withdrawal_threshold" : "123.4",
  "monthly_deposit_threshold" : "123.4",
  "monthly_withdrawal_threshold" : "123.4",
  "yearly_deposit_threshold" : "123.4",
  "yearly_withdrawal_threshold" : "123.4",
  "daily_deposit_limit" : "123.4",
  "daily_withdrawal_limit" : "123.4",
  "weekly_deposit_limit" : "123.4",
  "weekly_withdrawal_limit" : "123.4",
  "monthly_deposit_limit" : "123.4",
  "monthly_withdrawal_limit" : "123.4",
  "yearly_deposit_limit" : "123.4",
  "yearly_withdrawal_limit" : "123.4",
  "limits_currency" : "...",
  "withdrawal_commission_progressive" : "123.4",
  "withdrawal_commission_flat" : "123.4",
  "deposit_commission_progressive" : "123.4",
  "deposit_commission_flat" : "123.4",
  "minimal_withdrawal" : "123.4",
  "withdrawals_allowed" : true,
  "deposits_allowed" : false,
  "allowed_account_properties" : [ "...", "..." ],
  "available_networks" : [ "...", "..." ],
  "use_abbreviations" : true,
  "custom_data" : "...",
  "custom_data2" : "..."
}


Home/Data Types/CurrencyActionDto

Class that defines an action to a specific currency.


Properties

name data type description
id string Implementation-specific currency identifier.
action EntityAction Action to do with a currency.
currency CurrencyDto A currency that is being added or changed. This field is missing, if the currency should be removed.

Example

{
  "id" : "...",
  "action" : "delete",
  "currency" : {
    "id" : "...",
    "name" : "...",
    "type" : "...",
    "precision" : 12345,
    "icon" : "...",
    "icon_type" : "...",
    "sign" : "...",
    "daily_deposit_threshold" : "123.4",
    "daily_withdrawal_threshold" : "123.4",
    "weekly_deposit_threshold" : "123.4",
    "weekly_withdrawal_threshold" : "123.4",
    "monthly_deposit_threshold" : "123.4",
    "monthly_withdrawal_threshold" : "123.4",
    "yearly_deposit_threshold" : "123.4",
    "yearly_withdrawal_threshold" : "123.4",
    "daily_deposit_limit" : "123.4",
    "daily_withdrawal_limit" : "123.4",
    "weekly_deposit_limit" : "123.4",
    "weekly_withdrawal_limit" : "123.4",
    "monthly_deposit_limit" : "123.4",
    "monthly_withdrawal_limit" : "123.4",
    "yearly_deposit_limit" : "123.4",
    "yearly_withdrawal_limit" : "123.4",
    "limits_currency" : "...",
    "withdrawal_commission_progressive" : "123.4",
    "withdrawal_commission_flat" : "123.4",
    "deposit_commission_progressive" : "123.4",
    "deposit_commission_flat" : "123.4",
    "minimal_withdrawal" : "123.4",
    "withdrawals_allowed" : false,
    "deposits_allowed" : true,
    "allowed_account_properties" : [ "...", "..." ],
    "available_networks" : [ "...", "..." ],
    "use_abbreviations" : false,
    "custom_data" : "...",
    "custom_data2" : "..."
  }
}


Home/Data Types/CurrencyCommissionPlanDto

Class that defines a commission plan for deposits and withdrawals.


Properties

name data type description
average_balance decimal Minimum average user balance for this commission plan.
total_volume decimal Minimum total trade volume for this commission plan.
invited_users_count number Minimum total number of invited users, that have reached the target, for this commission plan.
withdrawal_commission_progressive decimal A percent of withdrawal to be taken as a commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
withdrawal_commission_flat decimal A fixed value to be taken as a commission. Zero means no flat commission. This is a string containing a decimal floating-point value.
deposit_commission_progressive decimal A percent of deposit to be taken as a commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
deposit_commission_flat decimal A fixed value to be taken as a commission. Zero means no flat commission. This is a string containing a decimal floating-point value.

Example

{
  "average_balance" : "123.4",
  "total_volume" : "123.4",
  "invited_users_count" : 12345,
  "withdrawal_commission_progressive" : "123.4",
  "withdrawal_commission_flat" : "123.4",
  "deposit_commission_progressive" : "123.4",
  "deposit_commission_flat" : "123.4"
}


Home/Data Types/CurrencyLimitsDto

Class that contains account’s withdrawal and deposit limits for the currency taking into account transactions already performed by the user.


Properties

name data type description
id string Currency code as defined by ISO 4217.
withdrawal_limit decimal The amount of currency available for withdrawal by the limits in the limits currency. In order to receive the amount available for withdrawal, this number must be compared to the account balance converted to the corresponding currency. This is a string containing a decimal floating-point value.
deposit_limit decimal The amount of currency available for deposit right now. This is a string containing a decimal floating-point value.

Example

{
  "id" : "...",
  "withdrawal_limit" : "123.4",
  "deposit_limit" : "123.4"
}


Home/Data Types/CurrentTradingStatisticsDto

Class that defines trading statistics for current period for specified user.


Properties

name data type description
current_volume decimal User volume for current period.
current_average_balance decimal Average balance for current period.
current_invited_users_count number Number of user invites for current period.
current_trading_commission decimal User trading commission amount for current period.
statistics_time number

Example

{
  "current_volume" : "123.4",
  "current_average_balance" : "123.4",
  "current_invited_users_count" : 12345,
  "current_trading_commission" : "123.4",
  "statistics_time" : 12345
}


Home/Data Types/CustomServiceDto

Class that defines a custom service.


Properties

name data type description
name string Custom service name.
source_id number SourceId of the custom service.

Example

{
  "name" : "...",
  "source_id" : 12345
}


Home/Data Types/DealDto

Represents a user’s deal (position).


Properties

name data type description
id string Implementation-specific deal identifier.
security_id string Implementation-specific security identifier.
side DealSide Deal’s side.
quantity decimal Deal’s quantity. This is a string containing a decimal floating-point value.
open_quantity_in_abc decimal Deal’s quantity converted to the account base currency. Can be missing. This is a string containing a decimal floating-point value.
open_quantity_in_urc decimal Deal’s quantity converted to the user report currency. Can be missing This is a string containing a decimal floating-point value.
good_till_date number Expiration timestamp for the deal in question. Can be missing. This is a number containing time in milliseconds since January 1, 1970 UTC.
sequence_number number Deals’ sequence number. Can be missing.
open_order_id string Implementation-specific identifier of the order that opened this deal.
open_price decimal Deal’s average opening price. This is a string containing a decimal floating-point value.
open_time number Time when this deal was opened. This is a number containing time in milliseconds since January 1, 1970 UTC.
open_reason string Textual reason for opening this deal. Can be missing.
rollover_commission decimal Rollover commission applied to the deal in question. Can be missing. This is a string containing a decimal floating-point value.
trading_commission decimal Trading commission applied to the deal in question. Can be missing. This is a string containing a decimal floating-point value.
unrealized_pnl decimal Unrealized PnL generated by the deal in question. Can be missing. This is a string containing a decimal floating-point value.
realized_pnl decimal Realized PnL generated by the deal in question. Can be missing. This is a string containing a decimal floating-point value.
margin_used decimal Margin used by the deal in question. Can be missing. This is a string containing a decimal floating-point value.
leverage decimal Leverage of the deal in question. Can be missing. This is a string containing a decimal floating-point value.
liquidation_price decimal Liquidation price of the deal in question. Can be missing. This is a string containing a decimal floating-point value.
take_profit_price decimal Take profit price of the deal in question. Can be missing. This is a string containing a decimal floating-point value.

Example

{
  "id" : "...",
  "security_id" : "...",
  "side" : "short",
  "quantity" : "123.4",
  "open_quantity_in_abc" : "123.4",
  "open_quantity_in_urc" : "123.4",
  "good_till_date" : 12345,
  "sequence_number" : 12345,
  "open_order_id" : "...",
  "open_price" : "123.4",
  "open_time" : 12345,
  "open_reason" : "...",
  "rollover_commission" : "123.4",
  "trading_commission" : "123.4",
  "unrealized_pnl" : "123.4",
  "realized_pnl" : "123.4",
  "margin_used" : "123.4",
  "leverage" : "123.4",
  "liquidation_price" : "123.4",
  "take_profit_price" : "123.4"
}


Home/Data Types/DealSide

Side of the deal.


Values

value description
long Long position. Position was opened by buy order.
short Short position. Position was opened by sell order.


Home/Data Types/DescriptionTextDto

Represents a description text.


Properties

name data type description
text string Custom text.

Example

{
  "text" : "..."
}


Home/Data Types/EditUserSettingsDto

Represents request for changing user settings.


Properties

name data type description
token string Special token if password/MFA for changing settings is enabled.

Properties inherited from EditableUserSettingsDto

name data type description
is_using_2fa_for_login bool Whether user is using two factor authentication for login. This may be missing depending on auth provider.
is_using_2fa_for_withdrawal bool Whether user is using two factor authentication for withdrawals.
is_allow_show_exchange_codes bool Allow showing Exchange codes.

Example

{
  "is_using_2fa_for_login" : false,
  "is_using_2fa_for_withdrawal" : true,
  "is_allow_show_exchange_codes" : false,
  "token" : "..."
}


Home/Data Types/EditableUserSettingsDto

Class that defines user settings that can be changed by the user.

Subtypes:


Properties

name data type description
is_using_2fa_for_login bool Whether user is using two factor authentication for login. This may be missing depending on auth provider.
is_using_2fa_for_withdrawal bool Whether user is using two factor authentication for withdrawals.
is_allow_show_exchange_codes bool Allow showing Exchange codes.

Example

{
  "is_using_2fa_for_login" : false,
  "is_using_2fa_for_withdrawal" : false,
  "is_allow_show_exchange_codes" : false
}


Home/Data Types/EntityAction

Arbitrary object action


Values

value description
insert Insert an object.
update Update an object.
delete Remove an object.


Home/Data Types/ExecutionExplanation

Type of execution explanation.


Values

value description
none Frontend should not explain execution.
price Frontend should be able to show execution price as sum of original price with external commission.
commission Frontend should be able to show trade commission as sum of external commission and our trade commission.


Home/Data Types/ExternalCommissionDto

Class that defines an external commission taken by the specified exchange.


Properties

name data type description
exchange_id string Vendor ID. Can be absent.
commission_currency string Commission currency for this instrument and Liquidity Provider in vendor notation.
maker_commission decimal Vendor maker commission in commission currency. This is a string containing a decimal floating-point value.
taker_commission decimal Vendor taker commission in commission currency. This is a string containing a decimal floating-point value.

Example

{
  "exchange_id" : "...",
  "commission_currency" : "...",
  "maker_commission" : "123.4",
  "taker_commission" : "123.4"
}


Home/Data Types/FeeDto

Approximate order fee. Note: fee depends on the book state at the calculation time so actual value may differ from the calculated one.


Properties

name data type description
fee decimal Order fee value.
cost decimal Total cost.
average_price decimal Average price.
comment string Arbitrary comment indicating something bad has happened.

Example

{
  "fee" : "123.4",
  "cost" : "123.4",
  "average_price" : "123.4",
  "comment" : "..."
}


Home/Data Types/FilterInfoDto


Properties

name data type description
name string Filter’s name.
values array of string List of possible filter values.

Example

{
  "name" : "...",
  "values" : [ "...", "..." ]
}


Home/Data Types/GlobalSettingsDto

Class that defines global application settings.


Properties

name data type description
auth_settings AuthSettingsDto Authentication settings, if external auth provider is used.
keepalive_timeout number Keep-alive timeout, ms.
login_2fa_enabled bool Is 2FA for user login enabled. This is deprecated. Use UserSettingsDto instead.
login_2fa_mandatory bool Is 2FA for user login mandatory. Can only be true if login 2FA is enabled. This is deprecated. Use UserSettingsDto instead.
withdrawal_2fa_enabled bool Is 2FA for user withdrawal transfers enabled. This is deprecated. Use UserSettingsDto instead.
withdrawal_2fa_mandatory bool Is 2FA for user withdrawal transfers mandatory. Can only be true if withdrawal 2FA is enabled. This is deprecated. Use UserSettingsDto instead.
basic_advanced_switcher_enabled bool Is switcher between basic and advanced view enabled. This is deprecated. Use UserSettingsDto instead.
password_for_user_settings_change_required bool Is password confirmation required for changing user settings. This is deprecated. Use UserSettingsDto instead.
password_for_api_key_change_required bool Is explicit password confirmation required for creating/deleting API keys. If set to false - password should be verified on auth provider side. This is deprecated. Use UserSettingsDto instead.
withdrawal_address_validation_required bool Is withdrawal forbidden for non-validated address. This is deprecated. Use UserSettingsDto instead.
user_identifier UserIdentifier Specifies a field used for identifying users when user transfers are enabled. Optional. When missing, user transfers are disabled. This is deprecated. Use UserSettingsDto instead.

Example

{
  "auth_settings" : {
    "provider" : "...",
    "discovery_url" : "...",
    "client_id" : "...",
    "audience" : "...",
    "scopes" : "..."
  },
  "keepalive_timeout" : 12345
}


Home/Data Types/HealthStatusDto

Class that defines a health status of the application.


Properties

name data type description
timestamp number Server time when this status has been received.
application string Name of the application.
version string Application version.
is_alive bool Overall status of the application including connection status to it’s remote services.
users number Number of users logged in. Only present for the service that contains a user cache.
logins number Number of active login sessions. Can differ from the users count because each API key session is considered a different login session. Only present for the service that contains a user cache.

Example

{
  "timestamp" : 12345,
  "application" : "...",
  "version" : "...",
  "is_alive" : true,
  "users" : 12345,
  "logins" : 12345
}


Home/Data Types/HistoricalBarsRequestDto

Represents request for getting historical bars.


Properties

name data type description
security_id string Bar instrument.
periodicity Periodicity Bar periodicity.
start_time number Start of time range.
end_time number End of time range.
aggregated_exchanges array of string List of exchanges to be aggregated.
separate_exchanges array of string List of exchanges that will be returned separatelly.

Example

{
  "security_id" : "...",
  "periodicity" : "hour",
  "start_time" : 12345,
  "end_time" : 12345,
  "aggregated_exchanges" : [ "...", "..." ],
  "separate_exchanges" : [ "...", "..." ]
}


Home/Data Types/HistoricalChartRequestDto

Represents request for getting historical chart data.


Properties

name data type description
line_id string Unique line identifier.
scale number Scale factor. Time duration that will be represented as one chart dot.
filters array of string List of filter values.
from number Historical interval start time.
count number Maximum number of historical chart dots.

Example

{
  "line_id" : "...",
  "scale" : 12345,
  "filters" : [ "...", "..." ],
  "from" : 12345,
  "count" : 12345
}


Home/Data Types/HistoricalRequestDto

Represents a request for the history of entries.

Subtypes:


Properties

name data type description
start_time number Start of time range. Set to 0 to get entries from the beginning (or current time for reversed order).
reversed bool Should the result entries be older than the time specified. If missing - treated as false.
count number Max number of entries expected to receive. Effective max number can be lower than this, depending on backend configuration. If missing or negative - treated as unlimited.

Example

{
  "start_time" : 12345,
  "reversed" : false,
  "count" : 12345
}


Home/Data Types/HistoricalTransactionRequestDto

Represents a request for the history of transactions.


Properties

name data type description
transaction_types array of TransactionType Transaction types filter. If missing or empty - all types will be returned.

Properties inherited from HistoricalRequestDto

name data type description
start_time number Start of time range. Set to 0 to get entries from the beginning (or current time for reversed order).
reversed bool Should the result entries be older than the time specified. If missing - treated as false.
count number Max number of entries expected to receive. Effective max number can be lower than this, depending on backend configuration. If missing or negative - treated as unlimited.

Example

{
  "start_time" : 12345,
  "reversed" : false,
  "count" : 12345,
  "transaction_types" : [ "deposit_commission", "debit" ]
}


Home/Data Types/L2Action

L2 action. This is the type of action that the receiver of market data should perform to the book.


Values

value description
update Change the specified level. This cannot change the level price.
insert Insert a new record to the specified level. All the levels below (with worse price) should be shifted one level down.
delete Remove the specified level. All the levels below (with worse price) should be shifted one level up.
delete_from Remove all levels from the specified and below (all the worst prices).
delete_through Remove all levels from the specified and above (all the better prices). All the levels should be shifted up.
trade This is an indicator of the occurred trade. No changes to the book are required.


Home/Data Types/L2EntryDto

Represents L2 entry.


Properties

name data type description
timestamp number Time of this entry. If missing, package time should be used. This is a number containing time in milliseconds since January 1, 1970 UTC.
price decimal Price of this entry. This is a string containing a decimal floating-point value.
quantity decimal Quantity of this entry. Only present for new, update and trade entries. This is a string containing a decimal floating-point value.
side Side Side of this entry.
action L2Action Action of this entry.
level number Level of this entry. This field is absent for trade entries.
number_of_orders number Number of active orders on this entry level for new and update entries. Number of orders participated in the trade for trade entries. Absent for other entry types.
exchange_id string Unique identifier of the exchange this entry is from. Absent if sending exchange id if forbidden for the user or disabled by the user.

Example

{
  "timestamp" : 12345,
  "price" : "123.4",
  "quantity" : "123.4",
  "side" : "sell",
  "action" : "trade",
  "level" : 12345,
  "number_of_orders" : 12345,
  "exchange_id" : "..."
}


Home/Data Types/L2PackageDto

Represents L2 package for the specified symbol.


Properties

name data type description
timestamp number Time of this update. This is a number containing time in milliseconds since January 1, 1970 UTC.
security_id string Implementation-specific security identifier of the security this snapshot is for.
type L2PackageType Type of this package.
entries array of L2EntryDto Entries of this package.
sequence_number number Serial number of this package.

Example

{
  "timestamp" : 12345,
  "security_id" : "...",
  "type" : "incremental_update",
  "entries" : [ {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "buy",
    "action" : "insert",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  }, {
    "timestamp" : 12345,
    "price" : "123.4",
    "quantity" : "123.4",
    "side" : "sell",
    "action" : "update",
    "level" : 12345,
    "number_of_orders" : 12345,
    "exchange_id" : "..."
  } ],
  "sequence_number" : 12345
}


Home/Data Types/L2PackageType

Type of the L2 package.


Values

value description
incremental_update Incremental change in the available snapshot.
snapshot_full_refresh Full refresh of the available snapshot.


Home/Data Types/LineDotDto

Class that defines a line dot.


Properties

name data type description
time number Dot time.
value decimal Dot value.

Example

{
  "time" : 12345,
  "value" : "123.4"
}


Home/Data Types/LineInfoDto

Class that defines meta-information about chart line.


Properties

name data type description
id string Line’s unique identifier.
name string Human-readable name.
min_time number Minimum available chart dot timestamp. May be lower than the actual user’s first dot. The only guarantee is that there is no data below this point.
filters array of FilterInfoDto List of filters. Filter values must be provided in the same order.

Example

{
  "id" : "...",
  "name" : "...",
  "min_time" : 12345,
  "filters" : [ {
    "name" : "...",
    "values" : [ "...", "..." ]
  }, {
    "name" : "...",
    "values" : [ "...", "..." ]
  } ]
}


Home/Data Types/LineSectionDto

Class that defines a line section.


Properties

name data type description
dots array of LineDotDto List of line dots.

Example

{
  "dots" : [ {
    "time" : 12345,
    "value" : "123.4"
  }, {
    "time" : 12345,
    "value" : "123.4"
  } ]
}


Home/Data Types/LinkedOrderSchemaDto

Represents a linked order schema.


Properties

name data type description
type string Order type name.
view string Order view schema. Contains a json schema for displaying on UI.
send string Order send schema. Contains a json schema with list of orders to send to the bakend in that particular order.

Example

{
  "type" : "...",
  "view" : "...",
  "send" : "..."
}


Home/Data Types/LinkedUserDto

Class that defines a user to which the user can switch.


Properties

name data type description
id string Implementation-specific user identifier.
username string User’s name. This is the name the user used during registration.
user_type string Implementation-specific user type. Can be used to explain a role of the particular linked user. Optional.
public_id string Public user identifier. Can be provided to other users for making internal operations, like tranfers. Optional. Can be missing, if all internal operations are disabled. Format is defined by the GlobalSettingsDto.user_identifier parameter.
is_main bool Is this the logged-in user, or a linked one.

Example

{
  "id" : "...",
  "username" : "...",
  "user_type" : "...",
  "public_id" : "...",
  "is_main" : true
}


Home/Data Types/LogDto

Represents request for collecting log message.


Properties

name data type description
logger string This is a mandatory field.
message string Message to be logged. This is a mandatory field.
level LogLevel Severity of the log message . This is a mandatory field.

Example

{
  "logger" : "...",
  "message" : "...",
  "level" : "info"
}


Home/Data Types/LogLevel

Log level.


Values

value description
trace Log level trace.
debug Log level debug.
info Log level info.
warn Log level warn.
error Log level error.
fatal Log level fatal.


Home/Data Types/NewOrderDto

Represents request for creating or modifying order.

Subtypes:


Properties

name data type description
client_order_id string Client-specific order identifier. Optional. If missing, will be generated by the server. Depending on the underlying model implementation, some constraints may be put on this field.
security_id string Implementation-specific security identifier. This is a mandatory field.
quote_id string Quote identifier for orders that should match a specific quote. Optional.
type string String representation of the order type. This is a mandatory field.
side Side Side of this order. This is a mandatory field.
quantity decimal Quantity of this order. This is a mandatory field. This is a string containing a decimal floating-point value.
time_in_force TimeInForce Time-in-force for this order. This is a mandatory field.
limit_price decimal Limit price of this order. May be missing or required, depending on the type of the order. This is a string containing a decimal floating-point value.
stop_price decimal Stop price of this order. May be missing or required, depending on the type of the order. This is a string containing a decimal floating-point value.
peg_difference decimal Peg Difference for Pegged order types. Amount (signed) added to the price of the peg for a pegged order. Optional.
min_quantity decimal Minimum quantity allowed for execution, in fixed-point representation. Optional attribute supported by some execution venues.
display_quantity decimal “MaxShow/DisplaySize” order quantity in fixed-point representation. Can be used for iceberg orders. Optional.
leverage decimal Leverage. This is optional. This is a string containing a decimal floating-point value.
expire_time number Expiration time of this order. May be missing or required, depending on the time in force of the order and underlying implementation. This is a number containing time in milliseconds since January 1, 1970 UTC.
submission_time number Time of new order submission by the client. Optional. This is a number containing time in milliseconds since January 1, 1970 UTC.
destination string Destination where to send order. Must be one of security’s available destinations. This is a mandatory field.
exchange_id string Exchange identifier. Required by some destinations. Optional.
source string Source from where the order was sent. Must be alphanumeric-encodable. Optional. If missing, default source will be used.
currency string Currency in which quantity is provided. Optional. If missing, symbol’s base currency will be used as a default. Depending on the underlying implementation, some constraints may be put on this field.
text string Arbitrary text associated with this order by the client. Optional.
properties array of PropertyDto Order type-specific fields. Optional. List of supported properties in implementation-specific.

Example

{
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "buy",
  "quantity" : "123.4",
  "time_in_force" : "gtc",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ]
}


Home/Data Types/OperationStatus

Specifies current status of any operation.


Values

value description
pending Request for operation sent.
approved Operation was approved.
rejected Operation was rejected. Final stage.
in_progress Operation is in progress.
succeeded Operation was successfully finished. Final stage.
failed Operation failed. Final stage.
cancelled Operation was cancelled by the user. Final stage.


Home/Data Types/OrderDto

Represents user’s order as returned by the API.


Properties

name data type description
id string Order identifier assigned by server.
correlation_id string Unique identifier of the order chain.
timestamp number Timestamp of the order event. This is used for filtering and sorting.
status OrderStatus Status of this order.
trader_name string Name of the user.
product_type ProductType Defines type of settlement for this order.
cumulative_quantity decimal Total executed quantity of this order. This is a string containing a decimal floating-point value.
remaining_quantity decimal Total quantity of this order remaining for execution. This is a string containing a decimal floating-point value.
average_price decimal Average execution price of this order. This is a string containing a decimal floating-point value.
receipt_time number Time when this order was received by the execution server. This is a number containing time in milliseconds since January 1, 1970 UTC.
close_time number Time when this order was closed by the execution server. This is a number containing time in milliseconds since January 1, 1970 UTC.
last_timestamp number Timestamp of the last meaning event.
last_trade_price decimal Price of last trade of this order. This is a string containing a decimal floating-point value.
counterparty_code string
settlement_date number
reason string Human-readable reason of closing the order if present. Can be missing.

Properties inherited from NewOrderDto

name data type description
client_order_id string Client-specific order identifier. Optional. If missing, will be generated by the server. Depending on the underlying model implementation, some constraints may be put on this field.
security_id string Implementation-specific security identifier. This is a mandatory field.
quote_id string Quote identifier for orders that should match a specific quote. Optional.
type string String representation of the order type. This is a mandatory field.
side Side Side of this order. This is a mandatory field.
quantity decimal Quantity of this order. This is a mandatory field. This is a string containing a decimal floating-point value.
time_in_force TimeInForce Time-in-force for this order. This is a mandatory field.
limit_price decimal Limit price of this order. May be missing or required, depending on the type of the order. This is a string containing a decimal floating-point value.
stop_price decimal Stop price of this order. May be missing or required, depending on the type of the order. This is a string containing a decimal floating-point value.
peg_difference decimal Peg Difference for Pegged order types. Amount (signed) added to the price of the peg for a pegged order. Optional.
min_quantity decimal Minimum quantity allowed for execution, in fixed-point representation. Optional attribute supported by some execution venues.
display_quantity decimal “MaxShow/DisplaySize” order quantity in fixed-point representation. Can be used for iceberg orders. Optional.
leverage decimal Leverage. This is optional. This is a string containing a decimal floating-point value.
expire_time number Expiration time of this order. May be missing or required, depending on the time in force of the order and underlying implementation. This is a number containing time in milliseconds since January 1, 1970 UTC.
submission_time number Time of new order submission by the client. Optional. This is a number containing time in milliseconds since January 1, 1970 UTC.
destination string Destination where to send order. Must be one of security’s available destinations. This is a mandatory field.
exchange_id string Exchange identifier. Required by some destinations. Optional.
source string Source from where the order was sent. Must be alphanumeric-encodable. Optional. If missing, default source will be used.
currency string Currency in which quantity is provided. Optional. If missing, symbol’s base currency will be used as a default. Depending on the underlying implementation, some constraints may be put on this field.
text string Arbitrary text associated with this order by the client. Optional.
properties array of PropertyDto Order type-specific fields. Optional. List of supported properties in implementation-specific.

Example

{
  "client_order_id" : "...",
  "security_id" : "...",
  "quote_id" : "...",
  "type" : "...",
  "side" : "buy",
  "quantity" : "123.4",
  "time_in_force" : "at_the_opening",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "peg_difference" : "123.4",
  "min_quantity" : "123.4",
  "display_quantity" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "submission_time" : 12345,
  "destination" : "...",
  "exchange_id" : "...",
  "source" : "...",
  "currency" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "id" : "...",
  "correlation_id" : "...",
  "timestamp" : 12345,
  "status" : "pending_cancel",
  "trader_name" : "...",
  "product_type" : "spot",
  "cumulative_quantity" : "123.4",
  "remaining_quantity" : "123.4",
  "average_price" : "123.4",
  "receipt_time" : 12345,
  "close_time" : 12345,
  "last_timestamp" : 12345,
  "last_trade_price" : "123.4",
  "counterparty_code" : "...",
  "settlement_date" : 12345,
  "reason" : "..."
}


Home/Data Types/OrderConfirmationTextRequestDto

Represents request for getting an order confirmation description text.


Properties

name data type description
security_id string Order symbol.
side string Order side.

Example

{
  "security_id" : "...",
  "side" : "..."
}


Home/Data Types/OrderEventDto

Represents events related to the order like order creation, changing, execution, cancellation etc.


Properties

name data type description
id string Human-readable event identifier assigned by server.
event_id string Unique event identifier assigned by server.
type OrderEventType Type of the event.
sequence_number number Sequential number of the event. Guaranteed to be increasing for the next event of the same order. No other guarantees are given.
timestamp number Event time. This is a number containing time in milliseconds since January 1, 1970 UTC.
reason string Human-readable event reason if present. Can be missing.
client_order_id string Client-specific order identifier. Can be missing.
security_id string Implementation-specific security identifier.
order_type string String representation of the order type.
order_side Side Side of the order.
quantity decimal Total quantity of the order. This is a string containing a decimal floating-point value.
time_in_force TimeInForce Time-in-force for the order. Can be missing.
limit_price decimal Limit price of the order. Can be absent depending on the type of the order. This is a string containing a decimal floating-point value.
stop_price decimal Stop price of the order. Can be absent depending on the type of the order. This is a string containing a decimal floating-point value.
average_price decimal Average execution price of the order. This is a string containing a decimal floating-point value.
leverage decimal Leverage. Can be absent. This is a string containing a decimal floating-point value.
expire_time number Expiration time of the order. Can be absent. This is a number containing time in milliseconds since January 1, 1970 UTC.
destination string Destination where order was sent. Can be missing.
currency string Currency in which quantity is provided. If absent, symbol’s base currency is used as a default.
exchange_id string Exchange where execution occurred. Can be missing.
text string Arbitrary text associated with the order by the client. Optional.
properties array of PropertyDto Order type-specific fields.
order_id string Order identifier assigned by server.
order_status OrderStatus Order status at the time this event occurred.
cumulative_quantity decimal Total executed quantity of the order. This is a string containing a decimal floating-point value.
remaining_quantity decimal Total quantity of the order remaining for execution. This is a string containing a decimal floating-point value.
original_client_order_id string Client-specific order identifier of the changed order if client order id was modified. Can be absent.
trade_quantity decimal Executed quantity of this event if this event is execution. Absent otherwise. This is a string containing a decimal floating-point value.
trade_price decimal Execution price of this event if this event is execution. Absent otherwise. This is a string containing a decimal floating-point value.
is_agressor bool Was execution passive or agressive (maker or taker) if this event is execution. Absent otherwise.
commission decimal Commission charged by execution venue for this transaction if this event is trade report. Absent otherwise. This is a string containing a decimal floating-point value.
commission_currency string Currency used for commission if this event is trade report. Absent otherwise.

Example

{
  "id" : "...",
  "event_id" : "...",
  "type" : "reject",
  "sequence_number" : 12345,
  "timestamp" : 12345,
  "reason" : "...",
  "client_order_id" : "...",
  "security_id" : "...",
  "order_type" : "...",
  "order_side" : "buy",
  "quantity" : "123.4",
  "time_in_force" : "gtc",
  "limit_price" : "123.4",
  "stop_price" : "123.4",
  "average_price" : "123.4",
  "leverage" : "123.4",
  "expire_time" : 12345,
  "destination" : "...",
  "currency" : "...",
  "exchange_id" : "...",
  "text" : "...",
  "properties" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "order_id" : "...",
  "order_status" : "partially_filled",
  "cumulative_quantity" : "123.4",
  "remaining_quantity" : "123.4",
  "original_client_order_id" : "...",
  "trade_quantity" : "123.4",
  "trade_price" : "123.4",
  "is_agressor" : true,
  "commission" : "123.4",
  "commission_currency" : "..."
}


Home/Data Types/OrderEventType

Type of the order event.


Values

value description
submitted Order has been created.
reject Order has been rejected.
cancel Order has been canceled.
cancel_reject Order cancellation was rejected.
replace Order has been replaced.
replace_reject Order replacement was rejected.
trade Order trade has happened.
trade_cancel Order trade has been canceled.
trade_correct Order trade has been corrected.


Home/Data Types/OrderEventsRequestDto

Represents request for getting user’s order events.


Properties

name data type description
start_time number Start of time range.
reversed bool Should the result entries be older than the time specified. If missing - treated as false.
current_session bool Should the result contain closed orders from current trading session only or not. If missing - treated as false.
skip_replaced bool Should the result contain orders with status replaced. If missing - treated as false.
count number Max number of order events expected to receive. Effective max number can be lower than this, depending on backend configuration. If missing or negative - treated as unlimited.

Example

{
  "start_time" : 12345,
  "reversed" : true,
  "current_session" : false,
  "skip_replaced" : true,
  "count" : 12345
}


Home/Data Types/OrderStatus

Status of the order.


Values

value description
new Order has been just created.
rejected Order has been rejected.
canceled Order has been canceled.
replaced Order has been replaced.
partially_filled Part of the order has been filled.
completely_filled Order has been filled.
expired Order was expired.
pending_new Order creation was sent.
pending_cancel Order cancellation was sent.
pending_replace Order replacement was sent.
suspended Order was suspended.


Home/Data Types/OrderUpdateDto

Represents update for the order with the list of events, that has changed it from the previous state.


Properties

name data type description
order OrderDto New order state.
events array of OrderEventDto List of events that has modified the order.

Example

{
  "order" : {
    "client_order_id" : "...",
    "security_id" : "...",
    "quote_id" : "...",
    "type" : "...",
    "side" : "buy",
    "quantity" : "123.4",
    "time_in_force" : "gtd",
    "limit_price" : "123.4",
    "stop_price" : "123.4",
    "peg_difference" : "123.4",
    "min_quantity" : "123.4",
    "display_quantity" : "123.4",
    "leverage" : "123.4",
    "expire_time" : 12345,
    "submission_time" : 12345,
    "destination" : "...",
    "exchange_id" : "...",
    "source" : "...",
    "currency" : "...",
    "text" : "...",
    "properties" : [ {
      "key" : "...",
      "value" : "..."
    }, {
      "key" : "...",
      "value" : "..."
    } ],
    "id" : "...",
    "correlation_id" : "...",
    "timestamp" : 12345,
    "status" : "suspended",
    "trader_name" : "...",
    "product_type" : "spot",
    "cumulative_quantity" : "123.4",
    "remaining_quantity" : "123.4",
    "average_price" : "123.4",
    "receipt_time" : 12345,
    "close_time" : 12345,
    "last_timestamp" : 12345,
    "last_trade_price" : "123.4",
    "counterparty_code" : "...",
    "settlement_date" : 12345,
    "reason" : "..."
  },
  "events" : [ {
    "id" : "...",
    "event_id" : "...",
    "type" : "reject",
    "sequence_number" : 12345,
    "timestamp" : 12345,
    "reason" : "...",
    "client_order_id" : "...",
    "security_id" : "...",
    "order_type" : "...",
    "order_side" : "buy",
    "quantity" : "123.4",
    "time_in_force" : "gtc",
    "limit_price" : "123.4",
    "stop_price" : "123.4",
    "average_price" : "123.4",
    "leverage" : "123.4",
    "expire_time" : 12345,
    "destination" : "...",
    "currency" : "...",
    "exchange_id" : "...",
    "text" : "...",
    "properties" : [ {
      "key" : "...",
      "value" : "..."
    }, {
      "key" : "...",
      "value" : "..."
    } ],
    "order_id" : "...",
    "order_status" : "suspended",
    "cumulative_quantity" : "123.4",
    "remaining_quantity" : "123.4",
    "original_client_order_id" : "...",
    "trade_quantity" : "123.4",
    "trade_price" : "123.4",
    "is_agressor" : true,
    "commission" : "123.4",
    "commission_currency" : "..."
  } ]
}


Home/Data Types/Periodicity

Represents bar periodicity.


Values

value description
minute Bar for 1 minute.
minute5 Bar for 5 minutes.
minute15 Bar for 15 minutes.
minute30 Bar for 30 minutes.
hour Bar for 1 hour.
hour4 Bar for 4 hours.
hour8 Bar for 8 hours.
day Bar for 1 day (24 hours).
week Bar for 1 week (7 days).
month Bar for 1 calendar month.


Home/Data Types/PrimeBrokerAccountDto


Properties

name data type description
id string Implementation-specific prime broker account identifier.
name string Human-readable name of this account.
custom_data string Custom data.

Example

{
  "id" : "...",
  "name" : "...",
  "custom_data" : "..."
}


Home/Data Types/ProductType

Defines type of settlement.


Values

value description
spot Settlement occurs on spot. This is the default product type.
pre_spot Settlement occurs before spot. This is deprecated. Forward is sent instead.
forward Settlement occurs after spot.


Home/Data Types/PropertyDto

Key-value pair.


Properties

name data type description
key string Key.
value string String value.

Example

{
  "key" : "...",
  "value" : "..."
}


Home/Data Types/QuoteDto

Class that defines a suggested quote.


Properties

name data type description
request_id string Quote request identifier assigned by server.
id string Quote identifier assigned by server.
source string Quote source. Optional. Can be missing if quote source is unknown. Generally should be present.
bid_price decimal Bid price. NULL for one-sided quote where ask is provided. This is a string containing a decimal floating-point value.
bid_size decimal Bid quantity. NULL for one-sided quote where ask is provided. Zero value means lack of bids on the market or cancellation of previously sent bid. This is a string containing a decimal floating-point value.
ask_price decimal Ask price. NULL for one-sided quote where bid is provided. This is a string containing a decimal floating-point value.
ask_size decimal Ask quantity. NULL for one-sided quote where bid is provided. Zero value means lack of asks on the market or cancellation of previously sent ask. This is a string containing a decimal floating-point value.
currency_id string Identifier of quantity currency.
valid_until_time number Time when this quote will expire.

Example

{
  "request_id" : "...",
  "id" : "...",
  "source" : "...",
  "bid_price" : "123.4",
  "bid_size" : "123.4",
  "ask_price" : "123.4",
  "ask_size" : "123.4",
  "currency_id" : "...",
  "valid_until_time" : 12345
}


Home/Data Types/QuoteRequestDto

Class that defines a request for quote.

Subtypes:


Properties

name data type description
security_id string Requested quote instrument identifier.
side Side Requested quote side.
size decimal Requested quote size. This is a string containing a decimal floating-point value.
currency string Currency in which size is provided. Optional. If missing, symbol’s base currency will be used as a default. Depending on the underlying implementation, some constraints may be put on this field.
destination string Destination, if needed.
prime_broker_account string Prime broker account.
settlement_date number Trade settlement date.
tenor string Trade settlement type - tenor.
message string Optional text message that will be delivered to the quote provider.

Example

{
  "security_id" : "...",
  "side" : "buy",
  "size" : "123.4",
  "currency" : "...",
  "destination" : "...",
  "prime_broker_account" : "...",
  "settlement_date" : 12345,
  "tenor" : "...",
  "message" : "..."
}


Home/Data Types/QuoteSubscriptionDto

Class that defines a subscription for quotes.


Properties

name data type description
request_id string Quote request identifier assigned by server.
expire_time number Time when the quote request expires.
last_quote QuoteDto Last quote arrived for this request.

Properties inherited from QuoteRequestDto

name data type description
security_id string Requested quote instrument identifier.
side Side Requested quote side.
size decimal Requested quote size. This is a string containing a decimal floating-point value.
currency string Currency in which size is provided. Optional. If missing, symbol’s base currency will be used as a default. Depending on the underlying implementation, some constraints may be put on this field.
destination string Destination, if needed.
prime_broker_account string Prime broker account.
settlement_date number Trade settlement date.
tenor string Trade settlement type - tenor.
message string Optional text message that will be delivered to the quote provider.

Example

{
  "security_id" : "...",
  "side" : "buy",
  "size" : "123.4",
  "currency" : "...",
  "destination" : "...",
  "prime_broker_account" : "...",
  "settlement_date" : 12345,
  "tenor" : "...",
  "message" : "...",
  "request_id" : "...",
  "expire_time" : 12345,
  "last_quote" : {
    "request_id" : "...",
    "id" : "...",
    "source" : "...",
    "bid_price" : "123.4",
    "bid_size" : "123.4",
    "ask_price" : "123.4",
    "ask_size" : "123.4",
    "currency_id" : "...",
    "valid_until_time" : 12345
  }
}


Home/Data Types/RFQRequestIdDto

Represents RFQ request identifier.


Properties

name data type description
request_id string Request identifier.

Example

{
  "request_id" : "..."
}


Home/Data Types/SecurityDto

Class that defines a security with the user-specific settings.


Properties

name data type description
id string Implementation-specific security identifier.
calendar_id string Implementation-specific identifier of the securities trading calendar.
name string Human-readable name of this security.
security_type SecurityType Standardized security type.
type string Type of this security. Arbitrary string - this is mostly used for grouping.
tick_size decimal Granularity of the price change. This is a string containing a decimal floating-point value.
multiplier decimal Granularity of the volume change. This is a string containing a decimal floating-point value.
base_currency string Base currency.
term_currency string Term currency.
trading_currency TradingCurrency Rule for determine what account is used for trading this security.
price_precision number Number of decimal digits for price values.
quantity_precision number Number of decimal digits for quantity values.
display_method SecurityDisplayMethod Security price display method.
pips_highlight_start number Valid only for DisplayMethod = PIPS_HIGHLIGHT. For other display method value is ignored. Pips highlight will start from this digit. PipsHighlightStart <= PipsHighlightEnd. Positive numbers stands for integer part and means distance from the decimal point. Example if you want to start highlight from hundreds it should be equal to 3. Negative numbers stands for decimal part and means distance from the decimal point. Example if you want to start highlight from hundredth it should be equal to -3.
pips_highlight_end number Valid only for DisplayMethod = PIPS_HIGHLIGHT. For other display method value is ignored. Pips highlight will end at this digit. PipsHighlightStart <= PipsHighlightEnd. Positive numbers stands for integer part and means distance from the decimal point. Example if you want to end highlight at hundreds it should be equal to 3. Negative numbers stands for decimal part and means distance from the decimal point. Example if you want to end highlight at hundredth it should be equal to -3.
main_fraction number Valid only for DisplayMethod = FRACTIONS. For other display method value is ignored. First denominator.
sub_fraction number Valid only for DisplayMethod = FRACTIONS. For other display method value is ignored. Second denominator.
number_of_fraction_decimals number Valid only for DisplayMethod = FRACTIONS. For other display method value is ignored. Number of decimals.
max_bars_count number Maximum number of historical bars web backend can send for this security.
first_bar_timestamp number Timestamp of the first minute bar available. Equals to zero if no minute bars are available. This is a number containing time in milliseconds since January 1, 1970 UTC.
last_bar_timestamp number Timestamp of the last minute bar available. Can be larger than current timestamp, if current bar is available. Equals to zero if no minute bars are available. This is a number containing time in milliseconds since January 1, 1970 UTC.
order_types array of string List of allowed order types.
linked_order_types array of string List of allowed linked order types.
time_in_forces array of TimeInForce List of TimeInForces allowed for all orders except market.
default_time_in_force TimeInForce Default TimeInForce for all orders except market.
market_time_in_forces array of TimeInForce List of TimeInForces allowed for market orders.
default_market_time_in_force TimeInForce Default TimeInForce for market orders.
pre_open_time_in_forces array of TimeInForce List of TimeInForces allowed for all orders except market during session pre-open.
default_pre_open_time_in_force TimeInForce Default TimeInForce for all orders except market during session pre-open.
minimum_quantity decimal Range of available order size for the security: minimum allowable quantity. This is a string containing a decimal floating-point value.
maximum_quantity decimal Range of available order size for the security: maximum allowable quantity. This is a string containing a decimal floating-point value.
default_quantity decimal Default quantity of available order size for the security. This is a string containing a decimal floating-point value.
quantity_increment decimal Range of available order size for the security: quantity increment. This is a string containing a decimal floating-point value.
target_price_minimum decimal Min order target price. This is a string containing a decimal floating-point value.
target_price_maximum decimal Max order target price. This is a string containing a decimal floating-point value.
target_price_increment decimal Increment of order target price. This is a string containing a decimal floating-point value.
show_exchange_id bool Should the user receive and see exchange ids in execution events, order book, trade history etc for this security.
adjust_book bool Should the frontend adjust order book using external commissions.
execution_explanation ExecutionExplanation Type of execution explanation.
available_book_exchanges array of string List of book exchange ids available for the user. Will be empty, if show_exchange_id = false.
available_trade_exchanges array of string List of trade exchange ids available for the user. Will be empty, if show_exchange_id = false.
available_destinations array of string List of available order destinations for this security.
default_destination string Default destination for this security. Will be used if order’s destination missing.
order_max_ttl number Maximal order time to live in milliseconds.
buyer_taker_commission_flat decimal Fixed value to be taken as buyer taker trading commission. Zero means no flat commission. This is a string containing a decimal floating-point value.
buyer_taker_commission_progressive decimal Percent of order quantity to be taken as buyer taker trading commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
seller_taker_commission_flat decimal Fixed value to be taken as seller taker trading commission. Zero means no flat commission. This is a string containing a decimal floating-point value.
seller_taker_commission_progressive decimal Percent of order quantity to be taken as seller taker trading commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
buyer_maker_commission_flat decimal Fixed value to be taken as buyer maker trading commission. Zero means no flat commission. This is a string containing a decimal floating-point value.
buyer_maker_commission_progressive decimal Percent of order quantity to be taken as buyer maker trading commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
buyer_flat_commission_method TradingCommissionMethod Method of computation of buyer flat commission.
buyer_progressive_commission_method TradingCommissionMethod Method of computation of buyer progressive commission.
buyer_commission_account TradingCommissionAccount Defines an account for taking buyer trading commission.
seller_maker_commission_flat decimal Fixed value to be taken as seller maker trading commission. Zero means no flat commission. This is a string containing a decimal floating-point value.
seller_maker_commission_progressive decimal Percent of order quantity to be taken as seller maker trading commission. Zero means no progressive commission. This is a string containing a decimal floating-point value.
seller_flat_commission_method TradingCommissionMethod Method of computation of seller flat commission.
seller_progressive_commission_method TradingCommissionMethod Method of computation of seller progressive commission.
seller_commission_account TradingCommissionAccount Defines an account for taking seller trading commission.
charge_flat_commission_at ChargeFlatCommissionTime Time of flat commission charging.
taker_reserve_multiplier decimal Taker reserve commission for a ticker. This is a string containing a decimal floating-point value.
external_commissions array of ExternalCommissionDto List of external commissions per exchange, if available.
prime_broker_accounts array of string List of available prime broker accounts.
is_rfq_allowed bool If request for quote allowed for the user for the specified security.
custom_data string Custom data.
custom_data2 string Second field containing custom data.
modification_time number Modification time of security.

Example

{
  "id" : "...",
  "calendar_id" : "...",
  "name" : "...",
  "security_type" : "option",
  "type" : "...",
  "tick_size" : "123.4",
  "multiplier" : "123.4",
  "base_currency" : "...",
  "term_currency" : "...",
  "trading_currency" : "base",
  "price_precision" : 12345,
  "quantity_precision" : 12345,
  "display_method" : "pips_highlight",
  "pips_highlight_start" : 12345,
  "pips_highlight_end" : 12345,
  "main_fraction" : 12345,
  "sub_fraction" : 12345,
  "number_of_fraction_decimals" : 12345,
  "max_bars_count" : 12345,
  "first_bar_timestamp" : 12345,
  "last_bar_timestamp" : 12345,
  "order_types" : [ "...", "..." ],
  "linked_order_types" : [ "...", "..." ],
  "time_in_forces" : [ "gtd", "ioc" ],
  "default_time_in_force" : "day",
  "market_time_in_forces" : [ "at_the_close", "at_the_close" ],
  "default_market_time_in_force" : "fok",
  "pre_open_time_in_forces" : [ "day", "at_the_opening" ],
  "default_pre_open_time_in_force" : "ioc",
  "minimum_quantity" : "123.4",
  "maximum_quantity" : "123.4",
  "default_quantity" : "123.4",
  "quantity_increment" : "123.4",
  "target_price_minimum" : "123.4",
  "target_price_maximum" : "123.4",
  "target_price_increment" : "123.4",
  "show_exchange_id" : false,
  "adjust_book" : false,
  "execution_explanation" : "none",
  "available_book_exchanges" : [ "...", "..." ],
  "available_trade_exchanges" : [ "...", "..." ],
  "available_destinations" : [ "...", "..." ],
  "default_destination" : "...",
  "order_max_ttl" : 12345,
  "buyer_taker_commission_flat" : "123.4",
  "buyer_taker_commission_progressive" : "123.4",
  "seller_taker_commission_flat" : "123.4",
  "seller_taker_commission_progressive" : "123.4",
  "buyer_maker_commission_flat" : "123.4",
  "buyer_maker_commission_progressive" : "123.4",
  "buyer_flat_commission_method" : "term_ticks",
  "buyer_progressive_commission_method" : "exact_value",
  "buyer_commission_account" : "source_account",
  "seller_maker_commission_flat" : "123.4",
  "seller_maker_commission_progressive" : "123.4",
  "seller_flat_commission_method" : "term_ticks",
  "seller_progressive_commission_method" : "term_ticks",
  "seller_commission_account" : "abc_account",
  "charge_flat_commission_at" : "acknowledgment",
  "taker_reserve_multiplier" : "123.4",
  "external_commissions" : [ {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  }, {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  } ],
  "prime_broker_accounts" : [ "...", "..." ],
  "is_rfq_allowed" : false,
  "custom_data" : "...",
  "custom_data2" : "...",
  "modification_time" : 12345
}


Home/Data Types/SecurityActionDto

Class that defines an action to a specific security.


Properties

name data type description
id string Implementation-specific security identifier.
action EntityAction Action to do with a security.
security SecurityDto A security that is being added or changed. This field is missing, if the security should be removed.

Example

{
  "id" : "...",
  "action" : "insert",
  "security" : {
    "id" : "...",
    "calendar_id" : "...",
    "name" : "...",
    "security_type" : "unknown",
    "type" : "...",
    "tick_size" : "123.4",
    "multiplier" : "123.4",
    "base_currency" : "...",
    "term_currency" : "...",
    "trading_currency" : "side",
    "price_precision" : 12345,
    "quantity_precision" : 12345,
    "display_method" : "pips_highlight",
    "pips_highlight_start" : 12345,
    "pips_highlight_end" : 12345,
    "main_fraction" : 12345,
    "sub_fraction" : 12345,
    "number_of_fraction_decimals" : 12345,
    "max_bars_count" : 12345,
    "first_bar_timestamp" : 12345,
    "last_bar_timestamp" : 12345,
    "order_types" : [ "...", "..." ],
    "linked_order_types" : [ "...", "..." ],
    "time_in_forces" : [ "gtd", "ioc" ],
    "default_time_in_force" : "fok",
    "market_time_in_forces" : [ "gtc", "at_the_opening" ],
    "default_market_time_in_force" : "gtc",
    "pre_open_time_in_forces" : [ "gtc", "good_till_crossing" ],
    "default_pre_open_time_in_force" : "at_the_opening",
    "minimum_quantity" : "123.4",
    "maximum_quantity" : "123.4",
    "default_quantity" : "123.4",
    "quantity_increment" : "123.4",
    "target_price_minimum" : "123.4",
    "target_price_maximum" : "123.4",
    "target_price_increment" : "123.4",
    "show_exchange_id" : true,
    "adjust_book" : false,
    "execution_explanation" : "price",
    "available_book_exchanges" : [ "...", "..." ],
    "available_trade_exchanges" : [ "...", "..." ],
    "available_destinations" : [ "...", "..." ],
    "default_destination" : "...",
    "order_max_ttl" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "buyer_flat_commission_method" : "exact_value",
    "buyer_progressive_commission_method" : "exact_value",
    "buyer_commission_account" : "source_account",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4",
    "seller_flat_commission_method" : "exact_value",
    "seller_progressive_commission_method" : "term_ticks",
    "seller_commission_account" : "destination_account",
    "charge_flat_commission_at" : "acknowledgment",
    "taker_reserve_multiplier" : "123.4",
    "external_commissions" : [ {
      "exchange_id" : "...",
      "commission_currency" : "...",
      "maker_commission" : "123.4",
      "taker_commission" : "123.4"
    }, {
      "exchange_id" : "...",
      "commission_currency" : "...",
      "maker_commission" : "123.4",
      "taker_commission" : "123.4"
    } ],
    "prime_broker_accounts" : [ "...", "..." ],
    "is_rfq_allowed" : true,
    "custom_data" : "...",
    "custom_data2" : "...",
    "modification_time" : 12345
  }
}


Home/Data Types/SecurityBarsDto

Class that defines security bars.


Properties

name data type description
max_bars_count number Maximum number of historical bars web backend can send for this security.
first_bar_timestamp number Timestamp of the first minute bar available. Equals to zero if no minute bars are available. This is a number containing time in milliseconds since January 1, 1970 UTC.
last_bar_timestamp number Timestamp of the last minute bar available. Can be larger than current timestamp, if current bar is available. Equals to zero if no minute bars are available. This is a number containing time in milliseconds since January 1, 1970 UTC.

Example

{
  "max_bars_count" : 12345,
  "first_bar_timestamp" : 12345,
  "last_bar_timestamp" : 12345
}


Home/Data Types/SecurityCommissionsDto

Class that defines security commissions.


Properties

name data type description
security_id string Implementation-specific security identifier.
buyer_flat_commission_method TradingCommissionMethod Method of computation of buyer flat commission.
buyer_progressive_commission_method TradingCommissionMethod Method of computation of buyer progressive commission.
buyer_commission_account TradingCommissionAccount Defines an account for taking buyer trading commission.
seller_flat_commission_method TradingCommissionMethod Method of computation of seller flat commission.
seller_progressive_commission_method TradingCommissionMethod Method of computation of seller progressive commission.
seller_commission_account TradingCommissionAccount Defines an account for taking seller trading commission.
charge_flat_commission_at ChargeFlatCommissionTime Time of flat commission charging.
taker_reserve_multiplier decimal Taker reserve commission for a ticker. This is a string containing a decimal floating-point value.
external_commissions array of ExternalCommissionDto List of external commissions per exchange, if available.
current_commission_plan CommissionPlanDto Current commission plan.

Example

{
  "security_id" : "...",
  "buyer_flat_commission_method" : "quantity_percent",
  "buyer_progressive_commission_method" : "exact_value",
  "buyer_commission_account" : "destination_account",
  "seller_flat_commission_method" : "term_ticks",
  "seller_progressive_commission_method" : "term_ticks",
  "seller_commission_account" : "source_account",
  "charge_flat_commission_at" : "first_fill",
  "taker_reserve_multiplier" : "123.4",
  "external_commissions" : [ {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  }, {
    "exchange_id" : "...",
    "commission_currency" : "...",
    "maker_commission" : "123.4",
    "taker_commission" : "123.4"
  } ],
  "current_commission_plan" : {
    "average_balance" : "123.4",
    "total_volume" : "123.4",
    "invited_users_count" : 12345,
    "buyer_taker_commission_flat" : "123.4",
    "buyer_taker_commission_progressive" : "123.4",
    "seller_taker_commission_flat" : "123.4",
    "seller_taker_commission_progressive" : "123.4",
    "buyer_maker_commission_flat" : "123.4",
    "buyer_maker_commission_progressive" : "123.4",
    "seller_maker_commission_flat" : "123.4",
    "seller_maker_commission_progressive" : "123.4"
  }
}


Home/Data Types/SecurityDisplayMethod

Security price display method.


Values

value description
plain_text Display price as simple text.
fractions Display price in fractions format.
pips_highlight Highlight pips digits.


Home/Data Types/SecurityStatisticsDto

Class that defines security current prices and statistics.


Properties

name data type description
security_id string Implementation-specific security identifier.
bid decimal Bid price. Can be missing. This is a string containing a decimal floating-point value.
ask decimal Ask price. Can be missing. This is a string containing a decimal floating-point value.
price_24h_change decimal Mid price change since the beginning of hour that was 24 hours ago. For example, if current time is ‘2018-06-25 17:53:52’, price change will be calculated since ‘2018-06-24 17:00:00’. This is a string containing a decimal floating-point value.
volume_24h_change decimal Daily trade volume for current moment. This is a string containing a decimal floating-point value.
price_24h_max decimal Max price during 24 hours. For example, if current time is ‘2018-06-25 17:53:52’, price max will be calculated since ‘2018-06-24 17:00:00’. This is a string containing a decimal floating-point value.
price_24h_min decimal Min price during 24 hours. For example, if current time is ‘2018-06-25 17:53:52’, price change will be calculated since ‘2018-06-24 17:00:00’. This is a string containing a decimal floating-point value.
last_trade_price decimal Price of last trade for this security, if any occurred. Can be missing. This is a string containing a decimal floating-point value.

Example

{
  "security_id" : "...",
  "bid" : "123.4",
  "ask" : "123.4",
  "price_24h_change" : "123.4",
  "volume_24h_change" : "123.4",
  "price_24h_max" : "123.4",
  "price_24h_min" : "123.4",
  "last_trade_price" : "123.4"
}


Home/Data Types/SecurityStatusDto

Class that defines current security status.


Properties

name data type description
session_status SessionStatus Trading session status.

Example

{
  "session_status" : "trading"
}


Home/Data Types/SecurityType

Type of the instrument.


Values

value description
unknown Unknown.
currency Currency (FX).
equity Equity.
futures Future contract.
etf Exchange traded fund (ETF).
cfd Contract for difference (CFD).
nft Non-fungible token (NFT).
option Option.
bond Bond.
index Index.
simple_option Simple option.
synthetic Synthetic.


Home/Data Types/SecurityV2Dto

Class that defines a security with the user-specific settings.


Properties

name data type description
id string Implementation-specific security identifier.
calendar_id string Implementation-specific identifier of the securities trading calendar.
name string Human-readable name of this security.
security_type SecurityType Standardized security type.
type string Type of this security. Arbitrary string - this is mostly used for grouping.
tick decimal Granularity of the price change. This is a string containing a decimal floating-point value.
mul decimal Granularity of the volume change. This is a string containing a decimal floating-point value.
base string Base currency.
term string Term currency.
trade_curr TradingCurrency Rule for determine what account is used for trading this security.
p_prec number Number of decimal digits for price values.
q_prec number Number of decimal digits for quantity values.
display SecurityDisplayMethod Security price display method.
pips array of number Valid only for DisplayMethod = PIPS_HIGHLIGHT. For other display method value is ignored. Pips highlight will start from this digit. PipsHighlightStart <= PipsHighlightEnd. Positive numbers stands for integer part and means distance from the decimal point. Example if you want to start highlight from hundreds it should be equal to 3. Negative numbers stands for decimal part and means distance from the decimal point. Example if you want to start highlight from hundredth it should be equal to -3. Contains exactly two values. First is PipsHighlightStart, second is PipsHighlightEnd.
fract array of number Valid only for DisplayMethod = FRACTIONS. For other display method value is ignored. Contains exactly three values. First is main fraction (first denominator), second is sub fraction (second denominator), third is number of decimals.
o_types array of string List of allowed order types.
lo_types array of string List of allowed linked order types.
tif array of TimeInForce List of TimeInForces allowed for all orders except market.
tif_def TimeInForce Default TimeInForce for all orders except market.
m_tif array of TimeInForce List of TimeInForces allowed for market orders.
m_tif_def TimeInForce Default TimeInForce for market orders.
po_tif array of TimeInForce List of TimeInForces allowed for all orders except market during session pre-open.
po_tif_def TimeInForce Default TimeInForce for all orders except market during session pre-open.
qty array of decimal Range of available order size for the security. Contains exactly four values: default quantity, minimum quantity, quantity increment and maximum quantity. Each array item is a string containing a decimal floating-point value.
price array of decimal Range of available target prices for the security. Contains exactly three values: minimum price, price increment and maximum price. Each array item is a string containing a decimal floating-point value.
show_exch bool Should the user receive and see exchange ids in execution events, order book, trade history etc for this security.
adjust_book bool Should the frontend adjust order book using external commissions.
explain ExecutionExplanation Type of execution explanation.
book_exch array of string List of book exchange ids available for the user. Will be empty, if show_exchange_id = false.
trade_exch array of string List of trade exchange ids available for the user. Will be empty, if show_exchange_id = false.
dest array of string List of available order destinations for this security.
dest_def string Default destination for this security. Will be used if order’s destination missing.
o_ttl number Maximal order time to live in milliseconds.
pb_acc array of string List of available prime broker accounts.
is_rfq bool If request for quote allowed for the user for the specified security.
custom string Custom data.
custom2 string Second field containing custom data.
time number Modification time of security.

Example

{
  "id" : "...",
  "calendar_id" : "...",
  "name" : "...",
  "security_type" : "option",
  "type" : "...",
  "tick" : "123.4",
  "mul" : "123.4",
  "base" : "...",
  "term" : "...",
  "trade_curr" : "side",
  "p_prec" : 12345,
  "q_prec" : 12345,
  "display" : "fractions",
  "pips" : [ 12345, 12345 ],
  "fract" : [ 12345, 12345 ],
  "o_types" : [ "...", "..." ],
  "lo_types" : [ "...", "..." ],
  "tif" : [ "ioc", "gtd" ],
  "tif_def" : "at_the_opening",
  "m_tif" : [ "gtc", "fok" ],
  "m_tif_def" : "gtc",
  "po_tif" : [ "ioc", "gtc" ],
  "po_tif_def" : "fok",
  "qty" : [ "123.4", "123.4" ],
  "price" : [ "123.4", "123.4" ],
  "show_exch" : false,
  "adjust_book" : false,
  "explain" : "commission",
  "book_exch" : [ "...", "..." ],
  "trade_exch" : [ "...", "..." ],
  "dest" : [ "...", "..." ],
  "dest_def" : "...",
  "o_ttl" : 12345,
  "pb_acc" : [ "...", "..." ],
  "is_rfq" : true,
  "custom" : "...",
  "custom2" : "...",
  "time" : 12345
}


Home/Data Types/SecurityV2ActionDto


Properties

name data type description
id string Implementation-specific security identifier.
action EntityAction Action to do with a security.
security SecurityV2Dto A security that is being added or changed. This field is missing, if the security should be removed.

Example

{
  "id" : "...",
  "action" : "delete",
  "security" : {
    "id" : "...",
    "calendar_id" : "...",
    "name" : "...",
    "security_type" : "futures",
    "type" : "...",
    "tick" : "123.4",
    "mul" : "123.4",
    "base" : "...",
    "term" : "...",
    "trade_curr" : "term",
    "p_prec" : 12345,
    "q_prec" : 12345,
    "display" : "plain_text",
    "pips" : [ 12345, 12345 ],
    "fract" : [ 12345, 12345 ],
    "o_types" : [ "...", "..." ],
    "lo_types" : [ "...", "..." ],
    "tif" : [ "ioc", "gtc" ],
    "tif_def" : "gtc",
    "m_tif" : [ "at_the_opening", "at_the_close" ],
    "m_tif_def" : "day",
    "po_tif" : [ "gtc", "gtc" ],
    "po_tif_def" : "at_the_close",
    "qty" : [ "123.4", "123.4" ],
    "price" : [ "123.4", "123.4" ],
    "show_exch" : false,
    "adjust_book" : true,
    "explain" : "none",
    "book_exch" : [ "...", "..." ],
    "trade_exch" : [ "...", "..." ],
    "dest" : [ "...", "..." ],
    "dest_def" : "...",
    "o_ttl" : 12345,
    "pb_acc" : [ "...", "..." ],
    "is_rfq" : false,
    "custom" : "...",
    "custom2" : "...",
    "time" : 12345
  }
}


Home/Data Types/SessionStatus

Trading session status.


Values

value description
trading Trading time.
non_trading Non-trading time.
pre_trading Pre-trading time.


Home/Data Types/Side

Side of the order.


Values

value description
buy Buy.
sell Sell.


Home/Data Types/StakingDto

Class that defines a staking.


Properties

name data type description
id string Implementation-specific staking identifier.
staking_plan_id string Implementation-specific staking plan identifier.
currency string Staking currency.
account_id string Implementation-specific account identifier.
period number Staking period in days. This is deprecated. Use period_ms instead.
period_ms number Staking period in milliseconds.
bonding_period number Duration between staking opening time and staking start time in milliseconds.
unbonding_period number Duration between staking close time and staking payout in milliseconds.
safe_period number Duration, during which it is allowed to cancel staking instantly with standard interest return, in milliseconds.
interest decimal Interest in percent. This is deprecated. Use annual_interest instead.
annual_interest decimal Annual interest in percent.
fee decimal Percent of interest to be taken as fee.
standard_cancellation_return decimal Percent of interest returned in case of standard cancellation. Optional. If missing, standard cancellation is disabled.
instant_cancellation_return decimal Percent of interest returned in case of instant cancellation. Optional. If missing, instant cancellation is disabled.
infinite bool Flag that determines if the staking is infinite or not. Infinite stakings are not cancelled on end time, but prolonged instead for the next period. Interest is payed on each staking end time as usual. Infinite stakings are always returnable.
returnable bool Flag that determines if the user can cancel the reservation fully in the middle of the period or not. Infinite stakings are always returnable.
partially_returnable bool Flag that determines if the user can cancel part of the the reservation in the middle of the period or not.
auto_stake bool Flag, indicating if auto-stake is turned on for the staking.
stake_more bool Flag that indicates if stake more is allowed for the staking.
minimum_amount decimal Minimal staking amount. The staking cannot be left with the amount less than this using partial cancellations.
description string Staking plan description string for using by the UI.
amount decimal Staking amount.
start_time number Staking start time.
end_time number Staking end time.
gainings decimal Gainings is the amount of money the user gets in the end of the period. Optional. Can be missing if were not calculated yet.
cumulative_gainings decimal Sum of all gainings for this staking.
fee_amount decimal The amount of fee to be taken from gainings in case of full staking period. Optional. Can be missing if gainings were not calculated yet.
cumulative_fee_amount decimal Sum of all fees for this staking.
is_unbonding bool Flag that indicates if there are any unstakes in progress.
cancellation_type StakingCancellationType Cancellation type, in case staking was cancelled by the user. Optional. Missing for active stakings.
reason string Human-readable staking reason if present.
status OperationStatus Staking status.
creation_time number Time when staking was initiated.
modification_time number Last staking operation modification time.

Example

{
  "id" : "...",
  "staking_plan_id" : "...",
  "currency" : "...",
  "account_id" : "...",
  "period_ms" : 12345,
  "bonding_period" : 12345,
  "unbonding_period" : 12345,
  "safe_period" : 12345,
  "annual_interest" : "123.4",
  "fee" : "123.4",
  "standard_cancellation_return" : "123.4",
  "instant_cancellation_return" : "123.4",
  "infinite" : false,
  "returnable" : false,
  "partially_returnable" : false,
  "auto_stake" : true,
  "stake_more" : true,
  "minimum_amount" : "123.4",
  "description" : "...",
  "amount" : "123.4",
  "start_time" : 12345,
  "end_time" : 12345,
  "gainings" : "123.4",
  "cumulative_gainings" : "123.4",
  "fee_amount" : "123.4",
  "cumulative_fee_amount" : "123.4",
  "is_unbonding" : false,
  "cancellation_type" : "standard",
  "reason" : "...",
  "status" : "pending",
  "creation_time" : 12345,
  "modification_time" : 12345
}


Home/Data Types/StakingCancellationType

Defines type of staking cancellation.


Values

value description
standard Standard cancellation.
instant Instant cancellation.
safe Safe cancellation. Instant, but with standard interest return.
expired Expired staking. Is used for finished stakings.


Home/Data Types/TimeInForce

Specifies how long the order remains in effect.


Values

value description
gtc Good till canceled.
gtd Good till date.
ioc Immediate or cancel.
fok Fill or kill.
day Day till canceled.
at_the_opening At the opening.
at_the_close At the close.
good_till_crossing Good till crossing.


Home/Data Types/TotalStatisticsDto

Class that defines transaction statistics.


Properties

name data type description
type TransactionType Transaction type.
total decimal Total amount for the transaction type specified.
total_this_day decimal Total amount for current day for the transaction type specified. Can be absent.
total_this_week decimal Total amount for current week for the transaction type specified. Can be absent.
total_this_month decimal Total amount for current month for the transaction type specified. Can be absent.
total_this_year decimal Total amount for current year for the transaction type specified. Can be absent.

Example

{
  "type" : "interest",
  "total" : "123.4",
  "total_this_day" : "123.4",
  "total_this_week" : "123.4",
  "total_this_month" : "123.4",
  "total_this_year" : "123.4"
}


Home/Data Types/TradingCommissionAccount

Account from which trading commission will be taken.


Values

value description
source_account
destination_account
abc_account


Home/Data Types/TradingCommissionMethod

Method of computation of trading commission.


Values

value description
exact_value Trading Commission value will be TradingCommission * Quantity TERM currency ticks, converted to Account Base Currency using current TERM/ABC rate.
term_ticks Trading Commission value will be TradingCommission Quantity.
quantity_percent Trading Commission value will be TradingCommission Quantity.


Home/Data Types/TradingCurrency

Determines what account to use for trading.


Values

value description
side Account is determined by order side.
base Account is determined by base currency of the security.
term Account is determined by term currency of the security.


Home/Data Types/TradingLimitsDto

Class that defines trading statistics.


Properties

name data type description
currency_id string Currency code as defined by ISO 4217.
daily_volume_limit decimal Daily volume limit after which the user cannot trade. Optional. If missing - there are no daily trading limits.
weekly_volume_limit decimal Weekly volume limit after which the user cannot trade. Optional. If missing - there are no weekly trading limits.
monthly_volume_limit decimal Monthly volume limit after which the user cannot trade. Optional. If missing - there are no monthly trading limits.
yearly_volume_limit decimal Yearly volume limit after which the user cannot trade. Optional. If missing - there are no yearly trading limits.
daily_volume decimal Current user’s daily volume.
weekly_volume decimal Current user’s weekly volume.
monthly_volume decimal Current user’s monthly volume.
yearly_volume decimal Current user’s yearly volume.
total_volume decimal Current user’s total volume.

Example

{
  "currency_id" : "...",
  "daily_volume_limit" : "123.4",
  "weekly_volume_limit" : "123.4",
  "monthly_volume_limit" : "123.4",
  "yearly_volume_limit" : "123.4",
  "daily_volume" : "123.4",
  "weekly_volume" : "123.4",
  "monthly_volume" : "123.4",
  "yearly_volume" : "123.4",
  "total_volume" : "123.4"
}


Home/Data Types/TradingSessionDto

Class that defines a trading session.


Properties

name data type description
calendar_id string Implementation-specific identifier of the trading calendar.
pre_open number Time when session pre-open phase begins. Optional. This is a number containing time in milliseconds since January 1, 1970 UTC.
start number Time when session opens. This is a number containing time in milliseconds since January 1, 1970 UTC.
end number Time when session closes. This is a number containing time in milliseconds since January 1, 1970 UTC.
current_status SessionStatus Session status for the request time.

Example

{
  "calendar_id" : "...",
  "pre_open" : 12345,
  "start" : 12345,
  "end" : 12345,
  "current_status" : "pre_trading"
}


Home/Data Types/TransactionDto

Class that defines a transaction.


Properties

name data type description
account_id string Implementation-specific user account identifier of the account this transaction is for.
currency_id string Transaction currency.
id string Implementation-specific transaction identifier.
type TransactionType Transaction type.
amount decimal Transaction amount.
post_balance decimal Account balance after applying the transaction.
status OperationStatus Transaction status.
reason string Human-readable transaction reason if present.
description string Transaction implementation-specific description. May contain any custom information, for example - bank account requisites.
address string Blockchain address.
internal_transaction_id string Implementation-specific transaction identifier. Can be null, if transaction was not completed yet.
network string Transaction network. Optional. Only filled if was provided during the request.
transaction_id string ID of the transaction within the blockchain.
confirmations number Number of confirmations within the blockchain.
confirmations_needed number Number of blockchain confirmations needed for transaction approval.
external_currency_id string External account currency, if it differs from internal account currency.
external_conversion_price decimal Conversion price used for exchanging external account currency, if it differs from internal account currency.
creation_time number Time when transaction was initiated.
modification_time number Last transaction operation modification time.

Example

{
  "account_id" : "...",
  "currency_id" : "...",
  "id" : "...",
  "type" : "trading_commission",
  "amount" : "123.4",
  "post_balance" : "123.4",
  "status" : "succeeded",
  "reason" : "...",
  "address" : "...",
  "internal_transaction_id" : "...",
  "network" : "...",
  "transaction_id" : "...",
  "confirmations" : 12345,
  "confirmations_needed" : 12345,
  "external_currency_id" : "...",
  "external_conversion_price" : "123.4",
  "creation_time" : 12345,
  "modification_time" : 12345
}


Home/Data Types/TransactionType

Type of the transaction.


Values

value description
execution Profit or loss on trading.
deposit Bank or credit card deposit.
credit Bonus or other credit.
debit Account debit.
balance_correction Correction of balance.
withdrawal Withdrawal of funds.
withdrawal_commission Commission applied on withdrawal.
trading_commission Commission applied on trading.
rollover_commission Commission applied on deal rollover.
deposit_commission Commission applied on deposit.
interest Rewards that users receive from the system, for example for saving money there.
withdrawal_reservation Balance reservation for withdrawal.
withdrawal_reservation_cancel Balance reservation cancel for withdrawal.
transfer_send Internal transfer sending.
transfer_receive Internal transfer receiving.
interest_commission Commission applied on interest.


Home/Data Types/TransferDto

Class that defines an internal transfer.


Properties

name data type description
account_id string Implementation-specific user account identifier of the account this transfer is for.
currency_id string Transfer currency.
id string Implementation-specific transfer identifier.
type TransferType Transfer type.
amount decimal Transfer amount.
counterparty_id string Identifier of the transfer counterparty user.
status OperationStatus Transfer status.
reason string Human-readable transfer reason if present.
creation_time number Time when transfer was initiated.
modification_time number Last transfer operation modification time.

Example

{
  "account_id" : "...",
  "currency_id" : "...",
  "id" : "...",
  "type" : "request_receive",
  "amount" : "123.4",
  "counterparty_id" : "...",
  "status" : "succeeded",
  "reason" : "...",
  "creation_time" : 12345,
  "modification_time" : 12345
}


Home/Data Types/TransferType

Type of internal transfer.


Values

value description
send Send transfer.
receive Receive transfer.
request_send Sent request for transfer.
request_receive Received request for transfer.


Home/Data Types/UserIdentifier

Field that is used for user identification.


Values

value description
user_id User is identified by base64(UserId).
external_id User is identified by ExternalId.
username User is identified by Username.


Home/Data Types/UserSettingsDto

Class that defines user settings returned by the API.


Properties

name data type description
client_user_id string Client-specific user identifier. Can be absent.
username string User’s name. This is the name the user used during registration.
measurement_currencies array of string List of currencyId in which account statistics can be calculated for the user.
trading_statistics_currency string CurrencyId of trading statistics for user.
login_2fa_enabled bool Is 2FA for user login enabled.
login_2fa_mandatory bool Is 2FA for user login mandatory. Can only be true if login 2FA is enabled.
withdrawal_2fa_enabled bool Is 2FA for user withdrawal transfers enabled.
withdrawal_2fa_mandatory bool Is 2FA for user withdrawal transfers mandatory. Can only be true if withdrawal 2FA is enabled.
basic_advanced_switcher_enabled bool Is switcher between basic and advanced view enabled.
password_for_user_settings_change_required bool Is password confirmation required for changing user settings.
password_for_api_key_change_required bool Is explicit password confirmation required for creating/deleting API keys. If set to false - password should be verified on auth provider side.
withdrawal_address_validation_required bool Is withdrawal forbidden for non-validated address.
user_identifier UserIdentifier Specifies a field used for identifying users when user transfers are enabled. Optional. When missing, user transfers are disabled.

Properties inherited from EditableUserSettingsDto

name data type description
is_using_2fa_for_login bool Whether user is using two factor authentication for login. This may be missing depending on auth provider.
is_using_2fa_for_withdrawal bool Whether user is using two factor authentication for withdrawals.
is_allow_show_exchange_codes bool Allow showing Exchange codes.

Example

{
  "is_using_2fa_for_login" : true,
  "is_using_2fa_for_withdrawal" : true,
  "is_allow_show_exchange_codes" : false,
  "client_user_id" : "...",
  "username" : "...",
  "measurement_currencies" : [ "...", "..." ],
  "trading_statistics_currency" : "...",
  "login_2fa_enabled" : false,
  "login_2fa_mandatory" : false,
  "withdrawal_2fa_enabled" : true,
  "withdrawal_2fa_mandatory" : true,
  "basic_advanced_switcher_enabled" : true,
  "password_for_user_settings_change_required" : true,
  "password_for_api_key_change_required" : false,
  "withdrawal_address_validation_required" : true,
  "user_identifier" : "username"
}


Home/Data Types/WalletAddressDto

Class that defines a saved wallet address.


Properties

name data type description
address string Wallet address. Required.
network string Wallet network. Optional. Can be missing, if only one currency network is used.
status OperationStatus Wallet address status. Transactions are only allowed for succeeded status. Required.
reason string Human-readable reason for rejecting the address, if present. Optional.

Example

{
  "address" : "...",
  "network" : "...",
  "status" : "approved",
  "reason" : "..."
}


Copyright © 2018 - 2024 Deltix, http://deltixlab.com/.