Account
GET
Positions
GET
PositionsGET
/v1/account/positions/{address}
Get all statistics related to Moby.
Path Parameters
Name | Type | Description |
---|---|---|
address* | String | EVM address to check |
Query Examples
Response Examples
Properties in the Response
Name | Type | Description |
---|---|---|
account |
| The account address for which the positions are being retrieved. |
BTC |
| An array of BTC positions. |
ETH |
| An array of ETH positions. |
expiry |
| The expiry timestamp of the option in Unix epoch time. |
settlePrice |
| The settle price of the option. |
positions |
| An array of position objects for the given cryptocurrency. |
underlyingAsset |
| The address of the underlying asset. |
optionTokenId |
| The unique identifier for the ERC-1155 option token. |
length |
| The number of instrument that the corresponding position held. (naked: 1, combo: 2) |
markPrice |
| The mark price of the position. |
markIv |
| The implied volatility of the mark price. |
mainOptionStrikePrice |
| The strike price of the main option. |
pairedOptionStrikePrice |
| The strike price of the paired option. If the position is naked, it would be 0. |
isBuys |
| A string indicating buy/sell status of the each instrument. |
strikePrices |
| A string indicating the strike prices of each instrument. |
isCalls |
| A string indicating call/put status of the each instrument. |
optionNames |
| The names of the instrument. |
size |
| The option size of the position. |
sizeOpened |
| The size of the position when opened. |
sizeClosing |
| The size of the position when closing. |
sizeClosed |
| The size of the position when closed. |
sizeSettled |
| The size of the position when settled. |
isBuy |
| Indicates if the position is a buy. |
executionPrice |
| The execution price of the trade. Represented as a string to handle large numbers. |
openedToken |
| The paid token contract when the position was opened. |
openedAmount |
| The amount of the paid token used when the position was opened. |
openedCollateralToken |
| The collateral token contract when the position was opened. |
openedCollateralAmount |
| The amount of the collateral token when the position was opened. |
openedAvgExecutionPrice |
| The average execution price when the position was opened. |
openedAvgSpotPrice |
| The average spot price when the position was opened. |
closedToken |
| The closed token contract when the position was closed. |
closedAmount |
| The amount of the token used when the position was closed. |
closedCollateralToken |
| The collateral token used when the position was closed. |
closedCollateralAmount |
| The amount of the collateral token used when the position was closed. |
closedAvgExecutionPrice |
| The average execution price when the position was closed. |
closedAvgSpotPrice |
| The average spot price when the position was closed. |
settledToken |
| The token used when the position was settled. |
settledAmount |
| The amount of the token used when the position was settled. |
settledCollateralToken |
| The collateral token used when the position was settled. |
settledCollateralAmount |
| The amount of the collateral token used when the position was settled. |
settledPrice |
| The settle price of the position. |
isSettled |
| Indicates if the position is settled. |
lastProcessBlockTime |
| The timestamp of the last block when the position was processed, in Unix epoch time. |
lastUpdatedAt |
| The timestamp of the last update to the positions data, in Unix epoch time. |
GET
Trade History
GET
Trade HistoryGET
/v1/account/optionTradeHistories/{address}
Path Parameters
Name | Type | Description |
---|---|---|
address* | String | EVM address to check |
Query Parameters
Name | Type | Description |
---|---|---|
period | Integer | Query the last {period} days. If the value is undefined, the default is to query entire history. |
Query Examples
Response Examples
Properties in the Response
Name | Type | Description |
---|---|---|
positionHistories |
| Contains the list of position histories and related metadata. |
positionHistories.nodes |
| An array of position history objects. |
avgExecutionPrice |
| The average execution price of the position. Represented as a string to handle large numbers. |
collateralAmount |
| The amount of collateral associated with the position. |
collateralToken |
| The address of the collateral token. |
expiry |
| The expiry timestamp of the option in Unix epoch time. |
processBlockTime |
| The timestamp of the block when the process was executed, in Unix epoch time. |
quoteToken |
| The address of the quote token. |
quoteAmount |
| The amount of quote token involved in the trade. |
requestIndex |
| The index of the request in the system. |
roi |
| Return on investment (ROI) of the trade, represented as a string for precision. |
cashFlow |
| The cash flow amount associated with the trade. |
executionPrice |
| The execution price of the trade. Represented as a string to handle large numbers. |
optionTokenId |
| The unique identifier for the ERC-1155 option token. |
pnl |
| Profit and loss (P&L) from the trade, represented as a string for precision. |
settlePayoff |
| The payoff amount when the option is settled. |
settlePrice |
| The price at which the option was settled. |
size |
| The size of the option contract |
spotPrice |
| The spot price at the time of the trade. |
type |
| The type of action, e.g., "close". |
totalCount |
| The total number of trade until now. |
GET
Settlement History
GET
Settlement HistoryGET
/v1/account/optionSettlementHistories/{address}
Path Parameters
Name | Type | Description |
---|---|---|
address | String | EVM address to check |
Query Parameters
Name | Type | Description |
---|---|---|
period | Integer | Query the last {period} days. If the value is undefined, the default is to query entire history. |
Query Examples
Response Examples
Properties in the Response
Name | Type | Description |
---|---|---|
data |
| The root object containing the settlement history data. |
data.positionHistories |
| Contains the list of position histories and related metadata. |
data.positionHistories.nodes |
| An array of position history objects. |
avgExecutionPrice |
| The average execution price of the position. Represented as a string to handle large numbers. |
collateralAmount |
| The amount of collateral associated with the position. |
collateralToken |
| The address of the collateral token. |
expiry |
| The expiry timestamp of the option in Unix epoch time. |
processBlockTime |
| The timestamp of the block when the process was executed, in Unix epoch time. |
quoteToken |
| The address of the quote token. |
quoteAmount |
| The amount of quote token involved in the trade. |
requestIndex |
| The index of the request in the system. |
roi |
| Return on investment (ROI) of the trade, represented as a string for precision. |
cashFlow |
| The cash flow amount associated with the trade. |
executionPrice |
| The execution price of the trade. Represented as a string to handle large numbers. |
optionTokenId |
| The unique identifier for the option token. |
pnl |
| Profit and loss (P&L) from the trade, represented as a string for precision. |
settlePayoff |
| The payoff amount when the option is settled. |
settlePrice |
| The price at which the option was settled. |
size |
| The size of the position |
spotPrice |
| The spot price at the time of the trade |
type |
| The type of action, e.g., "open", "close" |
totalCount |
| The total number of settled position history. |
GET
Trade Status
GET
Trade StatusGET
/v1/account/optionTradeStatus/{address}
Path Parameters
Name | Type | Description |
---|---|---|
address | String | EVM address to check |
Query Examples
Response Examples
Properties in the Response
Name | Type | Description |
---|---|---|
BTC | Object | Contains trade status information for Bitcoin (BTC) |
BTC.tradeCount | Integer | The total number of trades executed for BTC |
BTC.tradeSize | Number | Sum of all trade executed for BTC |
BTC.notionalVolume | Number | The total notional volume (sum of the trade sizes times their prices) for BTC trades |
BTC.open | Object | Statistic of overall tradeSize per each type of options for open position |
BTC.close | Object | Statistic of overall tradeSize per each type of options for close position |
BTC.tradeSizeByTerm | Object | Each tradeSize regarding the type of vault |
ETH | Object | Same as BTC |
address | String | The EVM address for which the trade status is provided |
Last updated