ETethereal
Product

Returns a list of all products and its configuration

Changed on
get/v1/product

Request

Query parameters

order'asc' | 'desc'

Direction to paginate through objects

limitinteger

Limit the number of objects to return

cursorstring

Pointer to the current object in pagination dataset

orderBy'createdAt' | 'openInterest' | 'baseTokenName' | 'quoteTokenName'
Example:createdAt

Order by field

tickerstring
Example:ETHUSD

Filter products by ticker (alphanumeric and case insensitive)

Response

hasNextboolean required

Whether there are more objects to paginate through

nextCursorstring

Pointer to the next page in pagination dataset

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "hasNext": true
}

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 data/items/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