models

type API bool

type AddressBookItem struct {

	// address
	// Required: true
	Address CurrencyAddress `json:"address"`

	// creation timestamp
	// Required: true
	CreationTimestamp Timestamp `json:"creation_timestamp"`

	// currency
	// Required: true
	Currency Currency `json:"currency"`

	// type
	Type AddressBookType `json:"type,omitempty"`
}

type AddressBookType string

type Advanced string

type Amount float64

type AnnouncementNotification struct {

	// action
	Action string `json:"action,omitempty"`

	// body
	// Required: true
	Body *string `json:"body"`

	// milliseconds since the Unix epoch
	// Required: true
	Date *int64 `json:"date"`

	// id
	// Required: true
	ID *int64 `json:"id"`

	// important
	// Required: true
	Important *bool `json:"important"`

	// number
	Number int64 `json:"number,omitempty"`

	// title
	// Required: true
	Title *string `json:"title"`
}

type AskIv float64

type Asks []string

type AveragePrice float64

type BaseMessage struct {

	// The id that was sent in the request
	ID int64 `json:"id,omitempty"`

	// The JSON-RPC version (2.0)
	// Required: true
	// Enum: [2.0]
	Jsonrpc *string `json:"jsonrpc"`

	// false for production server, true for test server
	// Required: true
	Testnet *bool `json:"testnet"`

	// Duration of the handling of the request, in microseconds
	// Required: true
	UsDiff *int64 `json:"usDiff"`

	// The timestamp (in microseconds) of receipt of the request
	// Required: true
	UsIn *int64 `json:"usIn"`

	// The timestamp (in microseconds) of sending of the response
	// Required: true
	UsOut *int64 `json:"usOut"`
}

type BestAskAmount float64

type BestAskPrice float64

type BestBidAmount float64

type BestBidPrice float64

type BidIv float64

type Bids []string

type BookEntry struct {

	// amount
	// Required: true
	Amount Amount `json:"amount"`

	// cumulative amount
	// Required: true
	CumulativeAmount CumulativeAmount `json:"cumulative_amount"`

	// cumulative quantity
	// Required: true
	CumulativeQuantity CumulativeQuantity `json:"cumulative_quantity"`

	// price
	// Required: true
	Price Price `json:"price"`

	// quantity
	// Required: true
	Quantity Quantity `json:"quantity"`
}

type BookNotification struct {

	// asks
	// Required: true
	Asks [][]float64 `json:"asks"`

	// bids
	// Required: true
	Bids [][]float64 `json:"bids"`

	// id of the notification
	// Required: true
	ChangeID *int64 `json:"change_id"`

	// instrument name
	// Required: true
	InstrumentName InstrumentName `json:"instrument_name"`

	// timestamp
	Timestamp TimestampForBookNotifications `json:"timestamp,omitempty"`
}

type BookNotificationRaw struct {

	// asks
	// Required: true
	Asks [][]float64 `json:"asks"`

	// bids
	// Required: true
	Bids [][]float64 `json:"bids"`

	// id of the notification
	// Required: true
	ChangeID *int64 `json:"change_id"`

	// instrument name
	// Required: true
	InstrumentName InstrumentName `json:"instrument_name"`

	// id of the previous notification
	PrevChangeID int64 `json:"prev_change_id,omitempty"`

	// timestamp
	Timestamp TimestampForBookNotifications `json:"timestamp,omitempty"`
}

type BookState string

type BookSummary struct {

	// The current best ask price, `null` if there aren't any asks
	// Required: true
	AskPrice *float64 `json:"ask_price"`

	// Base currency
	// Required: true
	BaseCurrency *string `json:"base_currency"`

	// The current best bid price, `null` if there aren't any bids
	// Required: true
	BidPrice *float64 `json:"bid_price"`

	// creation timestamp
	// Required: true
	CreationTimestamp Timestamp `json:"creation_timestamp"`

	// Current funding (perpetual only)
	CurrentFunding float64 `json:"current_funding,omitempty"`

	// Estimated delivery price, in USD (futures only). For more details, see Documentation > General > Expiration Price
	EstimatedDeliveryPrice float64 `json:"estimated_delivery_price,omitempty"`

	// Funding 8h (perpetual only)
	Funding8h float64 `json:"funding_8h,omitempty"`

	// Price of the 24h highest trade
	// Required: true
	High *float64 `json:"high"`

	// instrument name
	// Required: true
	InstrumentName InstrumentName `json:"instrument_name"`

	// Interest rate used in implied volatility calculations (options only)
	InterestRate float64 `json:"interest_rate,omitempty"`

	// The price of the latest trade, `null` if there weren't any trades
	// Required: true
	Last *float64 `json:"last"`

	// Price of the 24h lowest trade, `null` if there weren't any trades
	// Required: true
	Low *float64 `json:"low"`

	// The current instrument market price
	// Required: true
	MarkPrice *float64 `json:"mark_price"`

	// The average of the best bid and ask, `null` if there aren't any asks or bids
	// Required: true
	MidPrice *float64 `json:"mid_price"`

	// The total amount of outstanding contracts in the corresponding amount units. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH.
	// Required: true
	OpenInterest *float64 `json:"open_interest"`

	// Quote currency
	// Required: true
	QuoteCurrency *string `json:"quote_currency"`

	// Name of the underlying future, or `'index_price'` (options only)
	UnderlyingIndex string `json:"underlying_index,omitempty"`

	// underlying price for implied volatility calculations (options only)
	UnderlyingPrice float64 `json:"underlying_price,omitempty"`

	// The total 24h traded volume (in base currency)
	// Required: true
	Volume *float64 `json:"volume"`

	// Volume in usd (futures only)
	VolumeUsd float64 `json:"volume_usd,omitempty"`
}

