Module: @orderly.network/perp

References

Namespaces

Variables

order

version

Defined in

Orderly Network

Home

Introduction

Build on EVM

Build on NEAR

SDKs

Troubleshooting

Changelog

Get a Grant

Socials

pre-release

Orderly Home Page

A Unified Trading Infrastructure for Decentralized Exchanges

What is Orderly Network?

Key Advantages

Connecting traders across chains: The omnichain approach

Our Mission

Roadmap

Overview of $ORDER

Distribution and Emission Schedule

Retroactive Airdrop

Trading Rewards

Trading Rewards Mechanism

Market Making Rewards

Market Making Rewards Mechanism

Staking

Staking Information

esORDER

$ORDER Related Smart Contract Addresses

Getting Started

Orderly Orderbook Design

Glossary

Perpetual Futures Trading

Spot Trading

Accounts

Order Types

Trading Fees

Formulas and Definitions

Margin, Leverage & PnL

Mark Price, Index Price, and Last Price

Order Price Limit

Funding Rate

Liquidations

The Orderly Insurance Fund functions as a safeguard to protect bankrupt traders from being insolvent.

Insurance Fund & ADL

Fee Structure

Supported Markets

Supported Chains

There are several front ends built on top of the Orderly mainnet with many more in development.

Builders

Security

Terms of Service

Privacy Policy

Overview

Building on NEAR

NEAR SDK

Setting Up

Asset Manager Contract

Fungible Token Contract

REST Client

Tutorial

Smart Contract Addresses

Authentication/Key Management

Deposit

Withdrawal

General Data Access

User Data

The current Orderly architecture has an off-chain order book, and the orders are placed through an off-chain RESTful API. 

On-Chain Order/Swap

Storage Staking

Perpetual Futures

Orderly Network, a permissionless and modular protocol built on NEAR.

All requests need to be signed using `orderly-key` and `orderly-secret`. In addition, each order action require an additional key `orderly-trading-key` and `orderly-trading-secret` to sign. This is used by Orderly Network to verify each order from the user.

Authentication

Errors consist of three parts: an error code and a message. Codes are universal, but messages can vary. Here is the error JSON payload:

Error Codes

**Limit 10 requests per 60 seconds**

`GET /v1/client/key_info`

Retrieve all the registered Orderly key and Trading key pairs under the account.

Get Current Orderly/Trading Key Info

**Limit 10 requests per 60 seconds**

`GET /v1/client/trading_key_ip_restriction`

Retrieves the current IP restriction of a particular trading key.


Get Trading Key IP Restriction

**Limit: 10 requests per 60 seconds**

`POST /v1/client/add_trading_key_ip_restriction`

Set the IP restrictions of a particular trading key under the account.


Add Trading Key IP Restriction

**Limit: 10 requests per 60 seconds**

`POST /v1/client/remove_trading_key_ip_restriction`

Remove IP restrictions of a particular trading key under the account.

Remove Trading Key IP Restriction

**Limit: 10 requests per 60 seconds**

`POST /v1/client/reset_trading_key_ip_restriction`

Set the IP restrictions of a particular trading key under the account.


Reset Trading Key IP Restrictions

**Limit: 10 requests per 60 seconds**

`POST /v1/client/set_trading_key_ip_restriction`

Set the IP restrictions of a particular trading key under the account.


Set Trading Key IP Restrictions

**Limit: 10 requests per 1 second**

`POST /v1/order`

Place order maker/taker, the order executed information will be update from websocket stream.
will response immediately with an order created message.

`MARKET` type order behavior: it matches until the full size is executed. If the size is too large (larger than whole book) or the matching price exceeds the price limit (refer to `price_range`), then the remaining quantity will be cancelled.

`IOC` type order behavior: it matches as much as possible at the order_price. If not fully executed, then remaining quantity will be cancelled.

`FOK` type order behavior: if the order can be fully executed at the order_price then the order gets fully executed otherwise would be cancelled without any execution.

`POST_ONLY` type order behavior: if the order will be executed with any maker trades at the time of placement, then it will be cancelled without any execution.

`ASK` type order behavior: the order price is guranteed to be the best ask price of the orderbook at the time it gets accepted.

`BID` type order behavior: the order price is guranteed to be the best bid price of the orderbook at the time it gets accepted.

`visible_quantity` behavior: it sets the maximum quantity to be shown on orderbook. By default, it is equal to order_quantity, negative number and number larger than `order_quantity` is not allowed. If it sets to 0, the order would be hidden from the orderbook. It doesn't work for `MARKET`/`IOC`/`FOK` orders since orders with these types would be executed and cancelled immediately and not be shown on orderbook. For `LIMIT`/`POST_ONLY` order, as long as it's not complete, `visible_quantity` is the maximum quantity that shown on orderbook.

`order_amount` behavior: for `MARKET`/`BID`/`ASK` order, order can be placed by `order_amount` instead of `order_quantity`. It's the size of the order in terms of the quote currency instead of the base currency. The order would be rejected if  both `order_amount` and `order_quantity` are provided. The precision of the number should be within 8 digits.

