API
API Reference
Create limit order
create the limit order
POST
https://open-api.openocean.finance/v1/:chainId/limit-order
Path Parameters
Name | Type | Description |
---|---|---|
chainId* | Number | 1, 56, 137, 250, 43114, 42161, 10, 128, 1285, 100, 66, 25, 324, 59144, 8453, 1666600000 |
Request Body
Name | Type | Description |
---|---|---|
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 |
Cancel limit order
cancel limit order
POST
https://open-api.openocean.finance/v1/:chainId/limit-order/cancelLimitOrder
Path Parameters
Name | Type | Description |
---|---|---|
chainId* | number | 1, 56, 137, 250, 43114 |
Request Body
Name | Type | Description |
---|---|---|
orderHash* | String | from dsk |
get limit order
get limit order
GET
https://open-api.openocean.finance/v1/:chainId/limit-order/all
Query Parameters
Name | Type | Description |
---|---|---|
chainId* | number | 1, 56, 137, 250, 43114 |
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 |
get limit order by address
get limit order by address
GET
https://open-api.openocean.finance/v1/:chainId/limit-order/address/:address
Query Parameters
Name | Type | Description |
---|---|---|
chainId* | number | 1, 56, 137, 250, 43114 |
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 |
address* | String | user's wallet address |