type Commission float64

type Continuation string

type ContractSize float64

type CumulativeAmount float64

type CumulativeQuantity float64

type Currency string

type CurrencyAddress string

type CurrencyAmount float64

type CurrencyPortfolio struct {

	// available funds
	// Required: true
	AvailableFunds *float64 `json:"available_funds"`

	// available withdrawal funds
	// Required: true
	AvailableWithdrawalFunds *float64 `json:"available_withdrawal_funds"`

	// balance
	// Required: true
	Balance *float64 `json:"balance"`

	// currency
	// Required: true
	// Enum: [btc eth]
	Currency *string `json:"currency"`

	// equity
	// Required: true
	Equity *float64 `json:"equity"`

	// initial margin
	// Required: true
	InitialMargin *float64 `json:"initial_margin"`

	// maintenance margin
	// Required: true
	MaintenanceMargin *float64 `json:"maintenance_margin"`

	// margin balance
	// Required: true
	MarginBalance *float64 `json:"margin_balance"`
}

type CurrencyTransactionID string

type CurrencyWithAny string

type CurrentFunding float64

type DeliveryPrice float64

type Deposit struct {

	// address
	// Required: true
	Address CurrencyAddress `json:"address"`

	// amount
	// Required: true
	Amount CurrencyAmount `json:"amount"`

	// currency
	// Required: true
	Currency Currency `json:"currency"`

	// received timestamp
	// Required: true
	ReceivedTimestamp Timestamp `json:"received_timestamp"`

	// state
	// Required: true
	State DepositState `json:"state"`

	// transaction id
	// Required: true
	TransactionID CurrencyTransactionID `json:"transaction_id"`

	// updated timestamp
	// Required: true
	UpdatedTimestamp Timestamp `json:"updated_timestamp"`
}

type DepositState string

type DeribitPriceIndexNotification struct {

	// index name
	// Required: true
	IndexName *string `json:"index_name"`

	// Current value of Deribit Index
	// Required: true
	Price *float64 `json:"price"`

	// timestamp
	// Required: true
	Timestamp Timestamp `json:"timestamp"`
}

type DeribitPriceRankingNotification []*DeribitPriceRankingNotificationItems0

type DeribitPriceRankingNotificationItems0 struct {

	// Stock exchange status
	Enabled bool `json:"enabled,omitempty"`

	// Stock exchange identifier
	Identifier string `json:"identifier,omitempty"`

	// Stock exchange index price
	Price float64 `json:"price,omitempty"`

	// The timestamp of the last update from stock exchange
	Timestamp int64 `json:"timestamp,omitempty"`

	// The weight of the ranking given in percent
	Weight float64 `json:"weight,omitempty"`
}

type Direction string

type ErrorMessage struct {

	// error
	// Required: true
	Error *int64 `json:"error"`

	// message
	// Required: true
	Message *string `json:"message"`
}

type EstimatedExpirationPriceNotification struct {

	// When `true` then prize is given as an estimated value, otherwise it's current index price
	// Required: true
	IsEstimated *bool `json:"is_estimated"`

	// Index current or estimated price
	// Required: true
	Price *float64 `json:"price"`

	// Number of seconds till finalizing the nearest instrument
	// Required: true
	Seconds *int64 `json:"seconds"`
}

type Fee float64

type FilledAmount float64

type FilledQuantity float64

type Funding8h float64

type GetAnnouncementsResponse struct {

	// result
	// Required: true
	Result []*GetAnnouncementsResponseResultItems0 `json:"result"`
}

type GetAnnouncementsResponseResultItems0 struct {

	// The HTML body of the announcement
	// Required: true
	Body *string `json:"body"`

	// A unique identifier for the announcement
	// Required: true
	ID *float64 `json:"id"`

	// Whether the announcement is marked as important
	// Required: true
	Important *bool `json:"important"`

	// The timestamp in ms at which the announcement was published
	// Required: true
	PublicationTime *int64 `json:"publication_time"`

	// The title of the announcement
	// Required: true
	Title *string `json:"title"`
}

type GetTimeResponse struct {

	// Current timestamp (milliseconds)
	// Required: true
	Result *int64 `json:"result"`
}

type Greeks struct {

	// (Only for option) The delta value for the option
	// Required: true
	Delta *float64 `json:"delta"`

	// (Only for option) The gamma value for the option
	// Required: true
	Gamma *float64 `json:"gamma"`

	// (Only for option) The rho value for the option
	// Required: true
	Rho *float64 `json:"rho"`

	// (Only for option) The theta value for the option
	// Required: true
	Theta *float64 `json:"theta"`

	// (Only for option) The vega value for the option
	// Required: true
	Vega *float64 `json:"vega"`
}

type ImpliedVolatility float64

type Implv float64

type IndexPrice float64

