# Get a market

`GET /api/markets/{address}`

Returns full market info with current state

## Authorization



## Parameters

- path: address (string; required). 

Type: string

## Example · cURL

```bash
curl --request GET 'https://api.storm.tg/api/markets/{address}' \
  --header 'Accept: application/json'
```

## Example · JavaScript

```javascript
const response = await fetch("https://api.storm.tg/api/markets/{address}", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  },
});
console.log(response.status, await response.text());
```

## Example · Python

```python
import requests

response = requests.request(
    "GET",
    "https://api.storm.tg/api/markets/{address}",
    headers={"Accept":"application/json"},
    timeout=30,
)
print(response.status_code, response.text)
```

## Response 200 · Data.MarketResponse

**200** application/json — Response

Schema: Data.MarketResponse

Type: object

Required fields: address, amm, change, incentive, settings, config

Required field types: address (string; required), amm (object; required), change (object; required), incentive (object; required), settings (object; required), config (object; required)

- address (string; required)

address example: string

address.Type: string

address.Market address

- amm (object; required)

amm example: {
  "address": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "txId": "string",
  "call": "OffchainOracleTick",
  "height": "0",
  "blockTimestamp": "2026-01-01T00:00:00Z",
  "seqno": "0",
  "indexPrice": "0",
  "baseOraclePrice": "0",
  "quoteOraclePrice": "0",
  "quoteAssetReserve": "0",
  "baseAssetReserve": "0",
  "baseAssetReserveWeight": "0",
  "quoteAssetReserveWeight": "0",
  "totalPositionSize": "0",
  "totalLongPositionSize": "0",
  "totalShortPositionSize": "0",
  "openInterestNotional": "0",
  "openInterestShort": "0",
  "openInterestLong": "0",
  "latestLongPremiumFraction": "0",
  "latestShortPremiumFraction": "0",
  "nextFundingBlock": "2026-01-01T00:00:00Z",
  "longFundingRate": "0",
  "shortFundingRate": "0",
  "vpiMarketDepthLong": "0",
  "vpiMarketDepthShort": "0",
  "vpiSpread": "0",
  "vpiCoefficient": "0"
}

amm.Type: object

amm.Required fields: address, txId, call, height, blockTimestamp, seqno, indexPrice, baseOraclePrice, quoteOraclePrice, quoteAssetReserve, baseAssetReserve, baseAssetReserveWeight, quoteAssetReserveWeight, totalPositionSize, totalLongPositionSize, totalShortPositionSize, openInterestNotional, openInterestShort, openInterestLong, latestLongPremiumFraction, latestShortPremiumFraction, nextFundingBlock, longFundingRate, shortFundingRate, vpiMarketDepthLong, vpiMarketDepthShort, vpiSpread, vpiCoefficient

amm.Required field types: address (string; required), txId (string · nullable; required), call (string; required), height (string · int64; required), blockTimestamp (string · date-time; required), seqno (string · int64; required), indexPrice (string · int64; required), baseOraclePrice (string · int64; required), quoteOraclePrice (string · int64; required), quoteAssetReserve (string · int64; required), baseAssetReserve (string · int64; required), baseAssetReserveWeight (string · int64; required), quoteAssetReserveWeight (string · int64; required), totalPositionSize (string · int64; required), totalLongPositionSize (string · int64; required), totalShortPositionSize (string · int64; required), openInterestNotional (string · int64; required), openInterestShort (string · int64; required), openInterestLong (string · int64; required), latestLongPremiumFraction (string · int64; required), latestShortPremiumFraction (string · int64; required), nextFundingBlock (string · date-time; required), longFundingRate (string · int64; required), shortFundingRate (string · int64; required), vpiMarketDepthLong (string · int64; required), vpiMarketDepthShort (string · int64; required), vpiSpread (string · int64; required), vpiCoefficient (string · int64; required)

amm.Current amm state

- amm.address (string; required)

amm.address example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

amm.address.Type: string

