API
API Reference
Create limit order
Create the limit order
POST https://open-api.openocean.finance/v1/:chainId/limit-order
Path Parameters
chainId*
Number
1, 56, 146,8453,80094
Request Body
getTakerAmount*
String
from data
predicate*
String
from data
getMakerAmount*
String
from data
interaction
String
default: '0x'
allowedSender
String
default: '0x0000000000000000000000000000000000000000'
receiver
String
default: orderMaker
takerAsset*
String
from data, token address
makerAsset*
String
from data, token address
salt*
String
from data
data*
Object
from sdk
amountRate*
Number
makerAmount / takerAmount
expireTime*
String
limit order expire time
isActive*
Boolean
true or false
remainingMakerAmount*
String
same with makerAmount
orderMaker*
String
wallet address
orderHash*
String
from sdk
signature*
String
from sdk
takerAmount*
String
amount with decimals
makerAmount*
String
amount with decimals
referrer
string (Optional)
An EOA wallet address used to identify partners and optionally receive a fee from users. If no fee is set up, it serves purely as a tracking tool to help our dev team provide better support and insights.
referrerFee
number (Optional)
Specify the percentage of in-token you wish to receive from the transaction, within the range of 0% to 5%, with 1% represented as '1', in the range of 0.01 to 5.
e.g. 1.2% fee set as 1.2
By default, OpenOcean shares 20% of the fee. Please contact us if you wish to modify this rate.
Cancel limit order
POST https://open-api.openocean.finance/v1/:chainId/limit-order/cancelLimitOrder
Path Parameters
chainId*
Number
1, 56，146，8453, 80094
Request Body
orderHash*
String
from dsk
Get limit order by address
GET https://open-api.openocean.finance/v1/:chainId/limit-order/address/:address
Path Parameters
chainId*
number
1, 56，146，8453, 80094
address*
String
user's wallet address
Query Parameters
statuses
String
eg: [1,2,3], 1-unfill, 2-fail, 3-cancel, 4-filled, 5-pending, 6- hash not exist, 7-expire
limit
number
limit count
Last updated