type Instrument struct {

	// The underlying currency being traded.
	// Required: true
	// Enum: [BTC ETH]
	BaseCurrency *string `json:"base_currency"`

	// Contract size for instrument
	// Required: true
	ContractSize *float64 `json:"contract_size"`

	// The time when the instrument was first created (milliseconds)
	// Required: true
	CreationTimestamp *int64 `json:"creation_timestamp"`

	// The time when the instrument will expire (milliseconds)
	// Required: true
	ExpirationTimestamp *int64 `json:"expiration_timestamp"`

	// instrument name
	// Required: true
	InstrumentName InstrumentName `json:"instrument_name"`

	// Indicates if the instrument can currently be traded.
	// Required: true
	IsActive *bool `json:"is_active"`

	// kind
	// Required: true
	Kind Kind `json:"kind"`

	// Minimum amount for trading. For perpetual and futures - in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH.
	// Required: true
	MinTradeAmount *float64 `json:"min_trade_amount"`

	// The option type (only for options)
	// Enum: [call put]
	OptionType string `json:"option_type,omitempty"`

	// The currency in which the instrument prices are quoted.
	// Required: true
	// Enum: [USD]
	QuoteCurrency *string `json:"quote_currency"`

	// The settlement period.
	// Required: true
	// Enum: [month week perpetual]
	SettlementPeriod *string `json:"settlement_period"`

	// The strike value. (only for options)
	Strike float64 `json:"strike,omitempty"`

	// specifies minimal price change and, as follows, the number of decimal places for instrument prices
	// Required: true
	TickSize *float64 `json:"tick_size"`
}

type InstrumentName string

type InterestRate float64

type KeyNumberPair struct {

	// name
	// Required: true
	Name *string `json:"name"`

	// value
	// Required: true
	Value *float64 `json:"value"`
}

type Kind string

type KindWithAny string

type Label string

type LastPrice float64

type MarkIv float64

type MarkPrice float64

type MarkPriceInfo struct {

	// instrument name
	InstrumentName string `json:"instrument_name,omitempty"`

	// implied volatility of mark price
	Iv float64 `json:"iv,omitempty"`

	// mark_price of instrument
	MarkPrice float64 `json:"mark_price,omitempty"`
}

type MarkpriceOptionsNotification []*MarkpriceOptionsNotificationItems0

type MarkpriceOptionsNotificationItems0 struct {

	// instrument name
	InstrumentName InstrumentName `json:"instrument_name,omitempty"`

	// iv
	Iv ImpliedVolatility `json:"iv,omitempty"`

	// mark price
	MarkPrice MarkPrice `json:"mark_price,omitempty"`
}

type MatchingID string

type MaxPrice float64

type MaxShow float64

type MinPrice float64

type OkResponse struct {

	// Result of method execution. `ok` in case of success
	// Required: true
	// Enum: [ok]
	Result *string `json:"result"`
}

type OpenInterest float64

type Order struct {

	// advanced
	Advanced Advanced `json:"advanced,omitempty"`

	// amount
	Amount Amount `json:"amount,omitempty"`

	// api
	// Required: true
	API API `json:"api"`

	// average price
	AveragePrice AveragePrice `json:"average_price,omitempty"`

	// commission
	Commission Commission `json:"commission,omitempty"`

	// creation timestamp
	// Required: true
	CreationTimestamp Timestamp `json:"creation_timestamp"`

	// direction
	// Required: true
	Direction Direction `json:"direction"`

	// filled amount
	FilledAmount FilledAmount `json:"filled_amount,omitempty"`

	// implv
	Implv Implv `json:"implv,omitempty"`

	// instrument name
	// Required: true
	InstrumentName InstrumentName `json:"instrument_name"`

	// `true` if order was automatically created during liquidation
	// Required: true
	IsLiquidation *bool `json:"is_liquidation"`

	// label
	// Required: true
	Label Label `json:"label"`

	// last update timestamp
	// Required: true
	LastUpdateTimestamp Timestamp `json:"last_update_timestamp"`

	// max show
	// Required: true
	MaxShow MaxShow `json:"max_show"`

	// order id
	// Required: true
	OrderID OrderID `json:"order_id"`

	// order state
	// Required: true
	OrderState OrderState `json:"order_state"`

	// order type
	// Required: true
	OrderType OrderType `json:"order_type"`

	// post only
	// Required: true
	PostOnly PostOnly `json:"post_only"`

	// price
	// Required: true
	Price Price `json:"price"`

	// profit loss
	ProfitLoss ProfitLoss `json:"profit_loss,omitempty"`

	// reduce only
	ReduceOnly ReduceOnly `json:"reduce_only,omitempty"`

	// stop price
	StopPrice StopPrice `json:"stop_price,omitempty"`

	// time in force
	// Required: true
	TimeInForce TimeInForce `json:"time_in_force"`

	// trigger
	Trigger Trigger `json:"trigger,omitempty"`

	// triggered
	Triggered Triggered `json:"triggered,omitempty"`

	// usd
	Usd Usd `json:"usd,omitempty"`
}

type OrderID string

type OrderIDInitialMarginPair struct {

	// Initial margin of order, in base currency
	// Required: true
	InitialMargin *float64 `json:"initial_margin"`

	// order id
	// Required: true
	OrderID OrderID `json:"order_id"`
}

