get depth

API details

This API returns market depth data, which is a combination of the orderbook and swap liquidity.

get the depth of the market

get

it is a combination of the orderbook and the swap liquidity.

Query parameters

Indexinteger · enumoptional

The index of the depth. for example, if depth levels of market is 0.01, 0.1, 1, 10, 50, 100. then the index of 0.01 is 1, 0.1 is 2, 1 is 3, 10 is 4, 50 is 5, 100 is 6.

Options: 1, 2, 3, 4, 5, 6

MarketIdstringoptional

The market id.

Limitinteger · int32 · min: 1 · max: 100optional

limit of the depth. Range from 1 to 100.

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/market/depth'

200

400

401

403

404

500

501

200

text/plain

application/json

text/json

text/plain

{
  "code": 1,
  "message": "text",
  "data": {
    "asks": [
      [
        "text"
      ]
    ],
    "bids": [
      [
        "text"
      ]
    ]
  }
}

OK

Code example

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

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

const marketId = 10008n;
const depth = await hibitClient.getMarketDepth({
  index: DepthIndex.L3,
  marketId: 10000n,
  limit: 10
});

SDK

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