ETethereal
Product

Returns product by id

Changed on
get/v1/product/{id}

Request

Path parameters

idstring required

Response

baseTokenAddressstring hex required

Address of the base token (non-checksummed; zero address if virtual)

baseTokenNamestring required

Name of the base token (e.g. BTC in BTCUSD)

blockNumberstring required

Block number this product was registered on

createdAtinteger required

Product creation timestamp (ms since Unix Epoch)

cumulativeFundingUsdstring decimal required

Cumulative funding in USD of the product (precision: 9)

displayTickerstring required

Product display ticker based on the base quote token

engineType0 | 1 required
fundingBaselineAprstring decimal required

Funding baseline APR expressed as a decimal (precision: 9)

fundingClampAprstring decimal required

Funding clamp APR expressed as a decimal (precision: 9)

fundingMaxAprstring decimal required

Maximum funding APR expressed as a decimal, e.g. 2.0 = 200% (precision: 9)

fundingRate1hstring decimal required

Last computed hourly funding rate expressed as a decimal (precision: 9)

fundingUpdatedAtinteger

Unix timestamp when funding was last updated

idstring uuid required

Id representing the registered product

lotSizestring decimal required

Quantity must be divisible by the lotSize in expressed as a decimal (precision: 9)

makerFeestring decimal required

Fee charged to the maker on order trades expressed as a decimal (precision: 9)

maxLeveragenumber required

Maximum leverage allowed for the product

maxOpenInterestUsdstring decimal required

Max OI of one side in USD expressed as a decimal (precision: 9)

maxPositionNotionalUsdstring decimal required

Max position notional value, in USD expressed as a decimal (precision: 9)

maxPricestring decimal required

Max price in USD expressed as a decimal (precision: 9)

maxQuantitystring decimal required

Max quantity per order in native units expressed as a decimal (precision: 9)

minPricestring decimal required

Min price in USD expressed as a decimal (precision: 9)

minQuantitystring decimal required

Deprecated. Use lotSize instead. This value is always equal to lotSize.

onchainIdinteger required

The productId generated onchain after registering for the first time

openIntereststring decimal required

OI of both sides in native units expressed as a decimal (precision: 9)

pythFeedIdinteger required

Pyth price feed id

quoteTokenAddressstring hex required

Address of quote token (non-checksummed)

quoteTokenNamestring required

Name of the quote token (e.g. USD in BTCUSD)

status'PENDING' | 'ACTIVE' | 'DELISTED' required

Product status

takerFeestring decimal required

Fee charged to the taker on order trades expressed as a decimal (precision: 9)

tickSizestring decimal required

Minimum price increment (tickSize) expressed as a decimal (precision: 9)

tickerstring required

Product ticker based on the base quote token

volume24hstring decimal required

24h volume in base token native units expressed as a decimal (precision: 9)

Example response

{
  "baseTokenAddress": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
  "baseTokenName": "ETH",
  "blockNumber": "123062737",
  "createdAt": 1712019600000,
  "cumulativeFundingUsd": "1.001",
  "displayTicker": "ETH-USD",
  "fundingBaselineApr": "0.15",
  "fundingClampApr": "0.01",
  "fundingMaxApr": "2.0",
  "fundingRate1h": "0.01",
  "fundingUpdatedAt": 1721724269,
  "id": "9036443a-441a-4a66-87f2-bd5c44cdca7a",
  "lotSize": "0.01",
  "makerFee": "0.001",
  "maxLeverage": 20,
  "maxOpenInterestUsd": "200000000.0",
  "maxPositionNotionalUsd": "50000000.0",
  "maxPrice": "100000",
  "maxQuantity": "100000",
  "minPrice": "0",
  "minQuantity": "0.01",
  "onchainId": 1,
  "openInterest": "3300.17",
  "pythFeedId": 2,
  "quoteTokenAddress": "0x4c9EDD5852cd905f086C759E8383e09bff1E68B3",
  "quoteTokenName": "USDe",
  "status": "ACTIVE",
  "takerFee": "0.004",
  "tickSize": "0.0001",
  "ticker": "ETHUSD",
  "volume24h": "500000000.42"
}

Changes

  • 63e8937ff6f7Revision changes
    • warning

      added the new DELISTED enum value to the response property for the response status

    • info

      added the non-success response with the status

  • dc14c1586dfaRevision changes
    • breaking

      the response's property type changed from number to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      the response's property default value Bad Request was removed for the status

    • info

      the response's property default value Forbidden was removed for the status

    • info

      the response's property default value Not Found was removed for the status

    • info

      the response's property default value Too Many Requests was removed for the status

    • info

      the response's property default value Unauthorized was removed for the status

    • info

      the response's property default value Unprocessable Entity was removed for the status

    • info

      the response's property default value 400 was removed for the status

    • info

      the response's property default value 401 was removed for the status

    • info

      the response's property default value 403 was removed for the status

    • info

      the response's property default value 404 was removed for the status

    • info

      the response's property default value 422 was removed for the status

    • info

      the response's property default value 429 was removed for the status

    • info

      response property minQuantity deprecated

    • info

      removed the 0.00 enum value from the response property for the response status

    • info

      removed the 1.00 enum value from the response property for the response status

    • info

      response property message list-of-types was narrowed by removing types array from media type application/json of response 400