Frequently Used Queries
Last updated
Last updated
The following functions allow you to retrieve essential information from the SYMM system. These functions are designed to help frontend applications display account data. All functions are to be called on the Diamond contract, which will delegate the call to the appropriate facets. You can use a diamond inspection tool like to interact with the contracts in a more user-friendly way.
allocatedBalanceOfPartyA()
Returns the allocated balance for a given sub‑account. This balance represents the collateral that is “free”—i.e., not locked in open positions. Full documentation .
balanceInfoOfPartyA()
Provides detailed balance information for Party A. This includes allocated balances, locked balances, pending locked funds, and other relevant metrics. Full documentation .
deallocateCooldown()
Retrieves the cooldown period required before funds can be withdrawn following a deallocation. This period is typically set to 12 hours.
getpartyAOpenPositions()
Returns an array of all open positions held by Party A. Full documentation .
getQuote()
Fetches detailed information about a specific quote. Use this function to review all parameters of a quote submitted by a user. Full documentation .
getSymbol()
partyAPositionsCount()
withdrawCooldownOf()
These data structures form the backbone of SYMM’s trading engine. They define the various states and parameters associated with quotes and positions. When querying the Diamond, functions like getQuote()
return these structures to provide a complete picture of a trade’s configuration and status.
This structure holds the risk and margin parameters for a quote.
The Quote
struct contains comprehensive information about a trade request, including pricing, quantities, and state.
id
: Unique identifier for the quote.
partyBsWhiteList
: Array of addresses representing the Party B (hedger/solver) candidates eligible to accept the quote.
symbolId
: Identifier for the trading symbol associated with the quote.
openedPrice
: The price at which Party B opened the position .
initialOpenedPrice
: The initial opened price when the position was first executed.
requestedOpenPrice
: The price that Party A requested for opening the position (in 18 decimals).
marketPrice
: The current market price as provided by the Muon signature (in 18 decimals).
quantity
: The total quantity requested by Party A (expressed in 18 decimals).
closedAmount
: The amount of the position that has been closed so far (in 18 decimals).
maxFundingRate
: The maximum funding rate that Party A requested for the quote (in 18 decimals).
partyA
: Party A (the trader).
partyB
: Party B (the hedger/solver), if assigned.
avgClosedPrice
: The average price at which parts of the quote have been closed.
requestedClosePrice
: The price at which Party A requests the position to be closed.
quantityToClose
: The amount of the position that Party A intends to close.
parentId
: The identifier of a parent quote, used when the quote is partially filled.
createTimestamp
: The timestamp when the quote was created.
statusModifyTimestamp
: The timestamp of the last update to the quote’s status.
lastFundingPaymentTimestamp
: The time at which the last funding payment was charged on this quote.
deadline
: The deadline by which the quote must be executed or closed.
tradingFee
: The fee associated with trading, deducted from the quote (this is only charged on open)
affiliate
: The affiliate address associated with the quote, linking the quote to a frontend.
The Symbol struct contains data related to each symbol.
Returns details about a trading symbol, including its name, trading fee, and other configuration parameters. Full documentation .
Provides the total number of open positions held by Party A. This is useful for quickly assessing account exposure. Full documentation .
Retrieves the withdrawal cooldown timestamp for a sub‑account, indicating when funds will next be available for withdrawal. Full documentation .
: Indicates whether the position is LONG or SHORT.
: Specifies the order type: LIMIT or MARKET. (See Enums)
: The original locked values as set by Party A.
: The current locked risk parameters. In partial fill scenarios, this reflects the remaining locked values after part of the quote has been executed.
: The current state of the quote (e.g., PENDING, OPENED, CLOSED).