README.md

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
    • 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
      • POST / Place order
      • POST / Place multiple orders
      • POST / Cancel order
      • POST / Cancel multiple orders
      • POST / Amend order
      • POST / Amend multiple orders
      • POST / Close positions
      • ...
    • Grid Trading
      • POST / Place grid algo order
      • POST / Amend grid algo order
      • POST / Stop grid algo order
      • POST / Close position for contract grid
      • POST / Cancel close position order for contract grid
      • POST / Instant trigger grid algo order
      • GET / Grid algo order list
      • GET / Grid algo order history
      • GET / Grid algo order details
      • GET / Grid algo sub orders
      • GET / Grid algo order positions
      • POST / Spot grid withdraw income
      • POST / Compute margin balance
      • POST / Adjust margin balance
      • POST / Add investment
      • GET / Grid AI parameter (public)
      • POST / Compute min investment (public)
      • GET / RSI back testing (public)

• Websocket API

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