orionx-sdk - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "orionx-sdk",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Help developers with Orionx integrations",
@@ -5,0 +5,0 @@ "main": "build/index.js",

README.md

@@ -121,2 +121,23 @@ <p align="center">
 
+### placeLimitOrder
+
+The `placeLimitOrder()` creates and returns a limit order .
+
+```js
+await Orionx.placeLimitOrder({marketCode: ':marketCode', amount: :amount, limitPrice: :limitPrice, sell: :sell})
+```
+
+#### Params
+
+**marketCode:** Market code
+
+**amount** The amount to be bought or sold, this amount must be multiplied by 10 ^ (unit amount)
+For example BTC units = 8 so to sell 1 BTC amount should be 1 \* 10⁸.
+
+**limitPrice** The price for the order
+
+**sell** Boolean that defines if you buy or sell
+
+---
+
 ### placeMarketOrder
@@ -123,0 +144,0 @@

No alert changes

Improved metrics

Total package byte prevSize

51852

increased by1%

Number of lines in readme file

172

increased by13.91%

No dependency changes