Documentation Hub

This docs set is meant to cover the full public runtime surface of csfloat-node-sdk:

• CsfloatSdk resources
• sdk.client and CsfloatHttpClient
• workflow helpers
• builder/helper/constant exports from the package root
• CLI commands
• the stability and coverage notes needed to use the SDK responsibly

If you are reading this from the published npm package, these files ship in the tarball.

Recommended Reading Order

1. Getting Started Install, first client, first requests, and where to go next.
2. Resources, Workflows, And Surface Map Which surface to use for each kind of task.
3. Resource Reference The method-level reference for sdk.meta, sdk.account, sdk.listings, and the rest.
4. Helpers, Builders, And Constants Every exported helper module and the constants that shape queries or requests.
5. Write Flows And Payloads Minimal valid payloads, field meanings, and caveats for mutation-heavy SDK usage.
6. Workflows And CLI The higher-level orchestration layer plus the published CLI commands.
7. Transport, Errors, And Metadata CsfloatHttpClient, retries, pacing, metadata responses, and error handling.
8. Examples And Recipes Runnable examples plus copyable snippets for common flows.
9. Stability And Coverage How to interpret implemented vs low-level vs account-gated behavior.
10. API_COVERAGE.md Endpoint-level truth for validated and discovered routes.

Choose By Task

• First request or install help: Getting Started
• Which resource or helper to reach for: Resources, Workflows, And Surface Map
• Exact public methods on each resource: Resource Reference
• Exported builders, presets, constants, and pagination helpers: Helpers, Builders, And Constants
• Minimal payloads for write-heavy and operator-heavy calls: Write Flows And Payloads
• High-level snapshot helpers or CLI usage: Workflows And CLI
• Transport behavior, retries, rate limits, or raw metadata: Transport, Errors, And Metadata
• Copyable code for real tasks: Examples And Recipes
• Support confidence, caveats, and route truth: Stability And Coverage and API_COVERAGE.md

What This Docs Set Covers

• every public runtime entrypoint exported from the package root
• every SDK resource and workflow method
• the helper functions and constants that materially affect day-to-day usage
• the published CLI surface
• the transport and error model

The root package also exports a very large TypeScript type surface. These docs call out the important request and response types by area, but the generated .d.ts files and your IDE remain the authoritative field-level reference.

Where Different Kinds Of Truth Live

• Product overview and install snippet: README.md
• Runtime docs: docs/*.md
• Endpoint-by-endpoint validation and discovery notes: API_COVERAGE.md
• Release history: CHANGELOG.md
• Executable examples: examples/*.mjs
• Tests for supported behavior: test/*.test.ts