- amm.txId (string · nullable; required)

amm.txId example: string

amm.txId.Type: string · nullable

- amm.call (string; required)

amm.call example: OffchainOracleTick

amm.call.Type: string

- amm.height (string · int64; required)

amm.height example: 0

amm.height.Type: string · int64

amm.height.format: int64

amm.height.pattern: ^(0|-?[1-9][0-9]*)$

- amm.blockTimestamp (string · date-time; required)

amm.blockTimestamp example: 2026-01-01T00:00:00Z

amm.blockTimestamp.Type: string · date-time

amm.blockTimestamp.format: date-time

- amm.seqno (string · int64; required)

amm.seqno example: 0

amm.seqno.Type: string · int64

amm.seqno.format: int64

amm.seqno.pattern: ^(0|-?[1-9][0-9]*)$

- amm.indexPrice (string · int64; required)

amm.indexPrice example: 0

amm.indexPrice.Type: string · int64

amm.indexPrice.format: int64

amm.indexPrice.pattern: ^(0|-?[1-9][0-9]*)$

- amm.baseOraclePrice (string · int64; required)

amm.baseOraclePrice example: 0

amm.baseOraclePrice.Type: string · int64

amm.baseOraclePrice.format: int64

amm.baseOraclePrice.pattern: ^(0|-?[1-9][0-9]*)$

- amm.quoteOraclePrice (string · int64; required)

amm.quoteOraclePrice example: 0

amm.quoteOraclePrice.Type: string · int64

amm.quoteOraclePrice.format: int64

amm.quoteOraclePrice.pattern: ^(0|-?[1-9][0-9]*)$

- amm.quoteAssetReserve (string · int64; required)

amm.quoteAssetReserve example: 0

amm.quoteAssetReserve.Type: string · int64

amm.quoteAssetReserve.format: int64

amm.quoteAssetReserve.pattern: ^(0|-?[1-9][0-9]*)$

- amm.baseAssetReserve (string · int64; required)

amm.baseAssetReserve example: 0

amm.baseAssetReserve.Type: string · int64

amm.baseAssetReserve.format: int64

amm.baseAssetReserve.pattern: ^(0|-?[1-9][0-9]*)$

- amm.baseAssetReserveWeight (string · int64; required)

amm.baseAssetReserveWeight example: 0

amm.baseAssetReserveWeight.Type: string · int64

amm.baseAssetReserveWeight.format: int64

amm.baseAssetReserveWeight.pattern: ^(0|-?[1-9][0-9]*)$

- amm.quoteAssetReserveWeight (string · int64; required)

amm.quoteAssetReserveWeight example: 0

amm.quoteAssetReserveWeight.Type: string · int64

amm.quoteAssetReserveWeight.format: int64

amm.quoteAssetReserveWeight.pattern: ^(0|-?[1-9][0-9]*)$

- amm.totalPositionSize (string · int64; required)

amm.totalPositionSize example: 0

amm.totalPositionSize.Type: string · int64

amm.totalPositionSize.format: int64

amm.totalPositionSize.pattern: ^(0|-?[1-9][0-9]*)$

- amm.totalLongPositionSize (string · int64; required)

amm.totalLongPositionSize example: 0

amm.totalLongPositionSize.Type: string · int64

amm.totalLongPositionSize.format: int64

amm.totalLongPositionSize.pattern: ^(0|-?[1-9][0-9]*)$

- amm.totalShortPositionSize (string · int64; required)

amm.totalShortPositionSize example: 0

amm.totalShortPositionSize.Type: string · int64

amm.totalShortPositionSize.format: int64

amm.totalShortPositionSize.pattern: ^(0|-?[1-9][0-9]*)$

- amm.openInterestNotional (string · int64; required)

amm.openInterestNotional example: 0

amm.openInterestNotional.Type: string · int64

amm.openInterestNotional.format: int64

amm.openInterestNotional.pattern: ^(0|-?[1-9][0-9]*)$

