Links

API

Token Information

Description: Information on the token configuration of the MLP pool

Request

Parameter
Description
token (optional)
Specific token address to fetch information for

Response

Parameter
Description
address
Token address
name
Token name
symbol
Token ticker
decimals
Token amount are multiplied by 10 ** decimals
poolAmount
Total amount of tokens in the contracts incl. trader margins
maxPrice
Current price to buy token
minPrice
Current price to sell token
guarenteedUSD
Sum of trader profits
reservedAmount
Sum of trader notional value
availableAmount
Number of tokens that are able to collateralise positions (poolAmount - reservedAmount)
fundingRate
Hourly borrowing rate to be paid at the end of the hour
cumulativeFundingRate
Sum of all hourly funding rates to date
weight
Token target weighting in the MLP pool
usdgAmount
Tracks the USD debt for each token
maxUsdgAmount
Is the max USD value of a token in the MLP pool
globalMaxLongOpenInterest
The max USD value of long open interest for the token
globalMaxShortOpenInterest
The max USD value of short open interest for the token
globalShortSize
Current short open interest
bufferAmount
Minimum number of tokens that can be left in the MLP pool after a spot swap
utilisation
Portion of total assets that are being reserved for open positions
spreadBasisPoints
Basis point deviation between the mid price and the Max(Min) price
lastPriceUpdate
Timestamp of the last time token prices were updated

Prices

Websocket URL: wss://pricing.mycelium.xyz
Description: Realtime prices that the contracts update to when a leveraged position is opened. Note that there is a market specific spread when trading that is not accounted for in these prices.

Response

Parameter
Description
token
Token address
price
Mid price that oracle would update to upon a price update.

Positions

Description: Information on the open positions of a user.

Request

Parameter
Description
account (required)
Account address of the associated user

Response

Parameter
Description
size
Notional value of the position denoted in USD
collateral
Value of initial margin denoted in USD
collateralToken
Token being used as margin
indexToken
Token being traded
isLong
True of long, false if short
price
Current price of the index token
fundingRate
Current funding rate of the market
averageEntryPrice
Volume weighted average price to enter the position
liquidationPrice
Price that the position will be liquidated at

Historical Prices

Description: Historical price updates.

Request

Parameter
Description
from (optional)
From timestamp bound (in seconds)
to (optional)
To timestamp bound (in seconds)
token (optional)
Specific token address to fetch price history for

Response

Parameter
Description
token
Token address
symbol
Token ticker
price
The mid price sent to the VaultPriceFeed contract
timestamp
Timestamp of the price update
block
Block of the price update
txnHash
Transaction hash of the price update

Historical Funding Rates

Description: Historical funding rates.

Request

Parameter
Description
from (optional)
From timestamp bound (in seconds)
to (optional)
To timestamp bound (in seconds)
token (optional)
Specific token address to fetch funding rate history for

Response

Parameter
Description
token
Token address
symbol
Token ticker
endFundingRate
Funding rate at the end of the hour
startFundingRate
Funding rate at the start of the hour
utilization
Utilization of token for that hour (decimal percentage in 10 ** 18 decimals)
timestamp
Hour block timestamp (in seconds)

Historical Actions

Description: Historical swaps, increase positions, decrease positions, liquidations and orders.

Request

Parameter
Description
account (optional)
User address to fetch the actions of

Response

Parameter
Description
account
User address
txnHash
Action transaction hash
blockNumber
Block of execution
timestamp
Timestamp of execution
params
Parameters logged in the action event
action
Type of action

MLP Asset Exposure

Description: The exposure of MLP to each asset including pool composition and trader open interest. This can be used to hedge an MLP position to be delta neutral.

Response

Parameter
Description
token
Address of token
deltaPerDollar
Number of units of an asset 1 USD of MLP is exposed to. Multiply deltaPerDollar by MLP position size to derive how many units of each asset an MLP position is exposed to.
proportionalExposure
The portion of the MLP pool that is exposed to each asset. E.g. an output of 0.25 for ETH would mean 25% of MLP is exposed to ETH.

MLP Position

Description: Information on the MLP position of a user.

Request

Parameter
Description
account (required)
User address

Response

Parameters
Description
wethTokensPerInterval
The amount of ETH that is distributed to the MLP pool per second
esMycTokensPerInterval
The amount of esMYC that is distributed to the MLP pool per second
cumulativeWethRewards
The cumulative amount of ETH rewards that has been earned by the user
claimableWeth
The current amount of ETH rewards that the user can claim
cumulativeEsMycEarned
The cumulative amount of esMYC rewards that has been earned by the user
claimableEsMyc
The current amount of esMYC that the user can claim
cumulativeMarketMakingRewards
The cumulative amount of market making rewards that has been earned by the user
claimableMarketMakingRewards
The current amount of market making rewards that the user can claim
stakedAmount
The units of MLP staked by the user
totalSupply
The total units of MLP staked

Historical MLP AUM

Description: Historical hourly AUMs the MLP pool and the supply of MLP token

Request

Parameter
Description
from (optional)
From timestamp bound (in seconds)
to (optional)
To timestamp bound (in seconds)

Response

Parameter
Description
aum
The USD value of capital in the MLP pool
mlpSupply
The total supply of MLP
timestamp
Timestamp of the aum and totalSupply

Historical Fees

Description: Historical hourly fees broken down by action.

Request

Parameter
Description
from (optional)
From timestamp bound (in seconds)
to (optional)
To timestamp bound (in seconds)

Response

Parameter
Description
timestamp
Timestamp of the daily fees
margin
Fees generated via entry/exit and borrowing fees of leveraged trading
swap
Fees generated via spot swaps
mint
Fees generated via the minting of MLP
burn
Fees generated via the burning of MLP
liquidation
Fees generated via liquidation of leverage trading positions

Historical MLP Spread Capture

URL: TBA
Description: Historical hourly spread capture broken down by action.

Request

Parameter
Description
from (optional)
From timestamp bound (in seconds)
to (optional)
To timestamp bound (in seconds)

Response

Parameter
Description
timestamp
Timestamp of the spread capture
margin
Spread capture generated via the entry and exit of leveraged positions
swap
Spread capture generated via spot swaps
mint
Spread capture generated via the minting of MLP
burn
Spread capture generated via the burning of MLP
liquidation
Spread capture generated via the liquidation of leverage trading positions

Historical Volume

URL: TBA
Description: Historical daily spread capture broken down by action.

Request

Parameter
Description
from (optional)
From timestamp bound (in seconds)
to (optional)
To timestamp bound (in seconds)

Response

Parameter
Description
timestamp
Timestamp of the volume
margin
Volume of leveraged trading
swap
Volume of spot swaps
mint
Volume of minting of MLP
burn
Volume of burning of MLP
liquidation
Volume of leveraged positions liquidated