type OrderState string

type OrderStateInUserTrade string

type OrderType string

type OrderType2 string

type OrderV1 struct {

	// advanced
	Advanced Advanced `json:"advanced,omitempty"`

	// api
	// Required: true
	API API `json:"api"`

	// average price
	AveragePrice AveragePrice `json:"average_price,omitempty"`

	// commission
	Commission Commission `json:"commission,omitempty"`

	// created
	// Required: true
	Created Timestamp `json:"created"`

	// direction
	// Required: true
	Direction Direction `json:"direction"`

	// filled quantity
	FilledQuantity FilledQuantity `json:"filled_quantity,omitempty"`

	// implv
	Implv Implv `json:"implv,omitempty"`

	// instrument
	// Required: true
	Instrument *string `json:"instrument"`

	// label
	// Required: true
	Label Label `json:"label"`

	// last update
	// Required: true
	LastUpdate Timestamp `json:"last_update"`

	// max show
	// Required: true
	MaxShow MaxShow `json:"max_show"`

	// order id
	// Required: true
	OrderID OrderID `json:"order_id"`

	// order state
	// Required: true
	OrderState OrderState `json:"order_state"`

	// order type
	// Required: true
	OrderType OrderType `json:"order_type"`

	// post only
	// Required: true
	PostOnly PostOnly `json:"post_only"`

	// price
	// Required: true
	Price Price `json:"price"`

	// quantity
	Quantity Quantity `json:"quantity,omitempty"`

	// stop price
	StopPrice StopPrice `json:"stop_price,omitempty"`

	// trigger
	Trigger Trigger `json:"trigger,omitempty"`

	// triggered
	Triggered Triggered `json:"triggered,omitempty"`

	// usd
	Usd Usd `json:"usd,omitempty"`
}

type PerpetualNotification struct {

	// Current interest
	// Required: true
	Interest *float64 `json:"interest"`
}

type Portfolio struct {

	// btc
	// Required: true
	Btc *CurrencyPortfolio `json:"btc"`

	// eth
	// Required: true
	Eth *CurrencyPortfolio `json:"eth"`
}

type Position struct {

	// Average price of trades that built this position
	// Required: true
	AveragePrice *float64 `json:"average_price"`

	// Only for options, average price in USD
	AveragePriceUsd float64 `json:"average_price_usd,omitempty"`

	// Delta parameter
	// Required: true
	Delta *float64 `json:"delta"`

	// direction
	// Required: true
	Direction Direction `json:"direction"`

	// Only for futures, estimated liquidation price
	EstimatedLiquidationPrice float64 `json:"estimated_liquidation_price,omitempty"`

	// Floating profit or loss
	// Required: true
	FloatingProfitLoss *float64 `json:"floating_profit_loss"`

	// Only for options, floating profit or loss in USD
	FloatingProfitLossUsd float64 `json:"floating_profit_loss_usd,omitempty"`

	// Current index price
	// Required: true
	IndexPrice *float64 `json:"index_price"`

	// Initial margin
	// Required: true
	InitialMargin *float64 `json:"initial_margin"`

	// instrument name
	// Required: true
	InstrumentName InstrumentName `json:"instrument_name"`

	// kind
	// Required: true
	Kind Kind `json:"kind"`

	// Maintenance margin
	// Required: true
	MaintenanceMargin *float64 `json:"maintenance_margin"`

	// Current mark price for position's instrument
	// Required: true
	MarkPrice *float64 `json:"mark_price"`

	// Open orders margin
	// Required: true
	OpenOrdersMargin *float64 `json:"open_orders_margin"`

	// Realized profit or loss
	// Required: true
	RealizedProfitLoss *float64 `json:"realized_profit_loss"`

	// Last settlement price for position's instrument 0 if instrument wasn't settled yet
	// Required: true
	SettlementPrice *float64 `json:"settlement_price"`

	// Position size for futures size in quote currency (e.g. USD), for options size is in base currency (e.g. BTC)
	// Required: true
	Size *float64 `json:"size"`

	// Only for futures, position size in base currency
	SizeCurrency float64 `json:"size_currency,omitempty"`

	// Profit or loss from position
	// Required: true
	TotalProfitLoss *float64 `json:"total_profit_loss"`
}

type PostOnly bool

type Price float64

type PrivateAccountResponse struct {

	// result
	// Required: true
	Result *PrivateAccountResponseResult `json:"result"`
}

