# 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.
TIP
- Buy and sell methods always create the
taker
order first. Ataker
order must pay adexfee
during the swap as it is taking liquidity from the market. Thedexfee
is calculated as "the greater of eitherMinimum transaction amount (dust) TAKER COIN
or0.0001 TAKER COIN
or1/777th
the size of the desired order". If yourGoodTillCancelled
order is not matched in 30 seconds, the order is automatically converted to amaker
request and stays on the orderbook until the request is matched or cancelled. To always act as a maker, please use the setprice method. - 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
argument for more info.
# Arguments
Structure | Type | Description |
---|---|---|
base | string | the name of the coin the user desires to sell |
rel | string | the name of the coin the user desires to receive |
price | numeric string or rational | the price in rel the user is willing to receive per one unit of the base coin |
volume | numeric string or rational | the amount of coins the user is willing to sell of the base coin; the following values must be greater than or equal to the min_trading_vol of the corresponding coin:
|
min_volume | numeric 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:
|
match_by | object | the created order is matched using this condition; important: this condition is not applied after GoodTillCancelled order conversion to maker request |
match_by.type | string | Any to match with any other order; Orders to select specific uuids; Pubkeys to select specific nodes; Default is Any |
match_by.data | array of strings | uuids of orders to match for Orders type; pubkeys of nodes to match for Pubkeys type |
order_type | object | the type of the order |
order_type.type | string | there are two types from which to choose: GoodTillCancelled and FillOrKill . The GoodTillCancelled order is automatically converted to a maker order if the order is not matched in 30 seconds, and this maker order stays in the orderbook until explicitly cancelled. On the other hand, a FillOrKill order is cancelled if it is not matched within 30 seconds. The default type is GoodTillCancelled |
base_confs | number | number of required blockchain confirmations for base coin atomic swap transaction; default to base coin configuration if not set |
base_nota | bool | whether dPoW notarization is required for base coin atomic swap transaction; default to base coin configuration if not set |
rel_confs | number | number of required blockchain confirmations for rel coin atomic swap transaction; default to rel coin configuration if not set |
rel_nota | bool | whether dPoW notarization is required for rel coin atomic swap transaction; default to rel coin configuration if not set |
save_in_history | boolean | Defaults 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
Structure | Type | Description |
---|---|---|
result | object | the resulting order object |
result.action | string | the action of the request (Sell ) |
result.base | string | the base currency of the request |
result.base_amount | string | the resulting amount of base currency that is sold if the order matches (in decimal representation) |
result.base_amount_rat | rational | the resulting amount of base currency that is sold if the order matches (in rational representation) |
result.rel | string | the rel currency of the request |
result.rel_amount | string | the minimum amount of rel coin that must be received in order to sell the base_amount of base (according to price , in decimal representation) |
result.rel_amount_rat | rational | the minimum amount of rel coin that must be received in order to sell the base_amount of base (according to price , in rational representation) |
result.method | string | this field is used for internal P2P interactions; the value is always equal to "request |
result.dest_pub_key | string | reserved 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 |
result.sender_pubkey | string | the public key of our node |
result.uuid | string | the request uuid |
result.match_by | object | the created order is matched using this condition |
result.match_by.type | string | Any to match with any other order; Orders to select specific uuids; Pubkeys to select specific nodes; Default is Any |
result.match_by.data | array of strings | uuids of orders to match for Orders type; pubkeys of nodes to match for Pubkeys type |
result.conf_settings.base_confs | number | number of required blockchain confirmations for base coin atomic swap transaction |
result.conf_settings.base_nota | bool | whether dPoW notarization is required for base coin atomic swap transaction |
result.conf_settings.rel_confs | number | number of required blockchain confirmations for rel coin atomic swap transaction |
result.conf_settings.rel_nota | bool | whether dPoW notarization is required for rel coin atomic swap transaction |
result.base_orderbook_ticker | string | the 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. |
result.rel_orderbook_ticker | string | the 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)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"method\": \"sell\",
\"base\": \"BASE\",
\"rel\": \"REL\",
\"volume\": \"1\",
\"price\": \"1\"
}"
# Command (rational representation in num-rational crate format)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"method\": \"sell\",
\"base\": \"BASE\",
\"rel\": \"REL\",
\"volume\": [[1,[1]],[1,[1]]],
\"price\":[[1,[1]],[1,[1]]]
}"
# Command (rational representation as a fraction object)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"method\": \"sell\",
\"base\": \"HELLO\",
\"rel\": \"WORLD\",
\"volume\": {
\"numer\": \"3\",
\"denom\": \"2\"
},
\"price\": {
\"numer\": \"2\",
\"denom\": \"1\"
}
}"
# Command (with confirmations and notarization settings)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"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)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"method\": \"sell\",
\"base\": \"TKL\",
\"rel\": \"DUST\",
\"volume\": {
\"numer\": \"5\",
\"denom\": \"2\"
},
\"price\": {
\"numer\": \"9\",
\"denom\": \"4\"
},
\"save_in_history\": false
}"
# Command (GoodTillCancelled type)
curl --url "http://127.0.0.1:7783" --data "{\"userpass\": \"$userpass\",\"method\": \"sell\",\"base\": \"BASE\",\"rel\": \"REL\",\"volume\":[[1,[1]],[1,[1]]],\"price\":[[1,[1]],[1,[1]]],\"order_type\": {\"type\": \"GoodTillCancelled\"}}"
# Command (FillOrKill type)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"method\": \"sell\",
\"base\": \"BASE\",
\"rel\": \"REL\",
\"volume\": [[1,[1]],[1,[1]]],
\"price\": [[1,[1]],[1,[1]]],
\"order_type\": {
\"type\": \"FillOrKill\"
}
}"
# Command (match by Any)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"method\": \"sell\",
\"base\": \"BASE\",
\"rel\": \"REL\",
\"volume\":[[1,[1]],[1,[1]]],
\"price\":[[1,[1]],[1,[1]]],
\"match_by\": {
\"type\": \"Any\"
}
}"
# Command (match by Pubkeys)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"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)
curl --url "http://127.0.0.1:7783" --data "{
\"userpass\": \"$userpass\",
\"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\"
]
}
}"