- amm.openInterestShort (string · int64; required)

amm.openInterestShort example: 0

amm.openInterestShort.Type: string · int64

amm.openInterestShort.format: int64

amm.openInterestShort.pattern: ^(0|-?[1-9][0-9]*)$

- amm.openInterestLong (string · int64; required)

amm.openInterestLong example: 0

amm.openInterestLong.Type: string · int64

amm.openInterestLong.format: int64

amm.openInterestLong.pattern: ^(0|-?[1-9][0-9]*)$

- amm.latestLongPremiumFraction (string · int64; required)

amm.latestLongPremiumFraction example: 0

amm.latestLongPremiumFraction.Type: string · int64

amm.latestLongPremiumFraction.format: int64

amm.latestLongPremiumFraction.pattern: ^(0|-?[1-9][0-9]*)$

- amm.latestShortPremiumFraction (string · int64; required)

amm.latestShortPremiumFraction example: 0

amm.latestShortPremiumFraction.Type: string · int64

amm.latestShortPremiumFraction.format: int64

amm.latestShortPremiumFraction.pattern: ^(0|-?[1-9][0-9]*)$

- amm.nextFundingBlock (string · date-time; required)

amm.nextFundingBlock example: 2026-01-01T00:00:00Z

amm.nextFundingBlock.Type: string · date-time

amm.nextFundingBlock.format: date-time

- amm.longFundingRate (string · int64; required)

amm.longFundingRate example: 0

amm.longFundingRate.Type: string · int64

amm.longFundingRate.format: int64

amm.longFundingRate.pattern: ^(0|-?[1-9][0-9]*)$

- amm.shortFundingRate (string · int64; required)

amm.shortFundingRate example: 0

amm.shortFundingRate.Type: string · int64

amm.shortFundingRate.format: int64

amm.shortFundingRate.pattern: ^(0|-?[1-9][0-9]*)$

- amm.vpiMarketDepthLong (string · int64; required)

amm.vpiMarketDepthLong example: 0

amm.vpiMarketDepthLong.Type: string · int64

amm.vpiMarketDepthLong.format: int64

amm.vpiMarketDepthLong.pattern: ^(0|-?[1-9][0-9]*)$

- amm.vpiMarketDepthShort (string · int64; required)

amm.vpiMarketDepthShort example: 0

amm.vpiMarketDepthShort.Type: string · int64

amm.vpiMarketDepthShort.format: int64

amm.vpiMarketDepthShort.pattern: ^(0|-?[1-9][0-9]*)$

- amm.vpiSpread (string · int64; required)

amm.vpiSpread example: 0

amm.vpiSpread.Type: string · int64

amm.vpiSpread.format: int64

amm.vpiSpread.pattern: ^(0|-?[1-9][0-9]*)$

- amm.vpiCoefficient (string · int64; required)

amm.vpiCoefficient example: 0

amm.vpiCoefficient.Type: string · int64

amm.vpiCoefficient.format: int64

amm.vpiCoefficient.pattern: ^(0|-?[1-9][0-9]*)$

- change (object; required)

change example: {
  "quoteVolume": "0",
  "baseVolume": "0",
  "initialPrice": 0
}

change.Type: object

change.Required fields: quoteVolume, baseVolume, initialPrice

change.Required field types: quoteVolume (string · int64; required), baseVolume (string · int64; required), initialPrice (number; required)

change.Market volumes daily changes

- change.quoteVolume (string · int64; required)

change.quoteVolume example: 0

change.quoteVolume.Type: string · int64

change.quoteVolume.format: int64

change.quoteVolume.pattern: ^(0|-?[1-9][0-9]*)$

- change.baseVolume (string · int64; required)

change.baseVolume example: 0

change.baseVolume.Type: string · int64

change.baseVolume.format: int64

change.baseVolume.pattern: ^(0|-?[1-9][0-9]*)$

- change.initialPrice (number; required)

change.initialPrice example: 0

