> ## Documentation Index
> Fetch the complete documentation index at: https://api.csboard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/key — Inspect Your API Key

> What this key can do: rate limit, trading and selling capabilities, IP allowlist, and the address we saw for your request.

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_...`.


## OpenAPI

````yaml GET /key
openapi: 3.1.0
info:
  title: CSBoard API
  version: 1.0.0
  description: >-
    Market data over the CSBoard marketplace — live listings, floats, stickers,
    minAsk prices, FX rates — plus opt-in buying straight from your balance.
    Free to read, key-gated, built for automation.
  contact:
    name: CSBoard
    url: https://csboard.com/docs
servers:
  - url: https://csboard.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Status
    description: Liveness and freshness probes.
  - name: Market data
    description: Read the live catalog, prices, and FX rates.
  - name: Trading
    description: Buy listings from your CSBoard balance. Opt-in, key-gated.
  - name: Account
    description: Your balance, settled funds, and trading status.
  - name: Webhooks
    description: Register an endpoint and receive signed order updates instead of polling.
paths:
  /key:
    get:
      tags:
        - Account
      summary: Inspect this key
      description: >-
        What this key is allowed to do: its prefix, issue date, rate limit,
        trading and selling capabilities, and its IP allowlist. Also reports
        `your_ip` — the address we saw for this request, which is what you need
        before editing an allowlist from a machine whose egress address you are
        unsure of.
      operationId: getKey
      responses:
        '200':
          description: Key capabilities.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      key_prefix:
                        type: string
                        nullable: true
                      issued_at:
                        type: string
                        format: date-time
                        nullable: true
                      rate_limit_per_min:
                        type: integer
                      trading_enabled:
                        type: boolean
                      selling_enabled:
                        type: boolean
                      allowed_ips:
                        type: array
                        items:
                          type: string
                        description: Empty means unrestricted.
                      your_ip:
                        type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your key as a Bearer token on every request: `Authorization: Bearer
        csb_pub_...`. Generate keys in your CSBoard profile.

````