Documentation
¶
Index ¶
- Constants
- type AccountSummary
- type Announcement
- type AnnouncementsNotification
- type AuthResponse
- type BookSummary
- type BuyParams
- type BuyResponse
- type CancelAllByCurrencyParams
- type CancelAllByInstrumentParams
- type CancelAllByLabelParams
- type CancelParams
- type CancelTransferByIDParams
- type CancelWithdrawalParams
- type ChangeSubaccountNameParams
- type ClientCredentialsParams
- type ClosePositionParams
- type ClosePositionResponse
- type CreateDepositAddressParams
- type Currency
- type Deposit
- type DepositAddress
- type DeribitPriceIndexNotification
- type DeribitPriceRanking
- type DeribitPriceRankingNotification
- type DisableTfaForSubaccountParams
- type EditByLabelParams
- type EditParams
- type EditResponse
- type EstimatedExpirationPriceNotification
- type FundingChartData
- type GetAccountSummaryParams
- type GetBookSummaryByCurrencyParams
- type GetBookSummaryByInstrumentParams
- type GetContractSizeParams
- type GetContractSizeResponse
- type GetCurrentDepositAddressParams
- type GetDepositsParams
- type GetDepositsResponse
- type GetFundingChartDataParams
- type GetFundingChartDataResponse
- type GetHistoricalVolatilityParams
- type GetHistoricalVolatilityResponse
- type GetIndexParams
- type GetIndexResponse
- type GetInstrumentsParams
- type GetLastSettlementsByCurrencyParams
- type GetLastSettlementsByInstrumentParams
- type GetLastSettlementsResponse
- type GetLastTradesByCurrencyAndTimeParams
- type GetLastTradesByCurrencyParams
- type GetLastTradesByInstrumentAndTimeParams
- type GetLastTradesByInstrumentParams
- type GetLastTradesResponse
- type GetMarginsParams
- type GetMarginsResponse
- type GetOpenOrdersByCurrencyParams
- type GetOpenOrdersByInstrumentParams
- type GetOrderBookParams
- type GetOrderBookResponse
- type GetOrderHistoryByCurrencyParams
- type GetOrderHistoryByInstrumentParams
- type GetOrderMarginByIDsParams
- type GetOrderMarginByIDsResponse
- type GetOrderStateParams
- type GetPositionParams
- type GetPositionsParams
- type GetSettlementHistoryByCurrencyParams
- type GetSettlementHistoryByInstrumentParams
- type GetSettlementHistoryResponse
- type GetSubaccountsParams
- type GetTradeVolumesParams
- type GetTradeVolumesResponse
- type GetTradingviewChartDataParams
- type GetTradingviewChartDataResponse
- type GetTransfersParams
- type GetTransfersResponse
- type GetUserTradesByCurrencyAndTimeParams
- type GetUserTradesByCurrencyParams
- type GetUserTradesByInstrumentAndTimeParams
- type GetUserTradesByInstrumentParams
- type GetUserTradesByOrderParams
- type GetUserTradesResponse
- type GetWithdrawalsParams
- type Greeks
- type HelloParams
- type HelloResponse
- type HistoricalVolatility
- type Instrument
- type MarkpriceOption
- type MarkpriceOptionsNotification
- type Order
- type OrderBookGroupNotification
- type OrderBookNotification
- type OrderBookNotificationItem
- type OrderBookRawNotification
- type OrderMargin
- type PerpetualNotification
- type Portfolio
- type PortfolioNotification
- type Position
- type QuoteNotification
- type SellParams
- type SellResponse
- type SessionParams
- type SetAnnouncementAsReadParams
- type SetEmailForSubaccountParams
- type SetEmailLanguageParams
- type SetHeartbeatParams
- type SetPasswordForSubaccountParams
- type Settlement
- type Stats
- type Subaccount
- type SubscribeParams
- type SubscribeResponse
- type TestResponse
- type TickerNotification
- type TickerParams
- type TickerResponse
- type ToggleNotificationsFromSubaccountParams
- type ToggleSubaccountLoginParams
- type Trade
- type TradeVolume
- type TradesNotification
- type Transfer
- type UnsubscribeParams
- type UnsubscribeResponse
- type UserChangesNotification
- type UserOrderNotification
- type UserTrade
- type UserTradesNotification
- type WithdrawParams
- type Withdrawal
- type WithdrawalPriority
Constants ¶
View Source
const ( DirectionBuy = "buy" DirectionSell = "sell" )
Direction direction, `buy` or `sell`
View Source
const ( OrderStateOpen = "open" OrderStateFilled = "filled" OrderStateRejected = "rejected" OrderStateCancelled = "cancelled" OrderStateUntriggered = "untriggered" )
OrderState order state, `"open"`, `"filled"`, `"rejected"`, `"cancelled"`, `"untriggered"`
View Source
const ( OrderTypeLimit = "limit" OrderTypeMarket = "market" OrderTypeStopLimit = "stop_limit" OrderTypeStopMarket = "stop_market" )
OrderType order type, `"limit"`, `"market"`, `"stop_limit"`, `"stop_market"`
View Source
const ( TriggerTypeIndexPrice = "index_price" TriggerTypeMarkPrice = "mark_price" TriggerTypeLastPrice = "last_price" )
TriggerType trigger type, `"index_price"`, `"mark_price"`, `"last_price"`
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountSummary ¶
type AccountSummary struct {
AvailableFunds decimal.Decimal `json:"available_funds"`
AvailableWithdrawalFunds decimal.Decimal `json:"available_withdrawal_funds"`
Balance decimal.Decimal `json:"balance"`
Currency string `json:"currency"`
DeltaTotal decimal.Decimal `json:"delta_total"`
DepositAddress string `json:"deposit_address"`
Email string `json:"email"`
Equity decimal.Decimal `json:"equity"`
FuturesPl decimal.Decimal `json:"futures_pl"`
FuturesSessionRpl decimal.Decimal `json:"futures_session_rpl"`
FuturesSessionUpl decimal.Decimal `json:"futures_session_upl"`
ID int `json:"id"`
InitialMargin decimal.Decimal `json:"initial_margin"`
MaintenanceMargin decimal.Decimal `json:"maintenance_margin"`
MarginBalance decimal.Decimal `json:"margin_balance"`
OptionsDelta decimal.Decimal `json:"options_delta"`
OptionsGamma decimal.Decimal `json:"options_gamma"`
OptionsPl decimal.Decimal `json:"options_pl"`
OptionsSessionRpl decimal.Decimal `json:"options_session_rpl"`
OptionsSessionUpl decimal.Decimal `json:"options_session_upl"`
OptionsTheta decimal.Decimal `json:"options_theta"`
OptionsVega decimal.Decimal `json:"options_vega"`
PortfolioMarginingEnabled bool `json:"portfolio_margining_enabled"`
SessionFunding decimal.Decimal `json:"session_funding"`
SessionRpl decimal.Decimal `json:"session_rpl"`
SessionUpl decimal.Decimal `json:"session_upl"`
SystemName string `json:"system_name"`
TfaEnabled bool `json:"tfa_enabled"`
TotalPl decimal.Decimal `json:"total_pl"`
Type string `json:"type"`
Username string `json:"username"`
}
type Announcement ¶
type AuthResponse ¶
type BookSummary ¶
type BookSummary struct {
AskPrice *decimal.Decimal `json:"ask_price"`
BaseCurrency string `json:"base_currency"`
BidPrice *decimal.Decimal `json:"bid_price"`
CreationTimestamp uint64 `json:"creation_timestamp"`
CurrentFunding decimal.Decimal `json:"current_funding"`
EstimatedDeliveryPrice decimal.Decimal `json:"estimated_delivery_price"`
Funding8H decimal.Decimal `json:"funding_8h"`
High decimal.Decimal `json:"high"`
InstrumentName string `json:"instrument_name"`
InterestRate decimal.Decimal `json:"interest_rate"`
Last *decimal.Decimal `json:"last"`
Low *decimal.Decimal `json:"low"`
MarkPrice decimal.Decimal `json:"mark_price"`
MidPrice *decimal.Decimal `json:"mid_price"`
OpenInterest decimal.Decimal `json:"open_interest"`
PriceChange *decimal.Decimal `json:"price_change"`
QuoteCurrency string `json:"quote_currency"`
UnderlyingIndex string `json:"underlying_index"`
UnderlyingPrice decimal.Decimal `json:"underlying_price"`
VolumeUsd decimal.Decimal `json:"volume_usd"`
Volume decimal.Decimal `json:"volume"`
}
type BuyParams ¶
type BuyParams struct {
InstrumentName string `json:"instrument_name"`
Amount decimal.Decimal `json:"amount"`
Type string `json:"type,omitempty"`
Label string `json:"label,omitempty"`
Price *decimal.Decimal `json:"price,omitempty"`
TimeInForce string `json:"time_in_force,omitempty"`
MaxShow *decimal.Decimal `json:"max_show,omitempty"`
PostOnly bool `json:"post_only,omitempty"`
RejectPostOnly bool `json:"reject_post_only,omitempty"`
ReduceOnly bool `json:"reduce_only,omitempty"`
TriggerPrice *decimal.Decimal `json:"trigger_price,omitempty"`
Trigger string `json:"trigger,omitempty"`
Advanced string `json:"advanced,omitempty"`
MMP *bool `json:"mmp,omitempty"`
}
type BuyResponse ¶
type CancelAllByLabelParams ¶
type CancelAllByLabelParams struct {
Label string `json:"label"`
}
type CancelParams ¶
type CancelParams struct {
OrderID string `json:"order_id"`
}
type CancelWithdrawalParams ¶
type ClientCredentialsParams ¶
type ClosePositionParams ¶
type ClosePositionResponse ¶
type CreateDepositAddressParams ¶
type CreateDepositAddressParams struct {
Currency string `json:"currency"`
}
type Currency ¶
type Currency struct {
CoinType string `json:"coin_type"`
Currency string `json:"currency"`
CurrencyLong string `json:"currency_long"`
FeePrecision int `json:"fee_precision"`
MinConfirmations int `json:"min_confirmations"`
MinWithdrawalFee decimal.Decimal `json:"min_withdrawal_fee"`
WithdrawalFee decimal.Decimal `json:"withdrawal_fee"`
WithdrawalPriorities []WithdrawalPriority `json:"withdrawal_priorities"`
}
type Deposit ¶
type Deposit struct {
Address string `json:"address"`
Amount decimal.Decimal `json:"amount"`
Currency string `json:"currency"`
ReceivedTimestamp uint64 `json:"received_timestamp"`
State string `json:"state"`
TransactionID string `json:"transaction_id"`
UpdatedTimestamp uint64 `json:"updated_timestamp"`
}
type DepositAddress ¶
type DeribitPriceRanking ¶
type DeribitPriceRankingNotification ¶
type DeribitPriceRankingNotification []DeribitPriceRanking
type DisableTfaForSubaccountParams ¶
type DisableTfaForSubaccountParams struct {
Sid int `json:"sid"`
}
type EditByLabelParams ¶
type EditByLabelParams struct {
Label string `json:"label"`
InstrumentName string `json:"instrument_name"`
Amount decimal.Decimal `json:"amount"`
Price *decimal.Decimal `json:"price,omitempty"`
PostOnly bool `json:"post_only,omitempty"`
ReduceOnly bool `json:"reduce_only,omitempty"`
RejectPostOnly bool `json:"reject_post_only,omitempty"`
Advanced string `json:"advanced,omitempty"`
TriggerPrice *decimal.Decimal `json:"trigger_price,omitempty"`
MMP *bool `json:"mmp,omitempty"`
}
type EditParams ¶
type EditParams struct {
OrderID string `json:"order_id"`
Amount decimal.Decimal `json:"amount"`
Price *decimal.Decimal `json:"price,omitempty"`
PostOnly bool `json:"post_only,omitempty"`
ReduceOnly bool `json:"reduce_only,omitempty"`
RejectPostOnly bool `json:"reject_post_only,omitempty"`
Advanced string `json:"advanced,omitempty"`
TriggerPrice *decimal.Decimal `json:"trigger_price,omitempty"`
MMP *bool `json:"mmp,omitempty"`
}
type EditResponse ¶
type FundingChartData ¶
type GetAccountSummaryParams ¶
type GetBookSummaryByInstrumentParams ¶
type GetBookSummaryByInstrumentParams struct {
InstrumentName string `json:"instrument_name"`
}
type GetContractSizeParams ¶
type GetContractSizeParams struct {
InstrumentName string `json:"instrument_name"`
}
type GetContractSizeResponse ¶
type GetCurrentDepositAddressParams ¶
type GetCurrentDepositAddressParams struct {
Currency string `json:"currency"`
}
type GetDepositsParams ¶
type GetDepositsResponse ¶
type GetFundingChartDataResponse ¶
type GetFundingChartDataResponse struct {
CurrentInterest decimal.Decimal `json:"current_interest"`
Data []FundingChartData `json:"data"`
Interest8H decimal.Decimal `json:"interest_8h"`
}
type GetHistoricalVolatilityParams ¶
type GetHistoricalVolatilityParams struct {
Currency string `json:"currency"`
}
type GetHistoricalVolatilityResponse ¶
type GetHistoricalVolatilityResponse []HistoricalVolatility
type GetIndexParams ¶
type GetIndexParams struct {
Currency string `json:"currency"`
}
type GetIndexResponse ¶
type GetInstrumentsParams ¶
type GetLastSettlementsResponse ¶
type GetLastSettlementsResponse struct {
Settlements []Settlement `json:"settlements"`
Continuation string `json:"continuation"`
}
type GetLastTradesByCurrencyAndTimeParams ¶
type GetLastTradesByCurrencyAndTimeParams struct {
Currency string `json:"currency"`
Kind string `json:"kind,omitempty"`
StartTimestamp uint64 `json:"start_timestamp"`
EndTimestamp uint64 `json:"end_timestamp"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetLastTradesByCurrencyParams ¶
type GetLastTradesByCurrencyParams struct {
Currency string `json:"currency"`
Kind string `json:"kind,omitempty"`
StartID string `json:"start_id,omitempty"`
EndID string `json:"end_id,omitempty"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetLastTradesByInstrumentAndTimeParams ¶
type GetLastTradesByInstrumentAndTimeParams struct {
InstrumentName string `json:"instrument_name"`
StartTimestamp uint64 `json:"start_timestamp"`
EndTimestamp uint64 `json:"end_timestamp"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetLastTradesByInstrumentParams ¶
type GetLastTradesByInstrumentParams struct {
InstrumentName string `json:"instrument_name"`
StartSeq int64 `json:"start_seq,omitempty"`
EndSeq int64 `json:"end_seq,omitempty"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetLastTradesResponse ¶
type GetMarginsParams ¶
type GetMarginsResponse ¶
type GetOrderBookParams ¶
type GetOrderBookResponse ¶
type GetOrderBookResponse struct {
Timestamp uint64 `json:"timestamp"`
Stats Stats `json:"stats"`
State string `json:"state"`
SettlementPrice decimal.Decimal `json:"settlement_price"`
MinPrice decimal.Decimal `json:"min_price"`
MaxPrice decimal.Decimal `json:"max_price"`
MarkPrice decimal.Decimal `json:"mark_price"`
MarkIV decimal.Decimal `json:"mark_iv"`
LastPrice decimal.Decimal `json:"last_price"`
InstrumentName string `json:"instrument_name"`
IndexPrice decimal.Decimal `json:"index_price"`
Funding8H decimal.Decimal `json:"funding_8h"`
CurrentFunding decimal.Decimal `json:"current_funding"`
ChangeID uint64 `json:"change_id"`
BidIV decimal.Decimal `json:"bid_iv"`
Bids [][]decimal.Decimal `json:"bids"`
BestBidPrice decimal.Decimal `json:"best_bid_price"`
BestBidAmount decimal.Decimal `json:"best_bid_amount"`
BestAskPrice decimal.Decimal `json:"best_ask_price"`
BestAskAmount decimal.Decimal `json:"best_ask_amount"`
AskIV decimal.Decimal `json:"ask_iv"`
Asks [][]decimal.Decimal `json:"asks"`
DeliveryPrice decimal.Decimal `json:"delivery_price"`
Greeks Greeks `json:"greeks"`
InterestRate decimal.Decimal `json:"interest_rate"`
OpenInterest decimal.Decimal `json:"open_interest"`
UnderlyingIndex decimal.Decimal `json:"underlying_index"`
UnderlyingPrice decimal.Decimal `json:"underlying_price"`
}
type GetOrderMarginByIDsParams ¶
type GetOrderMarginByIDsParams struct {
IDs []string `json:"ids"`
}
type GetOrderMarginByIDsResponse ¶
type GetOrderMarginByIDsResponse []OrderMargin
type GetOrderStateParams ¶
type GetOrderStateParams struct {
OrderID string `json:"order_id"`
}
type GetPositionParams ¶
type GetPositionParams struct {
InstrumentName string `json:"instrument_name"`
}
type GetPositionsParams ¶
type GetSettlementHistoryResponse ¶
type GetSettlementHistoryResponse struct {
Settlements []Settlement `json:"settlements"`
Continuation string `json:"continuation"`
}
type GetSubaccountsParams ¶
type GetSubaccountsParams struct {
WithPortfolio bool `json:"with_portfolio,omitempty"`
}
type GetTradeVolumesParams ¶
type GetTradeVolumesParams struct {
Extended bool `json:"extended"`
}
type GetTradeVolumesResponse ¶
type GetTradeVolumesResponse []TradeVolume
type GetTradingviewChartDataResponse ¶
type GetTradingviewChartDataResponse struct {
Volume []decimal.Decimal `json:"volume"`
Ticks []uint64 `json:"ticks"`
Status string `json:"status"`
Open []decimal.Decimal `json:"open"`
Low []decimal.Decimal `json:"low"`
High []decimal.Decimal `json:"high"`
Cost []decimal.Decimal `json:"cost"`
Close []decimal.Decimal `json:"close"`
}
type GetTransfersParams ¶
type GetTransfersResponse ¶
type GetUserTradesByCurrencyAndTimeParams ¶
type GetUserTradesByCurrencyAndTimeParams struct {
Currency string `json:"currency"`
Kind string `json:"kind,omitempty"`
StartTimestamp int `json:"start_timestamp"`
EndTimestamp int `json:"end_timestamp"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetUserTradesByCurrencyParams ¶
type GetUserTradesByCurrencyParams struct {
Currency string `json:"currency"`
Kind string `json:"kind,omitempty"`
StartID string `json:"start_id,omitempty"`
EndID string `json:"end_id,omitempty"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetUserTradesByInstrumentAndTimeParams ¶
type GetUserTradesByInstrumentAndTimeParams struct {
InstrumentName string `json:"instrument_name"`
StartTimestamp uint64 `json:"start_timestamp"`
EndTimestamp uint64 `json:"end_timestamp"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetUserTradesByInstrumentParams ¶
type GetUserTradesByInstrumentParams struct {
InstrumentName string `json:"instrument_name"`
StartSeq int64 `json:"start_seq,omitempty"`
EndSeq int64 `json:"end_seq,omitempty"`
Count int `json:"count,omitempty"`
IncludeOld bool `json:"include_old,omitempty"`
Sorting string `json:"sorting,omitempty"`
}
type GetUserTradesResponse ¶
type GetWithdrawalsParams ¶
type HelloParams ¶
type HelloResponse ¶
type HelloResponse struct {
Version string `json:"version"`
}
type HistoricalVolatility ¶
type HistoricalVolatility struct {
Timestamp uint64 `json:"timestamp"`
Value decimal.Decimal `json:"value"`
}
func (*HistoricalVolatility) UnmarshalJSON ¶
func (h *HistoricalVolatility) UnmarshalJSON(buf []byte) error
type Instrument ¶
type Instrument struct {
TickSize decimal.Decimal `json:"tick_size"`
TakerCommission decimal.Decimal `json:"taker_commission"`
SettlementPeriod string `json:"settlement_period"`
QuoteCurrency string `json:"quote_currency"`
MinTradeAmount decimal.Decimal `json:"min_trade_amount"`
MakerCommission decimal.Decimal `json:"maker_commission"`
Leverage int `json:"leverage"`
Kind string `json:"kind"`
IsActive bool `json:"is_active"`
InstrumentName string `json:"instrument_name"`
ExpirationTimestamp uint64 `json:"expiration_timestamp"`
CreationTimestamp uint64 `json:"creation_timestamp"`
ContractSize decimal.Decimal `json:"contract_size"`
BaseCurrency string `json:"base_currency"`
BlockTradeCommission decimal.Decimal `json:"block_trade_commission"`
OptionType string `json:"option_type"`
Strike decimal.Decimal `json:"strike"`
}
type MarkpriceOption ¶
type MarkpriceOptionsNotification ¶
type MarkpriceOptionsNotification []MarkpriceOption
type Order ¶
type Order struct {
MMPCancelled bool `json:"mmp_cancelled"`
OrderState string `json:"order_state"`
MaxShow decimal.Decimal `json:"max_show"`
API bool `json:"api"`
Amount decimal.Decimal `json:"amount"`
Web bool `json:"web"`
InstrumentName string `json:"instrument_name"`
Advanced string `json:"advanced,omitempty"`
Triggered bool `json:"triggered,omitempty"`
BlockTrade bool `json:"block_trade"`
OriginalOrderType string `json:"original_order_type"`
Price decimal.Decimal `json:"price"`
TimeInForce string `json:"time_in_force"`
AutoReplaced bool `json:"auto_replaced"`
LastUpdateTimestamp uint64 `json:"last_update_timestamp"`
PostOnly bool `json:"post_only"`
Replaced bool `json:"replaced"`
FilledAmount decimal.Decimal `json:"filled_amount"`
AveragePrice decimal.Decimal `json:"average_price"`
OrderID string `json:"order_id"`
ReduceOnly bool `json:"reduce_only"`
Commission decimal.Decimal `json:"commission"`
AppName string `json:"app_name"`
Label string `json:"label"`
TriggerOrderID string `json:"trigger_order_id"`
TriggedPrice decimal.Decimal `json:"trigger_price"`
CreationTimestamp uint64 `json:"creation_timestamp"`
Direction string `json:"direction"`
IsLiquidation bool `json:"is_liquidation"`
OrderType string `json:"order_type"`
USD decimal.Decimal `json:"usd,omitempty"`
ProfitLoss decimal.Decimal `json:"profit_loss"`
Implv decimal.Decimal `json:"implv,omitempty"`
Trigger string `json:"trigger"`
}
type OrderBookNotification ¶
type OrderBookNotification struct {
Type string `json:"type"`
Timestamp int64 `json:"timestamp"`
InstrumentName string `json:"instrument_name"`
PrevChangeID int64 `json:"prev_change_id"`
ChangeID int64 `json:"change_id"`
Bids []OrderBookNotificationItem `json:"bids"` // [action, price, amount]
Asks []OrderBookNotificationItem `json:"asks"` // [action, price, amount]
}
type OrderBookNotificationItem ¶
type OrderBookNotificationItem struct {
Action string `json:"action"`
Price decimal.Decimal `json:"price"`
Amount decimal.Decimal `json:"amount"`
}
OrderBookNotificationItem ... ["change",6947.0,82640.0] ["new",6942.5,6940.0] ["delete",6914.0,0.0]
func (*OrderBookNotificationItem) UnmarshalJSON ¶
func (item *OrderBookNotificationItem) UnmarshalJSON(buf []byte) error
type OrderBookRawNotification ¶
type OrderBookRawNotification struct {
Timestamp int64 `json:"timestamp"`
InstrumentName string `json:"instrument_name"`
PrevChangeID int64 `json:"prev_change_id"`
ChangeID int64 `json:"change_id"`
Bids []OrderBookNotificationItem `json:"bids"` // [action, price, amount]
Asks []OrderBookNotificationItem `json:"asks"` // [action, price, amount]
}
type OrderMargin ¶
type PerpetualNotification ¶
type Portfolio ¶
type Portfolio struct {
AvailableFunds decimal.Decimal `json:"available_funds"`
AvailableWithdrawalFunds decimal.Decimal `json:"available_withdrawal_funds"`
Balance decimal.Decimal `json:"balance"`
Currency string `json:"currency"`
Equity decimal.Decimal `json:"equity"`
InitialMargin int `json:"initial_margin"`
MaintenanceMargin int `json:"maintenance_margin"`
MarginBalance decimal.Decimal `json:"margin_balance"`
}
type PortfolioNotification ¶
type PortfolioNotification struct {
TotalPl decimal.Decimal `json:"total_pl"`
SessionUpl decimal.Decimal `json:"session_upl"`
SessionRpl decimal.Decimal `json:"session_rpl"`
ProjectedMaintenanceMargin decimal.Decimal `json:"projected_maintenance_margin"`
ProjectedInitialMargin decimal.Decimal `json:"projected_initial_margin"`
ProjectedDeltaTotal decimal.Decimal `json:"projected_delta_total"`
PortfolioMarginingEnabled bool `json:"portfolio_margining_enabled"`
OptionsVega decimal.Decimal `json:"options_vega"`
OptionsValue decimal.Decimal `json:"options_value"`
OptionsTheta decimal.Decimal `json:"options_theta"`
OptionsSessionUpl decimal.Decimal `json:"options_session_upl"`
OptionsSessionRpl decimal.Decimal `json:"options_session_rpl"`
OptionsPl decimal.Decimal `json:"options_pl"`
OptionsGamma decimal.Decimal `json:"options_gamma"`
OptionsDelta decimal.Decimal `json:"options_delta"`
MarginBalance decimal.Decimal `json:"margin_balance"`
MaintenanceMargin decimal.Decimal `json:"maintenance_margin"`
InitialMargin decimal.Decimal `json:"initial_margin"`
FuturesSessionUpl decimal.Decimal `json:"futures_session_upl"`
FuturesSessionRpl decimal.Decimal `json:"futures_session_rpl"`
FuturesPl decimal.Decimal `json:"futures_pl"`
EstimatedLiquidationRatio decimal.Decimal `json:"estimated_liquidation_ratio"`
Equity decimal.Decimal `json:"equity"`
DeltaTotal decimal.Decimal `json:"delta_total"`
Currency string `json:"currency"`
Balance decimal.Decimal `json:"balance"`
AvailableWithdrawalFunds decimal.Decimal `json:"available_withdrawal_funds"`
AvailableFunds decimal.Decimal `json:"available_funds"`
}
type Position ¶
type Position struct {
AveragePrice decimal.Decimal `json:"average_price"`
AveragePriceUSD decimal.Decimal `json:"average_price_usd"`
Delta decimal.Decimal `json:"delta"`
Direction string `json:"direction"`
EstimatedLiquidationPrice decimal.Decimal `json:"estimated_liquidation_price"`
FloatingProfitLoss decimal.Decimal `json:"floating_profit_loss"`
FloatingProfitLossUSD decimal.Decimal `json:"floating_profit_loss_usd"`
Gamma decimal.Decimal `json:"gamma"`
IndexPrice decimal.Decimal `json:"index_price"`
InitialMargin decimal.Decimal `json:"initial_margin"`
InstrumentName string `json:"instrument_name"`
Kind string `json:"kind"`
Leverage int `json:"leverage"`
MaintenanceMargin decimal.Decimal `json:"maintenance_margin"`
MarkPrice decimal.Decimal `json:"mark_price"`
OpenOrdersMargin decimal.Decimal `json:"open_orders_margin"`
RealizedFunding decimal.Decimal `json:"realized_funding"`
RealizedProfitLoss decimal.Decimal `json:"realized_profit_loss"`
SettlementPrice decimal.Decimal `json:"settlement_price"`
Size decimal.Decimal `json:"size"`
SizeCurrency decimal.Decimal `json:"size_currency"`
Theta decimal.Decimal `json:"theta"`
TotalProfitLoss decimal.Decimal `json:"total_profit_loss"`
Vega decimal.Decimal `json:"vega"`
}
type QuoteNotification ¶
type QuoteNotification struct {
Timestamp uint64 `json:"timestamp"`
InstrumentName string `json:"instrument_name"`
BestBidPrice *decimal.Decimal `json:"best_bid_price"`
BestBidAmount decimal.Decimal `json:"best_bid_amount"`
BestAskPrice *decimal.Decimal `json:"best_ask_price"`
BestAskAmount decimal.Decimal `json:"best_ask_amount"`
}
type SellParams ¶
type SellParams struct {
InstrumentName string `json:"instrument_name"`
Amount decimal.Decimal `json:"amount"`
Type string `json:"type,omitempty"`
Label string `json:"label,omitempty"`
Price *decimal.Decimal `json:"price,omitempty"`
TimeInForce string `json:"time_in_force,omitempty"`
MaxShow *decimal.Decimal `json:"max_show,omitempty"`
PostOnly bool `json:"post_only,omitempty"`
RejectPostOnly bool `json:"reject_post_only,omitempty"`
ReduceOnly bool `json:"reduce_only,omitempty"`
TriggerPrice *decimal.Decimal `json:"trigger_price,omitempty"`
Trigger string `json:"trigger,omitempty"`
Advanced string `json:"advanced,omitempty"`
MMP *bool `json:"mmp,omitempty"`
}
type SellResponse ¶
type SessionParams ¶
type SessionParams struct {
Scope string `json:"scope"`
}
type SetAnnouncementAsReadParams ¶
type SetAnnouncementAsReadParams struct {
AnnouncementID int `json:"announcement_id"`
}
type SetEmailLanguageParams ¶
type SetEmailLanguageParams struct {
Language string `json:"language"`
}
type SetHeartbeatParams ¶
type SetHeartbeatParams struct {
Interval uint64 `json:"interval"`
}
type Settlement ¶
type Settlement struct {
Funded decimal.Decimal `json:"funded"`
Funding decimal.Decimal `json:"funding"`
Type string `json:"type"`
Timestamp uint64 `json:"timestamp"`
SessionProfitLoss decimal.Decimal `json:"session_profit_loss"`
ProfitLoss decimal.Decimal `json:"profit_loss"`
Position decimal.Decimal `json:"position"`
MarkPrice decimal.Decimal `json:"mark_price"`
InstrumentName string `json:"instrument_name"`
IndexPrice decimal.Decimal `json:"index_price"`
SessionBankrupcy decimal.Decimal `json:"session_bankrupcy"`
SessionTax decimal.Decimal `json:"session_tax"`
SessionTaxRate decimal.Decimal `json:"session_tax_rate"`
Socialized decimal.Decimal `json:"socialized"`
}
type Subaccount ¶
type Subaccount struct {
Email string `json:"email"`
ID int `json:"id"`
IsPassword bool `json:"is_password"`
LoginEnabled bool `json:"login_enabled"`
Portfolio struct {
Eth Portfolio `json:"eth"`
Btc Portfolio `json:"btc"`
} `json:"portfolio"`
ReceiveNotifications bool `json:"receive_notifications"`
SystemName string `json:"system_name"`
TfaEnabled bool `json:"tfa_enabled"`
Type string `json:"type"`
Username string `json:"username"`
}
type SubscribeParams ¶
type SubscribeParams struct {
Channels []string `json:"channels"`
}
type SubscribeResponse ¶
type SubscribeResponse []string
type TestResponse ¶
type TestResponse struct {
Version string `json:"version"`
}
type TickerNotification ¶
type TickerNotification struct {
Timestamp uint64 `json:"timestamp"`
Stats Stats `json:"stats"`
State string `json:"state"`
SettlementPrice decimal.Decimal `json:"settlement_price"`
OpenInterest decimal.Decimal `json:"open_interest"`
MinPrice decimal.Decimal `json:"min_price"`
MaxPrice decimal.Decimal `json:"max_price"`
MarkPrice decimal.Decimal `json:"mark_price"`
LastPrice decimal.Decimal `json:"last_price"`
InstrumentName string `json:"instrument_name"`
IndexPrice decimal.Decimal `json:"index_price"`
Funding8H decimal.Decimal `json:"funding_8h"`
CurrentFunding decimal.Decimal `json:"current_funding"`
BestBidPrice *decimal.Decimal `json:"best_bid_price"`
BestBidAmount decimal.Decimal `json:"best_bid_amount"`
BestAskPrice *decimal.Decimal `json:"best_ask_price"`
BestAskAmount decimal.Decimal `json:"best_ask_amount"`
}
type TickerParams ¶
type TickerParams struct {
InstrumentName string `json:"instrument_name"`
}
type TickerResponse ¶
type TickerResponse struct {
BestAskAmount decimal.Decimal `json:"best_ask_amount"`
BestAskPrice decimal.Decimal `json:"best_ask_price"`
BestBidAmount decimal.Decimal `json:"best_bid_amount"`
BestBidPrice decimal.Decimal `json:"best_bid_price"`
CurrentFunding decimal.Decimal `json:"current_funding"`
Funding8H decimal.Decimal `json:"funding_8h"`
IndexPrice decimal.Decimal `json:"index_price"`
InstrumentName string `json:"instrument_name"`
LastPrice decimal.Decimal `json:"last_price"`
MarkPrice decimal.Decimal `json:"mark_price"`
MaxPrice decimal.Decimal `json:"max_price"`
MinPrice decimal.Decimal `json:"min_price"`
OpenInterest decimal.Decimal `json:"open_interest"`
SettlementPrice decimal.Decimal `json:"settlement_price"`
State string `json:"state"`
Stats Stats `json:"stats"`
Timestamp uint64 `json:"timestamp"`
}
type Trade ¶
type Trade struct {
Amount decimal.Decimal `json:"amount"`
BlockTradeID string `json:"block_trade_id"`
Direction string `json:"direction"`
IndexPrice decimal.Decimal `json:"index_price"`
InstrumentName string `json:"instrument_name"`
IV decimal.Decimal `json:"iv"`
Liquidation string `json:"liquidation"`
MarkPrice decimal.Decimal `json:"mark_price"`
Price decimal.Decimal `json:"price"`
TickDirection int `json:"tick_direction"`
Timestamp uint64 `json:"timestamp"`
TradeID string `json:"trade_id"`
TradeSeq uint64 `json:"trade_seq"`
}
type TradeVolume ¶
type TradeVolume struct {
PutsVolume decimal.Decimal `json:"puts_volume"`
PutsVolume30D decimal.Decimal `json:"puts_volume_30d"`
PutsVolume7D decimal.Decimal `json:"puts_volume_7d"`
FuturesVolume decimal.Decimal `json:"futures_volume"`
FuturesVolume30D decimal.Decimal `json:"futures_volume_30d"`
FuturesVolume7D decimal.Decimal `json:"futures_volume_7d"`
CurrencyPair string `json:"currency_pair"`
CallsVolume decimal.Decimal `json:"calls_volume"`
CallsVolume30D decimal.Decimal `json:"calls_volume_30d"`
CallsVolume7D decimal.Decimal `json:"calls_volume_7d"`
}
type TradesNotification ¶
type TradesNotification []Trade
type Transfer ¶
type Transfer struct {
Amount decimal.Decimal `json:"amount"`
CreatedTimestamp uint64 `json:"created_timestamp"`
Currency string `json:"currency"`
Direction string `json:"direction"`
ID int `json:"id"`
OtherSide string `json:"other_side"`
State string `json:"state"`
Type string `json:"type"`
UpdatedTimestamp uint64 `json:"updated_timestamp"`
}
type UnsubscribeParams ¶
type UnsubscribeParams struct {
Channels []string `json:"channels"`
}
type UnsubscribeResponse ¶
type UnsubscribeResponse []string
type UserChangesNotification ¶
type UserOrderNotification ¶
type UserOrderNotification []Order
type UserTrade ¶
type UserTrade struct {
UnderlyingPrice decimal.Decimal `json:"underlying_price"`
TradeSeq uint64 `json:"trade_seq"`
TradeID string `json:"trade_id"`
Timestamp uint64 `json:"timestamp"`
TickDirection int `json:"tick_direction"`
State string `json:"state"`
SelfTrade bool `json:"self_trade"`
ReduceOnly bool `json:"reduce_only"`
ProfitLost decimal.Decimal `json:"profit_lost"`
Price decimal.Decimal `json:"price"`
PostOnly bool `json:"post_only"`
OrderType string `json:"order_type"`
OrderID string `json:"order_id"`
MatchingID *string `json:"matching_id"`
MarkPrice decimal.Decimal `json:"mark_price"`
Liquidity string `json:"liquidity"`
Liquidation string `json:"liquidation"`
Label string `json:"label"`
IV decimal.Decimal `json:"iv"`
InstrumentName string `json:"instrument_name"`
IndexPrice decimal.Decimal `json:"index_price"`
FeeCurrency string `json:"fee_currency"`
Fee decimal.Decimal `json:"fee"`
Direction string `json:"direction"`
Amount decimal.Decimal `json:"amount"`
BlockTradeID string `json:"block_trade_id"`
}
type UserTradesNotification ¶
type UserTradesNotification []UserTrade
type WithdrawParams ¶
type Withdrawal ¶
type Withdrawal struct {
Address string `json:"address"`
Amount decimal.Decimal `json:"amount"`
ConfirmedTimestamp *uint64 `json:"confirmed_timestamp,omitempty"`
CreatedTimestamp uint64 `json:"created_timestamp"`
Currency string `json:"currency"`
Fee decimal.Decimal `json:"fee"`
ID uint64 `json:"id"`
Priority decimal.Decimal `json:"priority"`
State string `json:"state"`
TransactionID *string `json:"transaction_id,omitempty"`
UpdatedTimestamp uint64 `json:"updated_timestamp"`
}
type WithdrawalPriority ¶
Source Files
¶
- account_summary.go
- announcement.go
- announcements_notification.go
- auth_response.go
- book_summary.go
- buy_params.go
- buy_response.go
- cancel_all_by_currency_params.go
- cancel_all_by_instrument_params.go
- cancel_params.go
- cancel_transfer_by_id_params.go
- cancel_withdrawal_params.go
- change_subaccount_name_params.go
- client_credentials_params.go
- close_position_params.go
- close_position_response.go
- common.go
- create_deposit_address_params.go
- currency.go
- deposit.go
- deposit_address.go
- deribit_price_index_notification.go
- deribit_price_ranking_notification.go
- disable_tfa_for_subaccount_params.go
- edit_params.go
- edit_response.go
- estimated_expiration_price_notification.go
- get_account_summary_params.go
- get_book_summary_by_currency_params.go
- get_book_summary_by_instrument_params.go
- get_contract_size_params.go
- get_contract_size_response.go
- get_current_deposit_address_params.go
- get_deposits_params.go
- get_deposits_response.go
- get_funding_chart_data_params.go
- get_funding_chart_data_response.go
- get_historical_volatility_params.go
- get_historical_volatility_response.go
- get_index_params.go
- get_index_response.go
- get_instruments_params.go
- get_last_settlements_by_currency_params.go
- get_last_settlements_by_instrument_params.go
- get_last_settlements_response.go
- get_last_trades_by_currency_and_time_params.go
- get_last_trades_by_currency_params.go
- get_last_trades_by_instrument_and_time_params.go
- get_last_trades_by_instrument_params.go
- get_last_trades_response.go
- get_margins_params.go
- get_margins_response.go
- get_open_orders_by_currency_params.go
- get_open_orders_by_instrument_params.go
- get_order_book_params.go
- get_order_book_response.go
- get_order_history_by_currency_params.go
- get_order_history_by_instrument_params.go
- get_order_margin_by_ids_params.go
- get_order_margin_by_ids_response.go
- get_order_state_params.go
- get_position_params.go
- get_positions_params.go
- get_settlement_history_by_currency_params.go
- get_settlement_history_by_instrument_params.go
- get_settlement_history_response.go
- get_subaccounts_params.go
- get_trade_volumes_params.go
- get_trade_volumes_response.go
- get_tradingview_chart_data_params.go
- get_tradingview_chart_data_response.go
- get_transfers_params.go
- get_transfers_response.go
- get_user_trades_by_currency_and_time_params.go
- get_user_trades_by_currency_params.go
- get_user_trades_by_instrument_and_time_params.go
- get_user_trades_by_instrument_params.go
- get_user_trades_by_order_params.go
- get_user_trades_response.go
- get_withdrawals_params.go
- hello_params.go
- hello_response.go
- instrument.go
- markprice_options_notification.go
- order.go
- order_book_notification.go
- perpetual_notification.go
- portfolio.go
- portfolio_notification.go
- position.go
- quote_notification.go
- sell_params.go
- sell_response.go
- session_params.go
- set_announcement_as_read_params.go
- set_email_for_subaccount_params.go
- set_email_language_params.go
- set_password_for_subaccount_params.go
- settlement.go
- subaccount.go
- subscribe_params.go
- subscribe_response.go
- test_response.go
- ticker_notification.go
- ticker_params.go
- ticker_response.go
- toggle_notifications_from_subaccount_params.go
- toggle_subaccount_login_params.go
- trade.go
- trades_notification.go
- trading_params.go
- transfer.go
- unsubscribe_params.go
- unsubscribe_response.go
- user_changes_notification.go
- user_order_notification.go
- user_trade.go
- user_trades_notification.go
- withdraw_params.go
- withdrawal.go
Click to show internal directories.
Click to hide internal directories.