latest contributor to this doc

Last Edit: @smk762 ,

update_maker_order

update_maker_order uuid (new_price volume_delta max base_confs base_nota rel_confs rel_nota min_volume)

The update_maker_order method updates an active order on the orderbook created before by setprice, and it relies on this node acting as a maker, also called a Bob node.

To prevent a user from making trades in which the transaction fees may end up costing a significant portion of the value of the trade, we have set a lower limit to the value of a trade. See the description of the volume_delta and min_volume arguments for more info.

StructureTypeDescription
uuidstringthe uuid of the order the user desires to update
new_pricenumeric string or rational (optional)the price in rel the user is willing to receive per one unit of the base coin
volume_deltanumeric string or rational (optional)volume added to or subtracted from the max_base_vol of the order to be updated, resulting in the new volume which is the maximum amount of base coin available for the order, ignored if max is true; the following values must be greater than or equal to the min_trading_vol of the corresponding coin:
  • the new volume which is the max_base_vol of the order to be updated plus volume_delta
  • the product of the new volume and the argument new_price
min_volumenumeric string or rational (optional)the minimum amount of base coin available for the order; it must be less or equal than the new volume; the following values must be greater than or equal to the min_trading_vol of the corresponding coin:
  • the argument min_volume
  • the product of the arguments min_volume and new_price
maxbool (optional)AtomicDEX API will use the entire coin balance for the order, taking 0.001 coins into reserve to account for fees
base_confsnumber (optional)number of required blockchain confirmations for base coin atomic swap transaction; default to base coin configuration if not set
base_notabool (optional)whether dPoW notarization is required for base coin atomic swap transaction; default to base coin configuration if not set
rel_confsnumber (optional)number of required blockchain confirmations for rel coin atomic swap transaction; default to rel coin configuration if not set
rel_notabool (optional)whether dPoW notarization is required for rel coin atomic swap transaction; default to rel coin configuration if not set

StructureTypeDescription
basestringthe base coin of the order
relstringthe rel coin of the order
pricestring (numeric)the expected amount of rel coin to be received per 1 unit of base coin; decimal representation
price_ratrationalthe expected amount of rel coin to be received per 1 unit of base coin; rational representation
max_base_volstring (numeric)the maximum volume of base coin available to trade; decimal representation
max_base_vol_ratrationalthe maximum volume of base coin available to trade; rational representation
min_base_volstring (numeric)AtomicDEX API won't match with other orders that attempt to trade less than min_base_vol; decimal representation
min_base_vol_ratrationalAtomicDEX API won't match with other orders that attempt to trade less than min_base_vol; rational representation
created_atnumberunix timestamp in milliseconds, indicating the order creation time
updated_atnumberunix timestamp in milliseconds, indicating the order update time
matchesobjectcontains the map of ongoing matches with other orders, empty as the order was recently created
started_swapsarray of stringsuuids of swaps that were initiated by the order
uuidstringuuid of the updated order
conf_settingsobjectA standard ConfSettings object.

POST
update_maker_order
{
  "userpass": "testpsw",
  "method": "update_maker_order",
  "uuid": "6a242691-6c05-474a-85c1-5b3f42278f41",
  "new_price": "0.9",
  "volume_delta": "1"
}

POST
update_maker_order
{
  "userpass": "testpsw",
  "method": "update_maker_order",
  "uuid": "6a242691-6c05-474a-85c1-5b3f42278f41",
  "new_price": "0.9",
  "max": true
}

POST
update_maker_order
{
  "userpass": "testpsw",
  "method": "update_maker_order",
  "uuid": "6a242691-6c05-474a-85c1-5b3f42278f41",
  "volume_delta": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "new_price": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ]
}

POST
update_maker_order
{
  "userpass": "testpsw",
  "method": "update_maker_order",
  "uuid": "6a242691-6c05-474a-85c1-5b3f42278f41",
  "volume_delta": {
    "numer": "3",
    "denom": "2"
  },
  "new_price": {
    "numer": "2",
    "denom": "1"
  }
}

POST
update_maker_order
{
  "userpass": "testpsw",
  "method": "update_maker_order",
  "uuid": "6a242691-6c05-474a-85c1-5b3f42278f41",
  "volume_delta": {
    "numer": "3",
    "denom": "2"
  },
  "new_price": {
    "numer": "2",
    "denom": "1"
  },
  "min_volume": "1"
}

POST
update_maker_order
{
  "userpass": "testpsw",
  "method": "update_maker_order",
  "uuid": "6a242691-6c05-474a-85c1-5b3f42278f41",
  "volume_delta": {
    "numer": "3",
    "denom": "2"
  },
  "new_price": {
    "numer": "2",
    "denom": "1"
  },
  "base_confs": 2,
  "base_nota": true,
  "rel_confs": 5,
  "rel_nota": false
}