Account
GET /v1/key — Inspect Your API Key
What this key can do: rate limits, trading and selling capabilities, IP allowlist, and the address we saw for your request.
GET
/
key
Inspect this key
curl --request GET \
--url https://csboard.com/v1/key \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/key"
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/key', 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/key",
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/key"
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/key")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/key")
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": {
"key_prefix": "csb_pub_Xk3f9aQz",
"issued_at": "2026-09-14T08:21:37.000Z",
"rate_limit_per_min": 100,
"rate_limits": {
"read_per_min": 100,
"trading_per_min": 3000,
"buy_orders_per_min": 250,
"listings_snapshot_downloads_per_hour": 6,
"price_snapshot_per_min": 1,
"stream_connections": 3
},
"trading_enabled": true,
"selling_enabled": false,
"allowed_ips": [],
"your_ip": "203.0.113.24"
}
}Returns the capabilities attached to the key you authenticated with, plus
your_ip — the address this request arrived from.
your_ip exists for one reason: editing an IP allowlist from a machine whose egress address you are not certain of is otherwise guesswork, and getting it wrong locks the key out. Read it here first, then apply the list.
Authentication required. Send your key as Authorization: Bearer csb_pub_....
Rate limits
rate_limits lists every ceiling this key meets, per minute unless the field name says otherwise. No per-IP limit applies on top of them. See Rate limits for which endpoints count against which bucket.
| Field | Ceiling |
|---|---|
read_per_min | Reads and every other keyed call outside trading — listings, prices, games, currency, webhooks, P2P. 100 by default; it can be raised on request. |
trading_per_min | Buys, order reads, claims, cancels and GET /v1/balance. 3000, or read_per_min if that is higher. |
buy_orders_per_min | POST /v1/orders and POST /v1/market/buy, on top of trading_per_min. |
listings_snapshot_downloads_per_hour | Full downloads of GET /v1/listings/snapshot.ndjson.gz. A 304 is free. |
price_snapshot_per_min | GET /v1/prices/snapshot.ndjson.gz. |
stream_connections | Concurrent GET /v1/listings/stream connections. |
rate_limit_per_min stays for existing clients. It is the same number as rate_limits.read_per_min.
Example response
{
"data": {
"key_prefix": "csb_pub_Xk3f9aQz",
"issued_at": "2026-09-14T08:21:37.000Z",
"rate_limit_per_min": 100,
"rate_limits": {
"read_per_min": 100,
"trading_per_min": 3000,
"buy_orders_per_min": 250,
"listings_snapshot_downloads_per_hour": 6,
"price_snapshot_per_min": 1,
"stream_connections": 3
},
"trading_enabled": true,
"selling_enabled": false,
"allowed_ips": [],
"your_ip": "203.0.113.24"
}
}
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
200 - application/json
Key capabilities.
Show child attributes
Show child attributes
⌘I
Inspect this key
curl --request GET \
--url https://csboard.com/v1/key \
--header 'Authorization: Bearer <token>'import requests
url = "https://csboard.com/v1/key"
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/key', 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/key",
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/key"
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/key")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://csboard.com/v1/key")
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": {
"key_prefix": "csb_pub_Xk3f9aQz",
"issued_at": "2026-09-14T08:21:37.000Z",
"rate_limit_per_min": 100,
"rate_limits": {
"read_per_min": 100,
"trading_per_min": 3000,
"buy_orders_per_min": 250,
"listings_snapshot_downloads_per_hour": 6,
"price_snapshot_per_min": 1,
"stream_connections": 3
},
"trading_enabled": true,
"selling_enabled": false,
"allowed_ips": [],
"your_ip": "203.0.113.24"
}
}