Instant Sell
POST /v1/sell/orders/{id}/cancel: Cancel an Instant Sell Order
Cancel a sell order before the seller accepts any of its trade offers.
POST
/
sell
/
orders
/
{id}
/
cancel
Cancel a sell order
curl --request POST \
--url https://csboard.com/v1/sell/orders/{id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/sell/orders/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://csboard.com/v1/sell/orders/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://csboard.com/v1/sell/orders/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://csboard.com/v1/sell/orders/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://csboard.com/v1/sell/orders/{id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/sell/orders/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"app_id": 123,
"status": "pending",
"currency": "USD",
"total_usd": 123,
"credited_usd": 123,
"created_at": "2023-11-07T05:31:56Z",
"trade_offer_ids": [
"<string>"
],
"offers": [
{
"offer_group": "<string>",
"trade_offer_id": "<string>",
"status": "pending",
"amount_usd": 123,
"expires_at": "2023-11-07T05:31:56Z",
"items": [
{
"asset_id": "<string>",
"market_hash_name": "<string>",
"price_usd": 123,
"status": "pending"
}
],
"bot": {
"name": "<string>",
"avatar": "<string>",
"steam_id": "<string>",
"profile_url": "<string>",
"level": 123
}
}
],
"external_id": "<string>",
"unhold_at": "2023-11-07T05:31:56Z",
"fail_reason": "<string>"
}{
"code": "missing_api_key",
"detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}{
"code": "order_not_found",
"detail": "No such sell order on this account."
}{
"code": "not_cancellable",
"detail": "Only pending or offer_sent orders can be cancelled."
}Cancel a sell order while it is
pending or offer_sent and no offer has been accepted. Nothing has been credited at that point, so nothing is reversed. Once the seller accepts an offer the order can no longer be cancelled.
The Steam trade offer itself is not withdrawn. Its items stay committed until that offer expires, so selling them again right away answers 409 active_order_exists.
Authentication required. Send your key as Authorization: Bearer csb_pub_....
Path parameters
Response fields
The sell order after cancelling, in the shape described onPOST /v1/sell/orders.
Example request
curl -X POST https://csboard.com/v1/sell/orders/cmgk2x9a10001qs01sell0001/cancel \
-H "Authorization: Bearer csb_pub_..."
Error codes
| HTTP status | Code | Meaning |
|---|---|---|
| 401 | invalid_api_key | Missing or invalid API key. |
| 404 | order_not_found | No such sell order on your account. |
| 409 | not_cancellable | The order is past offer_sent, or one of its offers was already accepted. |
Authorizations
Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile. Calls made with a key are metered only by that key's own limits — there is no per-IP limit on top — and every answer carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and X-RateLimit-Bucket for the bucket the call spent. See Rate limits.
Response
The order after cancelling.
⌘I
Cancel a sell order
curl --request POST \
--url https://csboard.com/v1/sell/orders/{id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/sell/orders/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://csboard.com/v1/sell/orders/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://csboard.com/v1/sell/orders/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://csboard.com/v1/sell/orders/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://csboard.com/v1/sell/orders/{id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/sell/orders/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"app_id": 123,
"status": "pending",
"currency": "USD",
"total_usd": 123,
"credited_usd": 123,
"created_at": "2023-11-07T05:31:56Z",
"trade_offer_ids": [
"<string>"
],
"offers": [
{
"offer_group": "<string>",
"trade_offer_id": "<string>",
"status": "pending",
"amount_usd": 123,
"expires_at": "2023-11-07T05:31:56Z",
"items": [
{
"asset_id": "<string>",
"market_hash_name": "<string>",
"price_usd": 123,
"status": "pending"
}
],
"bot": {
"name": "<string>",
"avatar": "<string>",
"steam_id": "<string>",
"profile_url": "<string>",
"level": 123
}
}
],
"external_id": "<string>",
"unhold_at": "2023-11-07T05:31:56Z",
"fail_reason": "<string>"
}{
"code": "missing_api_key",
"detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}{
"code": "order_not_found",
"detail": "No such sell order on this account."
}{
"code": "not_cancellable",
"detail": "Only pending or offer_sent orders can be cancelled."
}