`client_order_id` behavior: customized order_id, a unique id among open orders. Orders with the same `client_order_id` can be accepted only when the previous one if completed, otherwise the order will be rejected.

For `MARKET`/`BID`/`ASK` order, `order_amount` is not supported when placing SELL order while `order_quantity` is not supported when placing BUY order.


Create Order

**Limit: 1 request per 1 second**

`POST /v1/batch-order`

Creates a batch of orders as a list according to the same rules as a single Create Order.

Parameters for each order within the batch will be the same as the create single order. The batch of orders should be sent as a JSON array containing all the orders. The maximum number of orders that can be sent in 1 batch order request is 10. Each order within the batch order request is counted as 1 order towards the overall create order rate limit.


Batch Create Order

**Limit: 10 request per 1 second**

`PUT /v1/order`

Edit a pending order by `order_id`. Only the `order_price` or `order_quantity` can be amended.


Edit Order

**Limit: 10 requests per 1 second**

`DELETE /v1/order?order_id={order_id}&symbol={symbol}`

Cancels a single order by `order_id`.


Cancel Order

**Limit: 10 requests per 1 second**

`DELETE /v1/client/order?client_order_id={client_order_id}&symbol={symbol}`

Cancel an order by `client_order_id`.


Cancel Order By client_order_id

**Limit: 10 requests per 1 second**

`DELETE /v1/batch-order?order_ids={order_id_1},{order_id_2}`

Cancel a list of orders by `order_ids`. The maximum orders that can be cancelled within 1 batch cancel request is 10.

This endpoint will return invalid order_id error if 0 order_ids are given or all of the given order_ids are invalid. 


Batch Cancel Orders

**Limit: 10 requests per 1 second**

`DELETE /v1/client/batch-order?client_order_ids={client_order_id_1},{client_order_id_2}`

Cancel a list of orders by `client_order_ids`. The maximum orders that can be cancelled within 1 batch cancel request is 10.

This endpoint will return invalid client_order_id error if 0 client_order_ids are given or all of the given client_order_ids are invalid. 


Batch Cancel Orders By client_order_id

**Limit: 10 requests per 1 second**

`GET /v1/order/{order_id}`

Get details of a single order by `order_id`.


Get Order

**Limit: 10 requests per 1 second**

`GET /v1/client/order/{client_order_id}`

Get details of a single order by `client_order_id`.


Get Order by client_order_id

**Limit: 10 requests per 1 second**

`GET /v1/orders`

Get orders by customized filters.

For filter by status, one can reference special bundled statuses below for ease of access of Open (ie `INCOMPLETE`) orders or `COMPLETED` orders.

- `INCOMPLETE` = `NEW` + `PARTIAL_FILLED`
- `COMPLETED` = `CANCELLED` + `FILLED`


Get Orders

**Limit: 10 requests per 60 seconds**

`GET /v1/notification/inbox/notifications`

Get all notifications for the user.

Currently the only supported message type is the order filled message.


Get All Notifications

**Limit: 10 requests per 60 seconds**

`GET /v1/notification/inbox/unread`

Get the information on unread messages for the user.


Get Unread Notifications

**Limit: 10 requests per 60 seconds**

`POST /v1/notification/inbox/mark_read`

Set the read status on a list of notifications for a user.


Set Read Status of Notifications

**Limit: 10 requests per 60 seconds**

`POST /v1/notification/inbox/mark_read_all`

Set the read status on all notifications for a user.


Set Read Status of All Notifications

**Limit: 20 requests per 1 second**

`GET /v1/pnl_settlement/history`

Retrieve the historical PnL settlement history of the account.


Get PnL Settlement History

**Limit 10 requests per 60 seconds**

`GET /v1/asset/history`

Get asset history, including token deposits/withdrawals.


Get Asset History

**Limit 10 requests per 60 seconds**

`GET /v1/volume/user/daily`

Get the daily historical breakdown of the user trading volume.


Get User Daily Volume

**Limit 10 requests per 60 seconds**

`GET /v1/volume/user/stats`



Get User Volume Statistics

**Limit: 10 requests per 60 seconds**

`GET /v1/client/info`

Get basic account information including current user fee rates.


Get Account Information

**Limit: 10 requests per 60 seconds**

`GET /v1/client/statistics`

Get statistics of the user account


Get User Statistics

**Limit: 10 requests per 1 seconds**

`GET /v1/client/holding`

Get the current summary of user token holdings.


Get Current Holding

**Limit: 5 requests per 60 second per user**

`POST /v1/client/leverage`

Choose maximum leverage for futures mode


Update Leverage Setting

**Limit: 10 requests per 1 second**

`GET /v1/order/:order_id/trades`

Get specific trades of an order by `order_id`.


Get All Trades of Specific Order

**Limit: 10 requests per 1 second**

`GET /v1/trades`

Return client’s trades history within a time range.


Get Trades

**Limit: 10 requests per 1 second**

`GET /v1/trade/{trade_id}`

