okx-v5-java

OKX v5 SDK for JAVA.

I am going to implement all APIs on the official api document.

SDK API STATUS

• Rest API

  • Trading Account
  • [x] Get Balance
  • [ ] Get positions
  • [ ] Get positions history
  • [ ] Get account and position risk
  • [ ] Get bills details (last 7 days)
  • [ ] Get bills details (last 3 months)
  • [ ] Get account configuration
  • [ ] Set position mode
  • [ ] Set leverage
  • [ ] Get maximum buy/sell amount or open amount
  • [ ] ...
  • Order Book Trading
  • Trade
    • [x] POST / Place order
    • [ ] POST / Place multiple orders
    • [x] POST / Cancel order
    • [ ] POST / Cancel multiple orders
    • [ ] POST / Amend order
    • [ ] POST / Amend multiple orders
    • [ ] POST / Close positions
    • [ ] ...
  • Grid Trading
    • [x] POST / Place grid algo order
    • [x] POST / Amend grid algo order
    • [x] POST / Stop grid algo order
    • [x] POST / Close position for contract grid
    • [x] POST / Cancel close position order for contract grid
    • [x] POST / Instant trigger grid algo order
    • [x] GET / Grid algo order list
    • [x] GET / Grid algo order history
    • [x] GET / Grid algo order details
    • [x] GET / Grid algo sub orders
    • [x] GET / Grid algo order positions
    • [x] POST / Spot grid withdraw income
    • [x] POST / Compute margin balance
    • [x] POST / Adjust margin balance
    • [x] POST / Add investment
    • [x] GET / Grid AI parameter (public)
    • [x] POST / Compute min investment (public)
    • [x] GET / RSI back testing (public)

• Websocket API

  • Trading Account
  • [x] Account channel
  • [x] Positions channel
  • [x] Balance and position channel
  • [x] Position risk warning
  • [x] Account greeks channel
  • Order Book Trading
  • Trade
    • [x] WS / Order channel
    • [x] WS / Place order
    • [x] WS / Place multiple orders
    • [x] WS / Cancel order
    • [x] WS / Cancel multiple orders
    • [x] WS / Amend order
    • [x] WS / Amend multiple orders
    • [x] WS / Mass cancel order
  • Algo Trading
    • [x] WS / Algo orders channel
    • [x] WS / Advance algo orders channel
  • Grid Trading
    • [x] WS / Spot grid algo orders channel
    • [x] WS / Contract grid algo orders channel
    • [x] WS / Grid positions channel
    • [x] WS / Grid sub orders channel
  • Public Data
  • [x] Instruments channel
  • [x] Open interest channel
  • [x] Funding rate channel
  • [x] Price limit channel
  • [x] Option summary channel
  • [x] Estimated delivery/exercise price channel
  • [x] Mark price channel
  • [x] Index tickers channel
  • [x] Mark price candlesticks channel
  • [x] Index candlesticks channel
  • [x] Liquidation orders channel
  • [x] ADL warning channel
  • [x] Economic calendar channel
  • Funding Account
  • [x] Deposit info channel
  • [x] Withdrawal info channel

How to use

Maven

<dependency>
    <groupId>xyz.felh</groupId>
    <artifactId>okx-v5-java</artifactId>
    <version>0.5.2024072701</version>
</dependency>

Gradle

implementation group: 'xyz.felh', name: 'okx-v5-java', version: '0.5.2024072701'

sbt

libraryDependencies += "xyz.felh" % "okx-v5-java" % "0.5.2024072701"

Important

• Automatically login when reconnected websocket if it has been login to PRIVATE channel

• Automatically restore all subscribe channels when reconnected websocket

License

Published under the MIT License (https://github.com/forestwanglin/okx-v5-java/blob/main/LICENSE)