type PrivateAccountResponseResult struct {

	// The account's available funds
	// Required: true
	AvailableFunds *float64 `json:"available_funds"`

	// The account's available to withdrawal funds
	// Required: true
	AvailableWithdrawalFunds *float64 `json:"available_withdrawal_funds"`

	// The account's balance
	// Required: true
	Balance *float64 `json:"balance"`

	// The selected currency
	// Required: true
	Currency *string `json:"currency"`

	// The sum of position deltas
	// Required: true
	DeltaTotal *float64 `json:"delta_total"`

	// The deposit address for the account (if available)
	DepositAddress string `json:"deposit_address,omitempty"`

	// User email (available when parameter `extended` = `true`)
	// Required: true
	Email *string `json:"email"`

	// The account's current equity
	// Required: true
	Equity *float64 `json:"equity"`

	// Futures profit and Loss
	// Required: true
	FuturesPl *float64 `json:"futures_pl"`

	// Futures session realized profit and Loss
	// Required: true
	FuturesSessionRpl *float64 `json:"futures_session_rpl"`

	// Futures session unrealized profit and Loss
	// Required: true
	FuturesSessionUpl *float64 `json:"futures_session_upl"`

	// Account id (available when parameter `extended` = `true`)
	// Required: true
	ID *int64 `json:"id"`

	// The account's initial margin
	// Required: true
	InitialMargin *float64 `json:"initial_margin"`

	// The maintenance margin.
	// Required: true
	MaintenanceMargin *float64 `json:"maintenance_margin"`

	// The account's margin balance
	MarginBalance float64 `json:"margin_balance,omitempty"`

	// Options summary delta
	// Required: true
	OptionsDelta *float64 `json:"options_delta"`

	// Options summary gamma
	// Required: true
	OptionsGamma *float64 `json:"options_gamma"`

	// Options profit and Loss
	// Required: true
	OptionsPl *float64 `json:"options_pl"`

	// Options session realized profit and Loss
	// Required: true
	OptionsSessionRpl *float64 `json:"options_session_rpl"`

	// Options session unrealized profit and Loss
	// Required: true
	OptionsSessionUpl *float64 `json:"options_session_upl"`

	// Options summary theta
	// Required: true
	OptionsTheta *float64 `json:"options_theta"`

	// Options summary vega
	// Required: true
	OptionsVega *float64 `json:"options_vega"`

	// `true` when portfolio margining is enabled for user
	PortfolioMarginingEnabled bool `json:"portfolio_margining_enabled,omitempty"`

	// Projected initial margin (for portfolio margining users)
	ProjectedInitialMargin float64 `json:"projected_initial_margin,omitempty"`

	// Projected maintenance margin (for portfolio margining users)
	ProjectedMaintenanceMargin float64 `json:"projected_maintenance_margin,omitempty"`

	// Session funding
	// Required: true
	SessionFunding *float64 `json:"session_funding"`

	// Session realized profit and loss
	// Required: true
	SessionRpl *float64 `json:"session_rpl"`

	// Session unrealized profit and loss
	// Required: true
	SessionUpl *float64 `json:"session_upl"`

	// System generated user nickname (available when parameter `extended` = `true`)
	// Required: true
	SystemName *string `json:"system_name"`

	// Whether two factor authentication is enabled (available when parameter `extended` = `true`)
	// Required: true
	TfaEnabled *bool `json:"tfa_enabled"`

	// Profit and loss
	// Required: true
	TotalPl *float64 `json:"total_pl"`

	// Account type (available when parameter `extended` = `true`)
	// Required: true
	// Enum: [main subaccount]
	Type *string `json:"type"`

	// Account name (given by user) (available when parameter `extended` = `true`)
	// Required: true
	Username *string `json:"username"`
}

type PrivateAddToAddressBookResponse struct {

	// result
	// Required: true
	Result *AddressBookItem `json:"result"`
}

type PrivateAddressBookResponse struct {

	// result
	// Required: true
	Result []*AddressBookItem `json:"result"`
}

type PrivateBuyAndSellResponse struct {

	// result
	// Required: true
	Result *PrivateBuyAndSellResponseResult `json:"result"`
}

type PrivateBuyAndSellResponseResult struct {

	// order
	// Required: true
	Order *Order `json:"order"`

	// trades
	// Required: true
	Trades []*UserTrade `json:"trades"`
}

type PrivateCancelResponse struct {

	// result
	// Required: true
	Result *Order `json:"result"`
}

type PrivateCreateSubaccountResponse struct {

	// result
	// Required: true
	Result *PrivateCreateSubaccountResponseResult `json:"result"`
}

type PrivateCreateSubaccountResponseResult struct {

	// User email
	// Required: true
	Email *string `json:"email"`

	// Subaccount identifier
	// Required: true
	ID *int64 `json:"id"`

	// `true` when password for the subaccount has been configured
	// Required: true
	IsPassword *bool `json:"is_password"`

	// Informs whether login to the subaccount is enabled
	// Required: true
	LoginEnabled *bool `json:"login_enabled"`

	// portfolio
	Portfolio *Portfolio `json:"portfolio,omitempty"`

	// When `true` - receive all notification emails on the main email
	// Required: true
	ReceiveNotifications *bool `json:"receive_notifications"`

	// System generated user nickname
	// Required: true
	SystemName *string `json:"system_name"`

	// Whether the two factor authentication is enabled
	// Required: true
	TfaEnabled *bool `json:"tfa_enabled"`

	// Account type
	// Required: true
	// Enum: [subaccount]
	Type *string `json:"type"`

	// Account name (given by user)
	// Required: true
	Username *string `json:"username"`
}

type PrivateDepositAddressResponse struct {

	// result
	// Required: true
	Result *PrivateDepositAddressResponseResult `json:"result"`
}

type PrivateDepositAddressResponseResult struct {

	// address
	// Required: true
	Address CurrencyAddress `json:"address"`

	// creation timestamp
	// Required: true
	CreationTimestamp Timestamp `json:"creation_timestamp"`

	// currency
	// Required: true
	Currency Currency `json:"currency"`

	// type
	// Required: true
	Type WalletAddressType `json:"type"`
}