change.initialPrice.Type: number

- incentive (object; required)

incentive example: {
  "timestamp": "2026-01-01T00:00:00Z",
  "twapIndexPrice": "0",
  "twapSpotPrice": "0",
  "longFundingRate": "0",
  "shortFundingRate": "0"
}

incentive.Type: object

incentive.Required fields: timestamp, twapIndexPrice, twapSpotPrice, longFundingRate, shortFundingRate

incentive.Required field types: timestamp (string · date-time · nullable; required), twapIndexPrice (string · int64; required), twapSpotPrice (string · int64; required), longFundingRate (string · int64; required), shortFundingRate (string · int64; required)

incentive.Funding info

- incentive.timestamp (string · date-time · nullable; required)

incentive.timestamp example: 2026-01-01T00:00:00Z

incentive.timestamp.Type: string · date-time · nullable

incentive.timestamp.format: date-time

- incentive.twapIndexPrice (string · int64; required)

incentive.twapIndexPrice example: 0

incentive.twapIndexPrice.Type: string · int64

incentive.twapIndexPrice.format: int64

incentive.twapIndexPrice.pattern: ^(0|-?[1-9][0-9]*)$

- incentive.twapSpotPrice (string · int64; required)

incentive.twapSpotPrice example: 0

incentive.twapSpotPrice.Type: string · int64

incentive.twapSpotPrice.format: int64

incentive.twapSpotPrice.pattern: ^(0|-?[1-9][0-9]*)$

- incentive.longFundingRate (string · int64; required)

incentive.longFundingRate example: 0

incentive.longFundingRate.Type: string · int64

incentive.longFundingRate.format: int64

incentive.longFundingRate.pattern: ^(0|-?[1-9][0-9]*)$

- incentive.shortFundingRate (string · int64; required)

incentive.shortFundingRate example: 0

incentive.shortFundingRate.Type: string · int64

incentive.shortFundingRate.format: int64

incentive.shortFundingRate.pattern: ^(0|-?[1-9][0-9]*)$

- settings (object; required)

settings example: {
  "fee": "0",
  "executionFee": "0",
  "rolloverFee": "0",
  "fundingPeriod": 0,
  "ammType": "string",
  "minInitMarginRatio": "0",
  "initMarginRatio": "0",
  "maintenanceMarginRatio": "0",
  "liquidationFeeRatio": "0",
  "partialLiquidationRatio": "0",
  "spreadLimit": "0",
  "maxPriceImpact": "0",
  "maxPriceSpread": "0",
  "maxOpenNotional": "0",
  "feeToStakersPercent": "0",
  "maxOracleDelay": 0,
  "fundingMode": 0,
  "oracleMode": 0,
  "positionMode": 0,
  "fundingSettings": {
    "lowFundingFnA": 0,
    "lowFundingFnB": 0,
    "highFundingFnA": 0,
    "highFundingFnB": 0,
    "inflectionPoint": 0
  },
  "isCloseOnly": true,
  "isPaused": true,
  "status": "active"
}

settings.Type: object

settings.Required fields: fee, executionFee, rolloverFee, fundingPeriod, ammType, minInitMarginRatio, initMarginRatio, maintenanceMarginRatio, liquidationFeeRatio, partialLiquidationRatio, spreadLimit, maxPriceImpact, maxPriceSpread, maxOpenNotional, feeToStakersPercent, maxOracleDelay, fundingMode, oracleMode, positionMode, fundingSettings, isCloseOnly, isPaused, status

settings.Required field types: fee (string · int64; required), executionFee (string · int64; required), rolloverFee (string · int64; required), fundingPeriod (number; required), ammType (string; required), minInitMarginRatio (string · int64; required), initMarginRatio (string · int64; required), maintenanceMarginRatio (string · int64; required), liquidationFeeRatio (string · int64; required), partialLiquidationRatio (string · int64; required), spreadLimit (string · int64; required), maxPriceImpact (string · int64; required), maxPriceSpread (string · int64; required), maxOpenNotional (string · int64; required), feeToStakersPercent (string · int64; required), maxOracleDelay (number; required), fundingMode (number; required), oracleMode (number; required), positionMode (number; required), fundingSettings (object · nullable; required), isCloseOnly (boolean; required), isPaused (boolean; required), status (string · enum; required)

settings.Amm settings

- settings.fee (string · int64; required)

settings.fee example: 0

settings.fee.Type: string · int64

settings.fee.format: int64

settings.fee.pattern: ^(0|-?[1-9][0-9]*)$

- settings.executionFee (string · int64; required)

settings.executionFee example: 0

settings.executionFee.Type: string · int64

settings.executionFee.format: int64

settings.executionFee.pattern: ^(0|-?[1-9][0-9]*)$

- settings.rolloverFee (string · int64; required)

settings.rolloverFee example: 0

settings.rolloverFee.Type: string · int64

settings.rolloverFee.format: int64

settings.rolloverFee.pattern: ^(0|-?[1-9][0-9]*)$

- settings.fundingPeriod (number; required)

settings.fundingPeriod example: 0

settings.fundingPeriod.Type: number

- settings.ammType (string; required)

settings.ammType example: string

settings.ammType.Type: string

- settings.minInitMarginRatio (string · int64; required)

settings.minInitMarginRatio example: 0

settings.minInitMarginRatio.Type: string · int64

settings.minInitMarginRatio.format: int64

settings.minInitMarginRatio.pattern: ^(0|-?[1-9][0-9]*)$

- settings.initMarginRatio (string · int64; required)

settings.initMarginRatio example: 0

settings.initMarginRatio.Type: string · int64

settings.initMarginRatio.format: int64

settings.initMarginRatio.pattern: ^(0|-?[1-9][0-9]*)$

- settings.maintenanceMarginRatio (string · int64; required)

settings.maintenanceMarginRatio example: 0

settings.maintenanceMarginRatio.Type: string · int64

settings.maintenanceMarginRatio.format: int64

settings.maintenanceMarginRatio.pattern: ^(0|-?[1-9][0-9]*)$

- settings.liquidationFeeRatio (string · int64; required)

settings.liquidationFeeRatio example: 0

settings.liquidationFeeRatio.Type: string · int64

settings.liquidationFeeRatio.format: int64

settings.liquidationFeeRatio.pattern: ^(0|-?[1-9][0-9]*)$

- settings.partialLiquidationRatio (string · int64; required)

settings.partialLiquidationRatio example: 0

settings.partialLiquidationRatio.Type: string · int64

settings.partialLiquidationRatio.format: int64

settings.partialLiquidationRatio.pattern: ^(0|-?[1-9][0-9]*)$

- settings.spreadLimit (string · int64; required)

settings.spreadLimit example: 0

settings.spreadLimit.Type: string · int64

settings.spreadLimit.format: int64

settings.spreadLimit.pattern: ^(0|-?[1-9][0-9]*)$

- settings.maxPriceImpact (string · int64; required)

settings.maxPriceImpact example: 0

settings.maxPriceImpact.Type: string · int64

settings.maxPriceImpact.format: int64

settings.maxPriceImpact.pattern: ^(0|-?[1-9][0-9]*)$

- settings.maxPriceSpread (string · int64; required)

settings.maxPriceSpread example: 0

settings.maxPriceSpread.Type: string · int64

settings.maxPriceSpread.format: int64

settings.maxPriceSpread.pattern: ^(0|-?[1-9][0-9]*)$

- settings.maxOpenNotional (string · int64; required)

settings.maxOpenNotional example: 0

settings.maxOpenNotional.Type: string · int64

settings.maxOpenNotional.format: int64

settings.maxOpenNotional.pattern: ^(0|-?[1-9][0-9]*)$

- settings.feeToStakersPercent (string · int64; required)

settings.feeToStakersPercent example: 0

settings.feeToStakersPercent.Type: string · int64

