get orders

API details

Retrieves paginated wallet order data filtered by order status, market, order type (limit or swap), order side (buy or sell), time range, and optional order IDs.

get orders of wallet

get

Query parameters

HINstringoptional

HIN (hibit chain identity number)

Statusinteger · enum[]optional

status to filter the orders, if null, means all statuses.

MarketIdstringoptional

marketId, if null, means all markets

OrderIdsstring · string[]optional

order ids, if null, means not filter by order ids. Max length is 20, if more than 20, return error.

OrderCategoryinteger · enumoptional

Order category

Options: 0, 1

OrderSideinteger · enumoptional

Order side

Options: 1, 2

CreatedAtStartinteger · int64optional

order created at after this time

CreatedAtEndinteger · int64optional

order created at before this time

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

default sorting is by " CreatedAt 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/orders'

200

400

401

403

404

500

501

200

text/plain

application/json

text/json

text/plain

{
  "code": 1,
  "message": "text",
  "data": {
    "items": [
      {
        "id": "text",
        "mid": "text",
        "hin": "text",
        "cat": 0,
        "s": 1,
        "fv": "text",
        "fa": "text",
        "tv": "text",
        "ta": "text",
        "fp": "text",
        "p": "text",
        "st": 0,
        "t": null
      }
    ],
    "totalCount": 1
  }
}

OK

Code example

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

const options = {
  network: HibitNetwork.Testnet,
  hin: 10000n
};
hibitClient.setOptions(options);

const orders = await hibitClient.getOrders({
  hin: options.hin,
  limit: 10,
  offset: 0
});

SDK

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

References

What is HIN?

How to Obtain your HIN and Proxy Key?