API

View Github examples for Backend and Frontend.

Check out the current supported chains here.

1.Create DCA order

POST https://open-api.openocean.finance/v2/:chainId/dca/swap

Path Parameters

Name
Type
Description example

chainId*

number

8453, 146, 80094,1,999 Chain name or Chain ID (supported chains)

Example

  • url: https://open-api.openocean.finance/v2/8453/dca/swap

  • body

{
  "makerAmount": "20000000", // total amount with decimals,there's min.amt requirements for each swap set.
  "signature": "0x37e6...", // user sign messagae，wallet.signMessage(message)
  "orderMaker": "0xB3cb...",// wallet address
  "makerAsset": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913", // token address
  "takerAsset": "0xd9aAEc86B65D86f6A7B5B1b0c42FFA531710b6CA", // token address
  "time": 300, // interval time, s
  "times": 2, // frequency
  "minPrice": "0.9", // optional, price range
  "maxPrice": "1.1", // optional, price range
  "referrer": "0xxxxxxxxxxxxxxxxxxx", // optional. It's the EOA address to set up fees and track data from your end.
  "referrerFee": "1", // optional. "1"=1%. Enter the num to charge the platform fee on your end. The range will be 0-5%
  "enabledDexIds":"", // optional. Enter the 'index' number of dexs through dexList. P.S. enableDexIds has higher priority compared with disabledDexIds
  "disabledDexIds":"12,49,51,52", // optional. Enter the 'index' number of dexs through dexList endpoint to disable single or multiple dexs separated by commas, e.g. disabledDexIds: "2,6,9".
}

If you are willing to set a platform fee on your end, you could include the params of "referrer" &"referrerFee" shown in above example.

  • referrer is an EOA address to add. It is used for to collect the fee you charged. Meanwhile, it could help us to track data flow from your end.

  • referrerFee is the number set to charge, e.g. "1" is equal to "1%". OpenOcean will take 20% of the platform fee charge as default. If you are not willing to charge, you could either set it as 0 or not include the params.

Please note there's a min. required amount for below supported chains per transaction:

  • Ethereum: at least $30

  • Other EVM Chains: at least $5

E.g. If set times (frequency) as 2, the makerAmountmust set at least $10 to ensure each swap executed over $5.

Time interval mush at least over 60s.

  • response

2.Cancel DCA order

POST https://open-api.openocean.finance/v2/:chainId/dca/cancel

Path Parameters

Name
Type
Description

chainId*

number

8453, 146, 80094,1,999

Request Body

Name
Type
Description

orderHash*

string

orderHash from response

signature*

string

signature orderHash

Example

  • url: https://open-api.openocean.finance/v2/8453/dca/cancel

  • body

  • response

3.Get DCA order by address

GET https://open-api.openocean.finance/v2/:chainId/dca/address/:address

Path Parameters

Name
Type
Description

chainId*

number

8453, 146, 80094,1,999

address*

string

wallet address

Query Parameters

Name
Type
Description

statuses

array

status code: 1-unfill, 3-cancel, 4-filled, 5-pending, 6- hash not exist, 7-expire, default [1,3,4]

limit

number

limit count

4.Get all chain DCA order by address

GET https://open-api.openocean.finance/v2/dca/address/:address

Path Parameters

Name
Type
Description

address*

string

wallet address

Query Parameters

Name
Type
Description

statuses

array

status code: 1-unfill, 3-cancel, 4-filled, 5-pending, 6- hash not exist, 7-expire, default [1,3,4]

limit

number

limit count

5.Get DCA order execution details

GET https://open-api.openocean.finance/v2/:chainId/dca/fill/:orderHash

Path Parameters

Name
Type
Description

chainId

number

8453, 146, 80094,1,999

orderHash

string

order hash

PreviousGuideNextLimit Order API

Last updated