settings.feeToStakersPercent.format: int64

settings.feeToStakersPercent.pattern: ^(0|-?[1-9][0-9]*)$

- settings.maxOracleDelay (number; required)

settings.maxOracleDelay example: 0

settings.maxOracleDelay.Type: number

- settings.fundingMode (number; required)

settings.fundingMode example: 0

settings.fundingMode.Type: number

- settings.oracleMode (number; required)

settings.oracleMode example: 0

settings.oracleMode.Type: number

- settings.positionMode (number; required)

settings.positionMode example: 0

settings.positionMode.Type: number

- settings.fundingSettings (object · nullable; required)

settings.fundingSettings example: {
  "lowFundingFnA": 0,
  "lowFundingFnB": 0,
  "highFundingFnA": 0,
  "highFundingFnB": 0,
  "inflectionPoint": 0
}

settings.fundingSettings.Type: object · nullable

settings.fundingSettings.Required fields: none

- settings.fundingSettings.lowFundingFnA (number; optional)

settings.fundingSettings.lowFundingFnA example: 0

settings.fundingSettings.lowFundingFnA.Type: number

- settings.fundingSettings.lowFundingFnB (number; optional)

settings.fundingSettings.lowFundingFnB example: 0

settings.fundingSettings.lowFundingFnB.Type: number

- settings.fundingSettings.highFundingFnA (number; optional)

settings.fundingSettings.highFundingFnA example: 0

settings.fundingSettings.highFundingFnA.Type: number

- settings.fundingSettings.highFundingFnB (number; optional)

settings.fundingSettings.highFundingFnB example: 0

settings.fundingSettings.highFundingFnB.Type: number

- settings.fundingSettings.inflectionPoint (number; optional)

settings.fundingSettings.inflectionPoint example: 0

settings.fundingSettings.inflectionPoint.Type: number

- settings.isCloseOnly (boolean; required)

settings.isCloseOnly example: true

settings.isCloseOnly.Type: boolean

- settings.isPaused (boolean; required)

settings.isPaused example: true

settings.isPaused.Type: boolean

- settings.status (string · enum; required)

settings.status example: active

settings.status.Type: string · enum

settings.status.Allowed values: ["active","closed","paused","closeOnly"]

- config (object; required)

config example: {
  "address": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "imageLink": "string",
  "quoteAsset": "string",
  "baseAsset": "string",
  "name": "string",
  "ticker": "string",
  "vaultAddress": "string",
  "type": "string",
  "tags": [
    "string"
  ],
  "closestPauseAt": 0,
  "closestUnpauseAt": 0,
  "isDayTrading": true,
  "dayTradingLeverageLimit": 0
}

config.Type: object

config.Required fields: address, imageLink, quoteAsset, baseAsset, name, ticker, vaultAddress, tags, closestPauseAt, closestUnpauseAt, isDayTrading, dayTradingLeverageLimit

config.Required field types: address (string; required), imageLink (string; required), quoteAsset (string; required), baseAsset (string; required), name (string; required), ticker (string; required), vaultAddress (string; required), tags (string[]; required), closestPauseAt (number · nullable; required), closestUnpauseAt (number · nullable; required), isDayTrading (boolean; required), dayTradingLeverageLimit (number · nullable; required)

config.Market config

- config.address (string; required)

config.address example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

config.address.Type: string

- config.imageLink (string; required)

config.imageLink example: string

config.imageLink.Type: string

- config.quoteAsset (string; required)

config.quoteAsset example: string

config.quoteAsset.Type: string

- config.baseAsset (string; required)

config.baseAsset example: string

config.baseAsset.Type: string

- config.name (string; required)

config.name example: string

config.name.Type: string

- config.ticker (string; required)

config.ticker example: string

config.ticker.Type: string

- config.vaultAddress (string; required)

config.vaultAddress example: string

config.vaultAddress.Type: string

- config.type (string; optional)

config.type example: string

