Market Data
GET /v1/listings/availability — Bulk Availability Check
Check whether up to 100 CSBoard listings are still buyable in a single request, with the live price of each available id and a list of unavailable ids.
GET
/
listings
/
availability
Bulk availability check
curl --request GET \
--url https://csboard.com/v1/listings/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/listings/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://csboard.com/v1/listings/availability', 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/listings/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/listings/availability"
req, _ := http.NewRequest("GET", 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.get("https://csboard.com/v1/listings/availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/listings/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"available": {
"itm_8841201": 14.37,
"itm_8841340": 12.1
},
"unavailable_ids": [
"itm_8841999"
]
}
}{
"code": "unsupported_game",
"detail": "appId 440 is not available to this key. Supported: 730 (CS2), 570 (Dota 2), 252490 (Rust).",
"supported_app_ids": [
730,
570,
252490
]
}{
"code": "missing_api_key",
"detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}{
"code": "invalid_request",
"detail": "Provide between 1 and 100 ids in the ids parameter."
}{
"code": "rate_limit_exceeded",
"detail": "Rate limit of 100 requests/min exceeded."
}Before placing a batch order, confirm the listings you intend to buy are still available. Pass up to 100 listing ids as a comma-separated
ids parameter; the response gives the live price of every id still available and lists the ids that are gone.
Authentication required. Send your key as Authorization: Bearer csb_pub_....
Query parameters
string
required
Comma-separated listing ids, e.g.
itm_8841201,itm_8841340. Required. Maximum 100 ids per request.integer
default:"730"
Game the ids belong to:
730 = CS2, 570 = Dota 2, 252490 = Rust. Use the same appId you read the ids with from GET /v1/listings.Response fields
object
required
Example request
curl "https://csboard.com/v1/listings/availability?ids=itm_8841201,itm_8841340,itm_8841999" \
-H "Authorization: Bearer csb_pub_..."
Example response
{
"data": {
"available": {
"itm_8841201": 14.37,
"itm_8841340": 12.1
},
"unavailable_ids": ["itm_8841999"]
}
}
Error codes
| HTTP status | Code | Meaning |
|---|---|---|
| 400 | unsupported_game | Your key cannot use this appId. supported_app_ids lists the ones it can. |
| 401 | missing_api_key / invalid_api_key | Missing or invalid API key. |
| 422 | invalid_request | ids was omitted, or more than 100 ids were supplied. |
| 429 | rate_limit_exceeded | Too many requests. Back off for the Retry-After header value. |
Availability is a point-in-time snapshot. An id reported as available can still sell out before your purchase executes — always send
max_price_usd and handle item_unavailable on the buy call.Authorizations
Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.
Query Parameters
Comma-separated listing ids. Required. Maximum 100 ids per request.
Steam appId of the game. 730 = CS2 (the default), 570 = Dota 2, 252490 = Rust. Omit it and the endpoint answers for CS2 exactly as before. An appId this key may not use answers 400 unsupported_game, whose supported_app_ids lists the ones it may — see GET /games.
Available options:
730, 570, 252490 Response
Availability map for the requested ids.
Show child attributes
Show child attributes
⌘I
Bulk availability check
curl --request GET \
--url https://csboard.com/v1/listings/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/listings/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://csboard.com/v1/listings/availability', 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/listings/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/listings/availability"
req, _ := http.NewRequest("GET", 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.get("https://csboard.com/v1/listings/availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/listings/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"available": {
"itm_8841201": 14.37,
"itm_8841340": 12.1
},
"unavailable_ids": [
"itm_8841999"
]
}
}{
"code": "unsupported_game",
"detail": "appId 440 is not available to this key. Supported: 730 (CS2), 570 (Dota 2), 252490 (Rust).",
"supported_app_ids": [
730,
570,
252490
]
}{
"code": "missing_api_key",
"detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}{
"code": "invalid_request",
"detail": "Provide between 1 and 100 ids in the ids parameter."
}{
"code": "rate_limit_exceeded",
"detail": "Rate limit of 100 requests/min exceeded."
}