Hanji Docs
  • About Hanji
  • Trading
    • Order Book
    • Order Types
    • Fees
  • Architecture
    • Matching Engine
    • Prices and Precision
    • Gas Costs
  • Audits
  • For developers
    • API
      • Contract API
      • Common objects
      • HTTP API
      • Websocket API
    • SDK
      • HanjiClient
      • HanjiSpot
  • LP Vault
    • Overview
    • Hanji Vault
    • Single-Token LP Vaults
Powered by GitBook
On this page
  • Content
  • /trades
  • Request parameters
  • Response
  • /orders
  • Request parameters
  • Response
  • /orderbook
  • Request parameters
  • Response
  • /fills
  • Request parameters
  • Response
  • /candles
  • Request parameters
  • Response
  • /markets
  • Request parameters
  • Response
  • /user-balances
  • Request parameters
  • Response
  1. For developers
  2. API

HTTP API

All endpoints use HTTP GET requests with several URL parameters. All responses are encoded in JSON format.

PreviousCommon objectsNextWebsocket API

Last updated 4 months ago

Content

/trades

Fetch market trades from recent to oldest.

Request parameters

Parameter
Required?
Description

market

required

a market contract address

limit

optional

max number of trades , default is 100

Response

/orders

Fetch user orders.

Request parameters

Parameter
Required?
Description

market

required

a market contract address

user

required

a user address

limit

optional

max number of orders , default is 100

Response

/orderbook

Fetch the current state of the market order book.

Request parameters

Parameter
Required?
Description

market

required

a market contract address

aggregation

optional

one of market aggregation, if not set max, aggregation is used

limit

optional

max number of levels in asks and bids , default is 100

Response

Object with fields:

Property
Type
Description

timestamp

number represents timestamp

the update time

levels

object with fields"asks" and "bids"

/fills

Get executed parts of user orders.

Request parameters

Parameter
Required?
Description

market

required

a market contract address

user

required

a user address

limit

optional

max number of objects in response, default is 100

Response

/candles

Get executed parts of user orders.

Request parameters

Parameter
Required?
Description

market

required

a market contract address

resolution

required

fromTime

optional

a lower bound of candle time

toTime

optional

an upper limit of candle time

Response

/markets

Request parameters

Parameter
Required?
Description

market

optional

a market contract address

Response

/user-balances

Request parameters

Parameter
Required?
Description

user

required

a user address

Response

An object with a key "balances" and a value that is an array of objects:

Property
Type
Description

token

string

a token symbol

tokenAddress

string

a token address

hold

number

amount of tokens locked in orders

total

number

amount of hold tokens plus a deposit in market contract

An array of objects.

An array of objects.

Each field is a sorted array of order book objects; asks are sorted in ascending order by price, and bids are sorted in descending order.

An array of order objects descending by a timestamp field.

one of object resolution

An array of objects ascending by a time field.

An array of objects.

trades
orders
orderbook
fills
candles
markets
user-balances
trade
order
fill
candle
market
level
candle