Skip to content

Conversation

@melonges
Copy link

@melonges melonges commented Nov 20, 2025

Note

Revamps README with installation steps, a modern quickstart example, authentication guidance, and a grouped method reference.

  • Docs:
    • Installation: Added npm/pnpm install instructions.
    • Quickstart: New example using ClobClient with chainId, API key derivation, SignatureType, optional funder, and createAndPostOrder usage.
    • Authentication cheatsheet: Clarifies L1 wallet signature vs L2 API key, signature types, and advanced constructor options.
    • Method reference: Consolidated and grouped endpoints for:
      • Market data (public)
      • API keys and auth
      • Orders and execution
      • Trades and notifications
      • Balances and allowances
      • Rewards
      • Builder API keys
    • Points to examples/ for runnable scripts.

Written by Cursor Bugbot for commit b75efde. This will update automatically on new commits. Configure here.

@melonges melonges requested a review from a team as a code owner November 20, 2025 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant