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

get

Query parameters

HINstringOptional

MarketIdstringOptional

OrderIdsstring · string[]Optional

Order id

OrderCategoryinteger · enumOptional

Order category

Possible values:

OrderSideinteger · enumOptional

Order side

Possible values:

CreatedAtStartinteger · int64Optional

CreatedAtEndinteger · int64Optional

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

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/orders HTTP/1.1
Host: testnetopenapi.hibit.app
Accept: */*

{
  "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
  }
}

Code example

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

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?