Jump to Content

API Reference

GETTING STARTED

nftperp-v2 🖼️📈 (api docs)

websocket

Introduction

general

contractsget
balancesget
eth priceget
statsget
leaderboardget

amm

mark priceget
index priceget
funding rateget
infoget

position

positionget
open summaryget
close market summaryget
close limit summaryget
margin change summaryget
free collateralget
lp positionget

orderbook

orderbookget
limit ordersget
trigger ordersget

history

tradesget
fundingsget
candlesget
liquidityget

SMART CONTRACT functions

Introduction
[WRITE] open position
[WRITE] close position
[WRITE] create limit order
[WRITE] delete limit order
[WRITE] update limit order
[WRITE] create trigger order
[WRITE] delete trigger order
[WRITE] update trigger order
[WRITE] create limit order batch
[WRITE] delete limit order batch
[WRITE] update limit order batch
[WRITE] add liquidity
[WRITE] remove liquidity
[WRITE] settle funding
[WRITE] liquidate
[READ] get position
[READ] get limit order
[READ] get trigger order
[READ] get upnl

contract events

PositionChanged
LimitOrderUpdated
LimitOrderRemoved
TriggerOrderUpdated
TriggerOrderRemoved
OpenInterestChanged
FundingSettled
LiquidityAdded
LiquidityRemoved
PriceUpdated

Powered by

orderbook

get https://live.nftperp.xyz/orderbook

get orderbook

Language

Click Try It! to start a request and see the response here!