type PrivateEditResponse struct {

	// result
	// Required: true
	Result *PrivateEditResponseResult `json:"result"`
}

type PrivateEditResponseResult struct {

	// order
	// Required: true
	Order *Order `json:"order"`

	// trades
	// Required: true
	Trades []*UserTrade `json:"trades"`
}

type PrivateGetDepositsResponse struct {

	// result
	// Required: true
	Result *PrivateGetDepositsResponseResult `json:"result"`
}

type PrivateGetDepositsResponseResult struct {

	// count
	// Required: true
	Count ResultCount `json:"count"`

	// data
	// Required: true
	Data []*Deposit `json:"data"`
}

type PrivateGetEmailLanguageResponse struct {

	// The abbreviation of the language
	// Required: true
	Result *string `json:"result"`
}

type PrivateGetMarginsResponse struct {

	// result
	// Required: true
	Result *PrivateGetMarginsResponseResult `json:"result"`
}

type PrivateGetMarginsResponseResult struct {

	// Margin when buying
	// Required: true
	Buy *float64 `json:"buy"`

	// max price
	// Required: true
	MaxPrice MaxPrice `json:"max_price"`

	// min price
	// Required: true
	MinPrice MinPrice `json:"min_price"`

	// Margin when selling
	// Required: true
	Sell *float64 `json:"sell"`
}

type PrivateGetOpenOrdersResponse struct {

	// result
	// Required: true
	Result []*Order `json:"result"`
}

type PrivateGetOrderHistoryResponse struct {

	// result
	// Required: true
	Result []*Order `json:"result"`
}

type PrivateGetOrderMarginByIdsResponse struct {

	// result
	// Required: true
	Result []*OrderIDInitialMarginPair `json:"result"`
}

type PrivateGetOrderStateResponse struct {

	// result
	// Required: true
	Result *Order `json:"result"`
}

type PrivateGetPositionResponse struct {

	// result
	// Required: true
	Result *Position `json:"result"`
}

type PrivateGetPositionsResponse struct {

	// result
	// Required: true
	Result []*Position `json:"result"`
}

type PrivateGetSubaccountsResponse struct {

	// result
	// Required: true
	Result []*PrivateGetSubaccountsResponseResultItems0 `json:"result"`
}

type PrivateGetSubaccountsResponseResultItems0 struct {

	// User email
	// Required: true
	Email *string `json:"email"`

	// Account/Subaccount identifier
	// Required: true
	ID *int64 `json:"id"`

	// `true` when password for the subaccount has been configured
	// Required: true
	IsPassword *bool `json:"is_password"`

	// Informs whether login to the subaccount is enabled
	LoginEnabled bool `json:"login_enabled,omitempty"`

	// New email address that has not yet been confirmed. This field is only included if `with_portfolio` == `true`.
	NotConfirmedEmail string `json:"not_confirmed_email,omitempty"`

	// Only if with_portfolio == true
	Portfolio *Portfolio `json:"portfolio,omitempty"`

	// When `true` - receive all notification emails on the main email
	// Required: true
	ReceiveNotifications *bool `json:"receive_notifications"`

	// System generated user nickname
	// Required: true
	SystemName *string `json:"system_name"`

	// Whether the two factor authentication is enabled
	// Required: true
	TfaEnabled *bool `json:"tfa_enabled"`

	// type
	// Required: true
	// Enum: [main subaccount]
	Type *string `json:"type"`

	// username
	// Required: true
	Username *string `json:"username"`
}

type PrivateGetTransfersResponse struct {

	// result
	// Required: true
	Result *PrivateGetTransfersResponseResult `json:"result"`
}

type PrivateGetTransfersResponseResult struct {

	// count
	// Required: true
	Count ResultCount `json:"count"`

	// data
	// Required: true
	Data []*TransferItem `json:"data"`
}

type PrivateGetWithdrawalsResponse struct {

	// result
	// Required: true
	Result *PrivateGetWithdrawalsResponseResult `json:"result"`
}

type PrivateGetWithdrawalsResponseResult struct {

	// count
	// Required: true
	Count ResultCount `json:"count"`

	// data
	// Required: true
	Data []*Withdrawal `json:"data"`
}

type PrivateGetopenordersResponse struct {

	// result
	// Required: true
	Result *PrivateGetopenordersResponseResult `json:"result"`
}

