sell

sell base rel price volume (match_by order_type base_confs base_nota rel_confs rel_nota)

The sell method issues a sell request and attempts to match an order from the orderbook based on the provided arguments.

Arguments

StructureTypeDescription
basestringthe name of the coin the user desires to sell
relstringthe name of the coin the user desires to receive
pricenumeric string or rationalthe amount of rel coins the user wants to receive for each unit of the base coin spent.
volumenumeric string or rationalthe maximum amount of base coin available for sale in 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 argument volume
  • the product of the arguments volume and price
min_volumenumeric string or rational (optional)The amount of base coin that will be used as min_volume of GoodTillCancelled order after conversion to maker; 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 price
. Can be a numeric string, expressed using standard RationalValue or FractionalValue objects.
match_byobjectOptional. A standard MatchBy object, to filter to include only matches by pubkey or uuid. Important: This condition is not applied after a GoodTillCancelled order is converted to a maker request.
order_typeobjectOptional. A standard OrderType object.
base_confsnumbernumber of required blockchain confirmations for base coin atomic swap transaction; default to base coin configuration if not set
base_notaboolwhether dPoW notarization is required for base coin atomic swap transaction; default to base coin configuration if not set
rel_confsnumbernumber of required blockchain confirmations for rel coin atomic swap transaction; default to rel coin configuration if not set
rel_notaboolwhether dPoW notarization is required for rel coin atomic swap transaction; default to rel coin configuration if not set
save_in_historybooleanDefaults to true. If set to false no order history will be saved (though order status will be temporarily stored while in progress). If true, each order’s short record history is stored in a local SQLite database table, and when the order is cancelled or fully matched, it’s history will be saved as a json file

Response

StructureTypeDescription
actionstringthe action of the request (Sell)
basestringthe base currency of the request
base_amountnumeric stringthe resulting amount of base currency that is sold if the order matches, represented as a decimal value.
base_amount_ratrationalthe resulting amount of base currency that is sold if the order matches, represented as a standard RationalValue object.
relstringthe rel currency of the request
rel_amountstringthe minimum amount of rel coin that must be received in order to sell the base_amount of base (according to price, in decimal representation)
rel_amount_ratrationalthe minimum amount of rel coin that must be received in order to sell the base_amount of base (according to price, represented as a standard RationalValue object).
methodstringthis field is used for internal P2P interactions; the value is always equal to “request
dest_pub_keystringreserved for future use. The dest_pub_key allows the user to choose the P2P node that is eligible to match with the request. This value defaults to “zero pubkey”, meaning that anyone can match
sender_pubkeystringthe public key of our node
uuidstringthe request uuid
match_byobjectA standard MatchBy object, to filter to include only matches by pubkey or uuid. Important: This condition is not applied after a GoodTillCancelled order is converted to a maker request.
conf_settingsobjectA standard ConfSettings object.
base_orderbook_tickerstringthe ticker of the base currency if orderbook_ticker is configured for the base currency in coins file. If not defined, will return a null value.
rel_orderbook_tickerstringthe ticker of the rel currency if orderbook_ticker is configured for the rel currency in coins file. If not defined, will return a null value.

📌 Examples

Command (decimal representation)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "DOC",
  "rel": "MARTY",
  "price": 1.1,
  "volume": 2.4
}

Command (rational representation in num-rational crate format)

POST sell
{
  "result": {
    "base": "DOC",
    "rel": "MARTY",
    "base_amount": "2.4",
    "base_amount_rat": [
      [
        1,
        [
          12
        ]
      ],
      [
        1,
        [
          5
        ]
      ]
    ],
    "rel_amount": "2.64",
    "rel_amount_rat": [
      [
        1,
        [
          66
        ]
      ],
      [
        1,
        [
          25
        ]
      ]
    ],
    "action": "Sell",
    "uuid": "c6fccc24-8ad9-4de3-baad-122ba0f831d2",
    "method": "request",
    "sender_pubkey": "d8064eece4fa5c0f8dc0267f68cee9bdd527f9e88f3594a323428718c391ecc2",
    "dest_pub_key": "0000000000000000000000000000000000000000000000000000000000000000",
    "match_by": {
      "type": "Any"
    },
    "conf_settings": {
      "base_confs": 1,
      "base_nota": false,
      "rel_confs": 1,
      "rel_nota": false
    },
    "order_type": {
      "type": "GoodTillCancelled"
    },
    "min_volume": "0.0001",
    "min_volume_fraction": {
      "numer": "1",
      "denom": "10000"
    },
    "min_volume_rat": [
      [
        1,
        [
          1
        ]
      ],
      [
        1,
        [
          10000
        ]
      ]
    ],
    "base_orderbook_ticker": null,
    "rel_orderbook_ticker": null
  },
  "userpass": "RPC_UserP@SSW0RD"
}

Command (rational representation as a fraction object)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "HELLO",
  "rel": "WORLD",
  "volume": {
    "numer": "3",
    "denom": "2"
  },
  "price": {
    "numer": "2",
    "denom": "1"
  }
}

Command (with confirmations and notarization settings)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "HELLO",
  "rel": "WORLD",
  "volume": {
    "numer": "3",
    "denom": "2"
  },
  "price": {
    "numer": "2",
    "denom": "1"
  },
  "base_confs": 2,
  "base_nota": true,
  "rel_confs": 5,
  "rel_nota": false
}

Command (set to not save order history)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "TKL",
  "rel": "DUST",
  "volume": {
    "numer": "5",
    "denom": "2"
  },
  "price": {
    "numer": "9",
    "denom": "4"
  },
  "save_in_history": false
}

Command (GoodTillCancelled type)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "BASE",
  "rel": "REL",
  "volume": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "price": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "order_type": {
    "type": "GoodTillCancelled"
  }
}

Command (FillOrKill type)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "BASE",
  "rel": "REL",
  "volume": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "price": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "order_type": {
    "type": "FillOrKill"
  }
}

Command (match by Any)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "BASE",
  "rel": "REL",
  "volume": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "price": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "match_by": {
    "type": "Any"
  }
}

Command (match by Pubkeys)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "BASE",
  "rel": "REL",
  "volume": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "price": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "match_by": {
    "type": "Pubkeys",
    "data": [
      "1ab7edc96abaefb358b52c583048eaaeb8ea42609d096d6cddfafa02fa510c6a"
    ]
  }
}

Command (match by Orders)

POST sell
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "sell",
  "base": "BASE",
  "rel": "REL",
  "volume": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "price": [
    [
      1,
      [
        1
      ]
    ],
    [
      1,
      [
        1
      ]
    ]
  ],
  "match_by": {
    "type": "Orders",
    "data": [
      "d14452bb-e82d-44a0-86b0-10d4cdcb8b24"
    ]
  }
}