config.type.Type: string

- config.tags (string[]; required)

config.tags example: [
  "string"
]

config.tags.Type: string[]

config.tags.[]Type: string

- config.closestPauseAt (number · nullable; required)

config.closestPauseAt example: 0

config.closestPauseAt.Type: number · nullable

- config.closestUnpauseAt (number · nullable; required)

config.closestUnpauseAt example: 0

config.closestUnpauseAt.Type: number · nullable

- config.isDayTrading (boolean; required)

config.isDayTrading example: true

config.isDayTrading.Type: boolean

- config.dayTradingLeverageLimit (number · nullable; required)

config.dayTradingLeverageLimit example: 0

config.dayTradingLeverageLimit.Type: number · nullable

- prelaunch (object; optional)

prelaunch example: {
  "address": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "assetName": "string",
  "startTime": "2026-01-01T00:00:00Z",
  "endTime": "2026-01-01T00:00:00Z",
  "paused": true,
  "closeOnly": true,
  "createdAt": "2026-01-01T00:00:00Z",
  "settings": {
    "tradingDelayForNonWhitelistUsers": 0,
    "preMarketStatus": "off",
    "showAlert": true,
    "alertType": "warning",
    "alertTitle": "string",
    "alertSubtitle": "string"
  }
}

prelaunch.Type: object

prelaunch.Required fields: address, assetName, startTime, endTime, paused, closeOnly, createdAt, settings

prelaunch.Required field types: address (string; required), assetName (string; required), startTime (string · date-time · nullable; required), endTime (string · date-time · nullable; required), paused (boolean; required), closeOnly (boolean; required), createdAt (string · date-time; required), settings (object · nullable; required)

prelaunch.Prelaunch

- prelaunch.address (string; required)

prelaunch.address example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

prelaunch.address.Type: string

- prelaunch.assetName (string; required)

prelaunch.assetName example: string

prelaunch.assetName.Type: string

- prelaunch.startTime (string · date-time · nullable; required)

prelaunch.startTime example: 2026-01-01T00:00:00Z

prelaunch.startTime.Type: string · date-time · nullable

prelaunch.startTime.format: date-time

- prelaunch.endTime (string · date-time · nullable; required)

prelaunch.endTime example: 2026-01-01T00:00:00Z

prelaunch.endTime.Type: string · date-time · nullable

prelaunch.endTime.format: date-time

- prelaunch.paused (boolean; required)

prelaunch.paused example: true

prelaunch.paused.Type: boolean

- prelaunch.closeOnly (boolean; required)

prelaunch.closeOnly example: true

prelaunch.closeOnly.Type: boolean

- prelaunch.createdAt (string · date-time; required)

prelaunch.createdAt example: 2026-01-01T00:00:00Z

prelaunch.createdAt.Type: string · date-time

prelaunch.createdAt.format: date-time

- prelaunch.settings (object · nullable; required)

prelaunch.settings example: {
  "tradingDelayForNonWhitelistUsers": 0,
  "preMarketStatus": "off",
  "showAlert": true,
  "alertType": "warning",
  "alertTitle": "string",
  "alertSubtitle": "string"
}

prelaunch.settings.Type: object · nullable

prelaunch.settings.Required fields: none

- prelaunch.settings.tradingDelayForNonWhitelistUsers (number; optional)

prelaunch.settings.tradingDelayForNonWhitelistUsers example: 0

prelaunch.settings.tradingDelayForNonWhitelistUsers.Type: number

- prelaunch.settings.preMarketStatus (string · enum; optional)

prelaunch.settings.preMarketStatus example: off

prelaunch.settings.preMarketStatus.Type: string · enum

prelaunch.settings.preMarketStatus.Allowed values: ["off","whitelistOnly","allowedForAll"]

- prelaunch.settings.showAlert (boolean; optional)

prelaunch.settings.showAlert example: true

prelaunch.settings.showAlert.Type: boolean

- prelaunch.settings.alertType (string · enum; optional)

