get markets

API details

This API returns a paginated list of markets, supporting filters for chains, chain asset types, base asset ID, and quote asset ID.

get the market list

get

Query parameters

ChainIdsstring[]optional

chain ids to filter the markets list.

ChainAssetTypesstring[]optional

chain asset types to filter the markets list.

BaseAssetIdstringoptional

The base asset id. This is an optional field that specifies the base asset for which the market list is requested.

QuoteAssetIdstringoptional

The quote asset id. This is an optional field that specifies the quote asset for which the market list is requested.

Limitinteger · int32optional

maximum number of items to return. maximum value is 500.

Offsetinteger · int32optional

number of items to skip before starting to collect the result set.

OrderBystringoptional

the sorting parameters for the list.

see https://learn.microsoft.com/en-us/azure/search/search-query-odata-orderby#examples for the format of the OrderBy string.

supported sorting parameters are: "MarketId".

default sorting is by " MarketId desc".

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnetopenapi.hibit.app/v1/markets'

200

400

401

403

404

500

501

200

text/plain

application/json

text/json

text/plain

{
  "code": 1,
  "message": "text",
  "data": {
    "items": [
      {
        "marketId": "text",
        "marketSymbol": "text",
        "baseAssetId": "text",
        "quoteAssetId": "text",
        "depthLevels": [
          1
        ]
      }
    ],
    "totalCount": 1
  }
}

OK

Code example

import { hibitClient } from '@delandlabs/hibit-client';

const options = {
  network: HibitNetwork.Testnet
};
hibitClient.setOptions(options);

const markets = await hibitClient.getMarkets({
  limit: 10,
  offset: 0
});

SDK

Source code https://github.com/Deland-Labs/hibit-sdk