Skip to main content

Module types

Module types 

Source
Expand description

Types used as operation parameters and responses.

Modules§

error
Error types.

Structs§

Account
Account
AccountAsset
AccountAsset
AccountBalance
AccountBalance
AccountBalanceSummary
AccountBalanceSummary
AccountConfig
AccountConfig
AccountPosition
AccountPosition
AddressState
AddressState
ApiErrorResponse
Structured API error response matching Bullet API format.
Asset
Asset
AssetBalance
AssetBalance
AssetReward
AssetReward
Balance
Balance
BinanceOrder
BinanceOrder
BorrowLendPoolResponse
BorrowLendPoolResponse
Bracket
Bracket
ChainInfo
chain-level constants from the rollup
Delegate
Delegate
ExchangeInfo
ExchangeInfo
FundingInfo
funding rate metadata per symbol
FundingRate
FundingRate
GlobalConfigResponse
GlobalConfigResponse
HistoricalOrder
historical order for /fapi/v1/allOrders
InsuranceAsset
InsuranceAsset
InsuranceBalance
InsuranceBalance
JsonValidationErrorDetail
One JSON shape failure: machine-readable rule + full serde message including line/column. Surfaced under details on the wire.
LedgerEvent
Ledger event emitted by a transaction
LeverageBracket
LeverageBracket
ModuleRef
Reference to a module
OpenInterest
open interest for a single market
OrderBook
OrderBook
PaginatedResponseHistoricalOrder
paginated response wrapper with optional cursor for next page
PaginatedResponseHistoricalOrderDataItem
historical order for /fapi/v1/allOrders
PaginatedResponseUserDeposit
paginated response wrapper with optional cursor for next page
PaginatedResponseUserDepositDataItem
PaginatedResponseUserDepositDataItem
PaginatedResponseUserFundingPayment
paginated response wrapper with optional cursor for next page
PaginatedResponseUserFundingPaymentDataItem
user funding payment history
PaginatedResponseUserLiquidation
paginated response wrapper with optional cursor for next page
PaginatedResponseUserLiquidationDataItem
PaginatedResponseUserLiquidationDataItem
PaginatedResponseUserTrade
paginated response wrapper with optional cursor for next page
PaginatedResponseUserTradeDataItem
PaginatedResponseUserTradeDataItem
PaginatedResponseUserWithdrawal
paginated response wrapper with optional cursor for next page
PaginatedResponseUserWithdrawalDataItem
PaginatedResponseUserWithdrawalDataItem
PendingTpsl
PendingTpsl
PingResponse
PingResponse
PremiumIndex
real-time mark price, index price, and estimated funding rate per symbol
PriceTicker
PriceTicker
RateLimit
RateLimit
RateParams
RateParams
ReadinessStatus
readiness response returned by /health/ready
RollupConstants
Response from the /rollup/constants endpoint.
SubmitSolanaOffchainTxRequest
Body for a Solana off-chain signed transaction.
SubmitTxRequest
SubmitTxRequest
SubmitTxResponse
Response from submitting a transaction.
Symbol
Symbol
Ticker24hr
Ticker24hr
TimeResponse
TimeResponse
TpslLeg
TpslLeg
Trade
Trade
TxReceipt
Transaction receipt
UserDeposit
UserDeposit
UserFundingPayment
user funding payment history
UserLiquidation
UserLiquidation
UserTrade
UserTrade
UserWithdrawal
UserWithdrawal

Enums§

ApiErrorDetail
Typed details body. Variant order is important for untagged deserialization: keep the more-specific shape (JsonValidation) before more-permissive ones. Upstream holds the upstream payload verbatim (object, string, array, number, etc.) so pre-PR clients reading details.error (or details directly) keep working.
HealthState
health state for a single component
TxResult
Transaction execution result
TxStatus
Transaction status