type PrivateGetopenordersResponseResult struct {

	// advanced type (`false`, or `usd` or `implv`)
	// Required: true
	Adv *bool `json:"adv"`

	// true - created with API
	// Required: true
	API *bool `json:"api"`

	// average fill price of the order
	// Required: true
	AvgPrice *float64 `json:"avgPrice"`

	// Commission paid so far (in BTC)
	// Required: true
	Commission *float64 `json:"commission"`

	// The timestamp (in ms) that the order was created
	// Required: true
	Created *int64 `json:"created"`

	// direction, `"buy"` or `"sell"`
	// Required: true
	Direction *string `json:"direction"`

	// Defines trigger type, required for stop limit orders, possible values `"index_price"`, `"mark_price"`  (Only valid for stop orders)
	// Required: true
	ExecInst *string `json:"execInst"`

	// The number of contracts already filled
	// Required: true
	FilledQuantity *float64 `json:"filledQuantity"`

	// Option implied volatility in percent. (Only when `adv=implv`)
	// Required: true
	Implv *float64 `json:"implv"`

	// instrument name of the order
	// Required: true
	Instrument *string `json:"instrument"`

	// user defined label (up to 32 characters)
	// Required: true
	Label *string `json:"label"`

	// The timestamp (in ms) that the order was last updated
	// Required: true
	LastUpdate *int64 `json:"lastUpdate"`

	// Maximum quantity within an order to be shown to other customers, 0 for invisible order.
	// Required: true
	MaxShow *float64 `json:"max_show"`

	// id of the order
	// Required: true
	OrderID *float64 `json:"orderId"`

	// `true` for post-only orders only
	// Required: true
	PostOnly *bool `json:"postOnly"`

	// price
	// Required: true
	Price *float64 `json:"price"`

	// The number of contracts to be traded
	// Required: true
	Quantity *float64 `json:"quantity"`

	// order state
	// Required: true
	State *string `json:"state"`

	// stop price (Only for future stop orders)
	// Required: true
	StopPx *float64 `json:"stopPx"`

	// Whether the stop order has been triggered (Only for future stop orders)
	// Required: true
	Triggered *bool `json:"triggered"`

	// order type, `"limit"`,` "market"`, `"stop_limit"`
	// Required: true
	Type *string `json:"type"`

	// Option price in USD (Only if `adv=usd`)
	// Required: true
	Usd *float64 `json:"usd"`
}

type PrivateOrderhistoryResponse struct {

	// result
	// Required: true
	Result *PrivateOrderhistoryResponseResult `json:"result"`
}

type PrivateOrderhistoryResponseResult struct {

	// advanced type (`false`, or `"usd"` or `"implv"`)
	// Required: true
	Adv *bool `json:"adv"`

	// true - created with API
	// Required: true
	API *bool `json:"api"`

	// average fill price of the order
	// Required: true
	AvgPrice *float64 `json:"avgPrice"`

	// Commission paid so far (in BTC)
	// Required: true
	Commission *float64 `json:"commission"`

	// The timestamp (in ms) that the order was created
	// Required: true
	Created *int64 `json:"created"`

	// direction, `"buy"` or `"sell"`
	// Required: true
	Direction *string `json:"direction"`

	// Defines trigger type, required for stop limit orders, possible values `"index_price"`, `"mark_price"`  (Only valid for stop orders)
	// Required: true
	ExecInst *string `json:"execInst"`

	// The number of contracts already filled
	// Required: true
	FilledQuantity *float64 `json:"filledQuantity"`

	// Option implied volatility in percent. (Only when `adv=implv`)
	// Required: true
	Implv *float64 `json:"implv"`

	// instrument name of the order
	// Required: true
	Instrument *string `json:"instrument"`

	// user defined label (up to 32 characters)
	// Required: true
	Label *string `json:"label"`

	// The timestamp (in ms) that the order was last updated
	// Required: true
	LastUpdate *int64 `json:"lastUpdate"`

	// Maximum quantity within an order to be shown to other customers, 0 for invisible order.
	// Required: true
	MaxShow *float64 `json:"max_show"`

	// id of the order
	// Required: true
	OrderID *float64 `json:"orderId"`

	// true for post-only orders only
	// Required: true
	PostOnly *bool `json:"postOnly"`

	// price
	// Required: true
	Price *float64 `json:"price"`

	// The number of contracts to be traded
	// Required: true
	Quantity *float64 `json:"quantity"`

	// order state
	// Required: true
	State *string `json:"state"`

	// stop price (Only for future stop orders)
	// Required: true
	StopPx *float64 `json:"stopPx"`

	// Whether the stop order has been triggered (Only for future stop orders)
	// Required: true
	Triggered *bool `json:"triggered"`

	// order type, `"limit"`, `"market"`, `"stop_limit"`
	// Required: true
	Type *string `json:"type"`

	// Option price in USD (Only if `adv=usd`)
	// Required: true
	Usd *float64 `json:"usd"`
}

type PrivateOrderstateResponse struct {

	// result
	// Required: true
	Result *PrivateOrderstateResponseResult `json:"result"`
}