prelaunch.settings.alertType example: warning

prelaunch.settings.alertType.Type: string · enum

prelaunch.settings.alertType.Allowed values: ["warning","success","info","error"]

- prelaunch.settings.alertTitle (string; optional)

prelaunch.settings.alertTitle example: string

prelaunch.settings.alertTitle.Type: string

- prelaunch.settings.alertSubtitle (string; optional)

prelaunch.settings.alertSubtitle example: string

prelaunch.settings.alertSubtitle.Type: string

Example



```json
{
  "address": "string",
  "amm": {
    "address": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
    "txId": "string",
    "call": "OffchainOracleTick",
    "height": "0",
    "blockTimestamp": "2026-01-01T00:00:00Z",
    "seqno": "0",
    "indexPrice": "0",
    "baseOraclePrice": "0",
    "quoteOraclePrice": "0",
    "quoteAssetReserve": "0",
    "baseAssetReserve": "0",
    "baseAssetReserveWeight": "0",
    "quoteAssetReserveWeight": "0",
    "totalPositionSize": "0",
    "totalLongPositionSize": "0",
    "totalShortPositionSize": "0",
    "openInterestNotional": "0",
    "openInterestShort": "0",
    "openInterestLong": "0",
    "latestLongPremiumFraction": "0",
    "latestShortPremiumFraction": "0",
    "nextFundingBlock": "2026-01-01T00:00:00Z",
    "longFundingRate": "0",
    "shortFundingRate": "0",
    "vpiMarketDepthLong": "0",
    "vpiMarketDepthShort": "0",
    "vpiSpread": "0",
    "vpiCoefficient": "0"
  },
  "change": {
    "quoteVolume": "0",
    "baseVolume": "0",
    "initialPrice": 0
  },
  "incentive": {
    "timestamp": "2026-01-01T00:00:00Z",
    "twapIndexPrice": "0",
    "twapSpotPrice": "0",
    "longFundingRate": "0",
    "shortFundingRate": "0"
  },
  "settings": {
    "fee": "0",
    "executionFee": "0",
    "rolloverFee": "0",
    "fundingPeriod": 0,
    "ammType": "string",
    "minInitMarginRatio": "0",
    "initMarginRatio": "0",
    "maintenanceMarginRatio": "0",
    "liquidationFeeRatio": "0",
    "partialLiquidationRatio": "0",
    "spreadLimit": "0",
    "maxPriceImpact": "0",
    "maxPriceSpread": "0",
    "maxOpenNotional": "0",
    "feeToStakersPercent": "0",
    "maxOracleDelay": 0,
    "fundingMode": 0,
    "oracleMode": 0,
    "positionMode": 0,
    "fundingSettings": {
      "lowFundingFnA": 0,
      "lowFundingFnB": 0,
      "highFundingFnA": 0,
      "highFundingFnB": 0,
      "inflectionPoint": 0
    },
    "isCloseOnly": true,
    "isPaused": true,
    "status": "active"
  },
  "config": {
    "address": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
    "imageLink": "string",
    "quoteAsset": "string",
    "baseAsset": "string",
    "name": "string",
    "ticker": "string",
    "vaultAddress": "string",
    "type": "string",
    "tags": [
      "string"
    ],
    "closestPauseAt": 0,
    "closestUnpauseAt": 0,
    "isDayTrading": true,
    "dayTradingLeverageLimit": 0
  },
  "prelaunch": {
    "address": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
    "assetName": "string",
    "startTime": "2026-01-01T00:00:00Z",
    "endTime": "2026-01-01T00:00:00Z",
    "paused": true,
    "closeOnly": true,
    "createdAt": "2026-01-01T00:00:00Z",
    "settings": {
      "tradingDelayForNonWhitelistUsers": 0,
      "preMarketStatus": "off",
      "showAlert": true,
      "alertType": "warning",
      "alertTitle": "string",
      "alertSubtitle": "string"
    }
  }
}
```