Data Types

JSON

type description
AccountBaseDto Class that defines user account core fields.
AccountDto Class that defines a user account.
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.
BinaryArray
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.
CurrencyCommissionPlanDto Class that defines a commission plan for deposits and withdrawals.
CurrencyDto Class that defines a currency.
CurrencyLimitsDto Class that contains account's withdrawal and deposit limits for the currency taking into account transactions already performed by the 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.
ExecutionExplanation Type of execution explanation.
ExternalCommissionDto Class that defines an external commission taken by the specified exchange.
GlobalSettingsDto Class that defines global application settings.
HealthStatusDto Class that defines a health status of the application.
HydraGlobalSettingsDto Client's global settings.
HydraUserSettingsDto Class that defines user settings returned by the API.
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.
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.
LoginAttemptDto Class that defines the initial authorization request from the client for API authorization.
LoginConfirmationDto Class that defines a request for login confirmation, executed after a login attempt.
NewOrderDto Represents request for creating or modifying order.
OperationStatus
OrderDto Represents user's order as returned by the API.
OrderEventDto Represents events related to the order like order creation, changing, execution, cancellation etc.
OrderEventType Type of the order event.
OrderStatus Status of the order.
PrimeBrokerAccountDto
ProductType Defines type of settlement.
PropertyDto Key-value pair.
SecurityBarsDto Class that defines security bars.
SecurityCommissionsDto Class that defines security commissions.
SecurityDisplayMethod Security price display method.
SecurityDto Class that defines a security with the user-specific settings.
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.
SessionStatus Trading session status.
Side Side of the order.
SuccessfulLoginAttemptDto Class that defines a response for the initial authorization request from the client for API authorization.
SuccessfulLoginConfirmationDto Class that defines a response to the login confirmation request.
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.
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.