> ## 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.

# Full price-list snapshot (gzipped NDJSON)

> Full gzipped NDJSON dump of the price list — one price row JSON per line. Use this for full-catalog ingestion (e.g. comparison sites), not pagination. Rate limited to 1 request/minute. Supports ETag / If-None-Match: an unchanged snapshot returns 304 Not Modified.



## OpenAPI

````yaml /openapi.json get /prices/snapshot.ndjson.gz
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.
paths:
  /prices/snapshot.ndjson.gz:
    get:
      tags:
        - Market data
      summary: Full price-list snapshot (gzipped NDJSON)
      description: >-
        Full gzipped NDJSON dump of the price list — one price row JSON per
        line. Use this for full-catalog ingestion (e.g. comparison sites), not
        pagination. Rate limited to 1 request/minute. Supports ETag /
        If-None-Match: an unchanged snapshot returns 304 Not Modified.
      operationId: getPriceSnapshot
      parameters:
        - name: If-None-Match
          in: header
          description: >-
            Conditional request. Pass the ETag from a previous snapshot to
            receive 304 if unchanged.
          schema:
            type: string
      responses:
        '200':
          description: >-
            Gzipped NDJSON stream. Each decompressed line is one PriceRow JSON
            object. Sets an ETag header.
          headers:
            ETag:
              description: >-
                Opaque snapshot version. Send back as If-None-Match to skip
                unchanged downloads.
              schema:
                type: string
          content:
            application/x-ndjson:
              schema:
                type: string
                format: binary
        '304':
          description: Not Modified — the snapshot has not changed since the ETag you sent.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unauthorized
            message: Missing or invalid API key.
    RateLimited:
      description: Rate limit exceeded. Includes a Retry-After header.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: rate_limit_exceeded
            message: Too many requests.
  schemas:
    Error:
      type: object
      description: >-
        All errors return { code, detail }. Some carry extra fields (e.g.
        price_moved adds current_total_usd, insufficient_balance adds
        required_usd/current_usd).
      properties:
        code:
          type: string
          description: >-
            Machine-readable error code, e.g. rate_limit_exceeded,
            trading_not_enabled, price_moved.
        detail:
          type: string
          description: Human-readable explanation.
      required:
        - code
  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.

````