Get specific transaction details by `trade_id`.


Get Trade

**Limit: 30 requests per 10 second per user**

`GET /v1/position/:symbol`


Get One Position Info

**Limit: 30 requests per 10 second per user**

`GET /v1/positions`


Get All Positions Info

**Limit: 10 requests per 1 second per IP address**

`GET /v1/client/liquidator_liquidations`


Get Liquidated Positions by Liquidator

**Limit: 10 requests per 1 second per IP address**

`GET /v1/liquidations`


Get Liquidated Positions of Account

**Limit: 5 requests per 1 second per IP address**

`POST /v1/liquidation`


Claim Liquidated Positions

**Limit: 5 requests per 1 second**

`POST /v1/claim_insurance_fund`


Claim Insurance Fund

**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/liquidation`


Get Positions Under Liquidation for All Markets


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/liquidated_positions`


Get Liquidated Positions Info


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/funding_rate/:symbol`

Get latest funding rate for one market.


Get Predicted Funding Rate for One Market


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/funding_rates`

Get predicted funding rates for all futures trading pairs.

Get the : 
* `last_funding_rate` : latest hourly funding rate for all the markets for the last funding period (dt = 8h)
* `est_funding_rate` : rolling average of all funding rates over the last 8 hours 

Get Predicted Funding Rates for All Markets


**Limit: 10 requests per 1 second per IP address**


`GET /v1/public/funding_rate_history`


Get funding rate history for one market.


Get Funding Rate History for One Market


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/futures/:symbol`

Get basic futures information for one market.


Get Futures Info for One Market


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/futures`

Get basic futures information for all the markets.


Get Futures Info for All Markets


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/market_trades`

Get the latest market trades.


Get Market Trades

**Limit: 20 requests per 60 second per user**

`GET /v1/funding_fee/history`

Get funding fee history.


Get Funding Fee History

**Limit: 10 requests per 1 second**

`GET /v1/orderbook/{symbol}`

Snapshot of the current orderbook. Price of asks/bids are in descending order.


Orderbook Snapshot


**Limit: 10 requests per 1 second**

`GET /v1/kline`

Get the latest klines (OHLC) of the trading pairs.


Get Kline


**Limit: 10 requests per 1 second per IP address**

`GET v1/public/config`


Get Leverage Configuration

**Limit: 10 requests per 1 second per IP address**

Retreive the current system maintenance status of Orderly Network. A return value of status = 0 means the system is functioning properly and a return value of status = 2 means the system is under maintenance.

Get System Maintenance Status

**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/info/:symbol`

This endpoint provides all the values for the rules that an order need to fulfil in order for it to be placed successfully. The rules are defined as follows:

Price filter

- `price` >= `quote_min`
- `price` <= `quote_max`
- `(price - quote_min) % quote_tick` should equal to zero
- `price` <= `asks[0].price * (1 + price_range)` when BUY
- `price` >= `bids[0].price * (1 - price_range)` when SELL

Size filter

- `base_min` <= `quantity` <= `base_max`
- `(quantity - base_min) % base_tick` should equal to zero

Min Notional filter

- `price * quantity` should greater than `min_notional`

Risk Exposure filer

- Order size should be within holding threshold. See [account_info](#get-account-information)


Get Order Rules per Market

**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/token`

Retrives the available tokens to custody within Orderly Network.


Get Token Info

`GET /v1/public/info`

Get available symbols that Orderly Network supports, and also send order rules for each symbol. The definition of rules can be found at [Exchange Infomation](#exchange-information)


Get Available Symbols

Get Fee Information

**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/fee_futures/program`

Get fee information for futures trading.


Get Futures Fee Information


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/insurancefund`


Get Insurance Fund Info


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/volume/stats`

Get the latest volume statistics of Orderly and its associated brokers. Note that for broker volume, the volume is counted as the sum of the maker and taker volume, while for the full Orderly platform, the volume is the total amount matched on the platform (ie taker and maker are not double-counted.)


Get Volume Statistics


**Limit: 10 requests per 1 second per IP address**

`GET /v1/public/broker/name?broker_id={broker_id}`

Get the list of brokers currently onboarded on Orderly Network.


Get Broker List

**Limit: 10 requests per 60 seconds**

`POST /v1/client/maintenance_config`

Set the user config for whether the system should automatically cancel the user's pending orders during maintenance.


Software Development Kits

[EVM] React Components SDK

[EVM] React Hooks SDK

[EVM] Core SDK

[EVM] Perp SDK

Technical Documentation

Orderly network perp

Module: @orderly.network/perp

Table of contents

References

Namespaces

Variables

References

order

Variables

version

Defined in

Software Development Kits

[EVM] React Components SDK

[EVM] React Hooks SDK

[EVM] Core SDK

[EVM] Perp SDK

Technical Documentation

​Module: @orderly.network/perp

​Table of contents

​References

​Namespaces

​Variables

​References

​order

​Variables

​version

​Defined in

Module: @orderly.network/perp

Table of contents

References

Namespaces

Variables

References

order

Variables

version

Defined in