type PrivateOrderstateResponseResult struct {

	// advanced type (`false`, or `"usd"` or `"implv"`)
	// Required: true
	Adv *bool `json:"adv"`

	// true - created with API
	// Required: true
	API *bool `json:"api"`

	// average fill price of the order
	// Required: true
	AvgPrice *float64 `json:"avgPrice"`

	// Commission paid so far (in BTC)
	// Required: true
	Commission *float64 `json:"commission"`

	// The timestamp (in ms) that the order was created
	// Required: true
	Created *int64 `json:"created"`

	// direction, "buy" or "sell"
	// Required: true
	Direction *string `json:"direction"`

	// Defines trigger type, required for stop limit orders, possible values `"index_price"`, `"mark_price"`  (Only valid for stop orders)
	// Required: true
	ExecInst *string `json:"execInst"`

	// The number of contracts already filled
	// Required: true
	FilledQuantity *float64 `json:"filledQuantity"`

	// Option implied volatility in percent. (Only when `adv=implv`)
	// Required: true
	Implv *float64 `json:"implv"`

	// instrument name of the order
	// Required: true
	Instrument *string `json:"instrument"`

	// user defined label (up to 32 characters)
	// Required: true
	Label *string `json:"label"`

	// The timestamp (in ms) that the order was last updated
	// Required: true
	LastUpdate *int64 `json:"lastUpdate"`

	// Maximum quantity within an order to be shown to other customers, 0 for invisible order.
	// Required: true
	MaxShow *float64 `json:"max_show"`

	// id of the order
	// Required: true
	OrderID *float64 `json:"orderId"`

	// true for post-only orders only
	// Required: true
	PostOnly *bool `json:"postOnly"`

	// price
	// Required: true
	Price *float64 `json:"price"`

	// The number of contracts to be traded
	// Required: true
	Quantity *float64 `json:"quantity"`

	// order state
	// Required: true
	State *string `json:"state"`

	// stop price (Only for future stop orders)
	// Required: true
	StopPx *float64 `json:"stopPx"`

	// Whether the stop order has been triggered (Only for future stop orders)
	// Required: true
	Triggered *bool `json:"triggered"`

	// order type, `"limit"`, `"market"`, `"stop_limit"`
	// Required: true
	Type *string `json:"type"`

	// Option price in USD (Only if `adv=usd`)
	// Required: true
	Usd *float64 `json:"usd"`
}

type PrivatePositionsResponse struct {

	// result
	// Required: true
	Result *PrivatePositionsResponseResult `json:"result"`
}

type PrivatePositionsResponseResult struct {

	// average price for the position
	// Required: true
	AveragePrice *float64 `json:"averagePrice"`

	// The base currency of the instrument
	// Required: true
	Currency *string `json:"currency"`

	// The position delta
	// Required: true
	Delta *float64 `json:"delta"`

	// The direction of the position. Can be "buy" (long) or "sell" (short)
	// Required: true
	Direction *string `json:"direction"`

	// Estimated liquidation price
	// Required: true
	EstLiqPrice *float64 `json:"estLiqPrice"`

	// floating PnL
	// Required: true
	FloatingPl *float64 `json:"floatingPl"`

	// index price
	// Required: true
	IndexPrice *float64 `json:"indexPrice"`

	// initial margin
	// Required: true
	InitialMargin *float64 `json:"initialMargin"`

	// name of the instrument
	// Required: true
	Instrument *string `json:"instrument"`

	// The type of instrument. "future" or "option"
	// Required: true
	Kind *string `json:"kind"`

	// maintenance margin
	// Required: true
	MaintenanceMargin *float64 `json:"maintenanceMargin"`

	// mark price
	// Required: true
	MarkPrice *float64 `json:"markPrice"`

	// The margin used to back the position
	// Required: true
	OpenOrderMargin *float64 `json:"openOrderMargin"`

	// The PnL for the position
	// Required: true
	ProfitLoss *float64 `json:"profitLoss"`

	// realized PnL
	// Required: true
	RealizedPl *float64 `json:"realizedPl"`

	// The settlement price for the instrument
	// Required: true
	SettlementPrice *float64 `json:"settlementPrice"`

	// The position size in contracts. Can be negative (short) or positive (long)
	// Required: true
	Size *float64 `json:"size"`

	// position size in BTC (0 if currency <>`BTC`)
	// Required: true
	SizeBtc *float64 `json:"sizeBtc"`

	// position size in the base currency for the instrument
	// Required: true
	SizeCurrency *float64 `json:"sizeCurrency"`
}

type PrivateRemoveFromAddressBookResponse struct {

	// ok
	// Required: true
	Result *string `json:"result"`
}

type PrivateSettlementResponse struct {

	// result
	// Required: true
	Result []string `json:"result"`
}

type PrivateSettlementhistoryResponse struct {

	// result
	// Required: true
	Result *PrivateSettlementhistoryResponseResult `json:"result"`
}

type PrivateSettlementhistoryResponseResult struct {

	// Funded amount (bankruptcy only)
	// Required: true
	Funded *string `json:"funded"`

	// Underlying index price at time of event (settlement and delivery only)
	// Required: true
	IndexPrice *float64 `json:"indexPrice"`

	// instrument name (settlement and delivery only)
	// Required: true
	Instrument *string `json:"instrument"`

	// Mark price for at the time  (settlement and delivery only)
	// Required: true
	MarkPrice *float64 `json:"markPrice"`

	// position size  (settlement and delivery only)
	// Required: true
	Position *string `json:"position"`

	// profit and loss (settlement and delivery only)
	// Required: true
	ProfitLoss *float64 `json:"profitLoss"`

	// in BTC
	// Required: true
	SessionBankrupcy *float64 `json:"sessionBankrupcy"`

	// session profit loss
	// Required: true
	SessionProfitLoss *string `json:"sessionProfitLoss"`

	// in BTC
	// Required: true
	SessionTax *float64 `json:"sessionTax"`

	// in BTC
	// Required: true
	SessionTaxRate *float64 `json:"sessionTaxRate"`

	// The amount of the losses socialized
	// Required: true
	Socialized *float64 `json:"socialized"`

	// The timestamp of the settlement
	// Required: true
	TimeStamp *int64 `json:"timeStamp"`

	// type
	// Required: true
	Type SettlementType `json:"type"`
}