get assets

API details

This API returns a paginated list of assets currently supported by Hibit, with optional filters for chain asset types and chain IDs.

get assets supported by Hibit

get

Query parameters

ChainIdsstring[]Optional

chain ids to filter the assets list.

ChainAssetTypesstring[]Optional

chain asset types to filter the assets list.

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: "AssetId".

default sorting is by " AssetId desc".

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

501

Not Implemented

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/assets HTTP/1.1
Host: testnetopenapi.hibit.app
Accept: */*

{
  "code": 1,
  "message": "text",
  "data": {
    "items": [
      {
        "assetId": "text",
        "chainId": "text",
        "chainAssetType": "text",
        "contractAddress": "text",
        "decimalPlaces": "text",
        "isBaseToken": true,
        "displayName": "text",
        "assetSymbol": "text",
        "subAssets": [
          {
            "assetId": "text",
            "chainId": "text",
            "chainAssetType": "text",
            "contractAddress": "text",
            "decimalPlaces": "text"
          }
        ]
      }
    ],
    "totalCount": 1
  }
}

Code example

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

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

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

SDK

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