Remove buy orders by id (v2)

POST/v2/remove-buy-order

Remove up to 1000 of your orders by id. Ids that are not your open orders are ignored; removed is how many were removed, and 0 is still a success.

Every removed order is recorded in GET /v2/buy-order-history with kind = cancelled and reason = user.

Rate limit. Create, edit and both removals share one budget: 10 requests per 10 seconds per account, on the v1 and v2 paths together. Over it the answer is HTTP 429 with Retry-After and msBeforeNext.

Errors. Refusals are HTTP 200 with {"success": false, "msg": "…", "code": "…"}. Branch on code: it is stable, msg is human text. Codes this method answers: invalid_request, too_many_ids, busy, error. The full list is on POST /v2/create-buy-order. A missing or wrong API key is HTTP 403; the write rate limit is HTTP 429.

Prices are integers. 1000 = $1.00 USD.

Parameters

Name	Location	Type	Description
`api` required	query	string	Your WAXPEER API key

Request body

Name	Location	Type	Description
`ids` required	body	array<integer>	1 to 1000 order ids

Example

{
  "ids": [
    123,
    124
  ]
}

Responses

200 Successful operation or refusal

Name	Type	Description
`success` optional	boolean	Whether the operation succeeded
`removed` optional	integer	How many orders were removed
`msg` optional	string	Why the request was refused (only when success is false)
`code` optional	enum	Stable refusal code (only when success is false) enum: invalid_request, invalid_price, invalid_amount, invalid_filters, filters_not_editable, item_not_found, price_too_low, kyc_required, tradelink_required, price_above_balance, exposure_limit, too_many_orders, order_not_found, too_many_ids, busy, error

Response

{
  "success": true,
  "removed": 2
}

400 Body is not a JSON object

Name	Type	Description
`success` optional	boolean	Whether the operation succeeded
`msg` optional	string	Why the request was refused (only when success is false)
`code` optional	enum	Stable refusal code (only when success is false) enum: invalid_request, invalid_price, invalid_amount, invalid_filters, filters_not_editable, item_not_found, price_too_low, kyc_required, tradelink_required, price_above_balance, exposure_limit, too_many_orders, order_not_found, too_many_ids, busy, error

Response

{
  "success": false,
  "msg": "Invalid request",
  "code": "invalid_request"
}

429 Too many requests. Rate limit exceeded

Name	Type	Description
`success` optional	boolean	Whether the operation succeeded
`msg` optional	string	Why the request was refused (only when success is false)
`msBeforeNext` optional	number	Milliseconds before next allowed request

Response

{
  "success": false,
  "msg": "string",
  "msBeforeNext": 0
}