Skip to content

docs(api-and-sdk): add full public API reference#4

Open
pkucherenk0 wants to merge 1 commit into
masterfrom
add-public-api-reference
Open

docs(api-and-sdk): add full public API reference#4
pkucherenk0 wants to merge 1 commit into
masterfrom
add-public-api-reference

Conversation

@pkucherenk0

Copy link
Copy Markdown
Collaborator

Summary

  • Add a consolidated API Reference (Full) page at api-and-sdk/public-api-reference.md documenting the full public API.
  • Remove the legacy api/ section (per-service pages: auth, API keys, trading, market data, spot/perpetuals, WebSocket, error handling, reference).
  • Update SUMMARY.md: link the new reference under API & SDK and drop the old API navigation group.

Notes

  • Net change consolidates ~13 legacy API pages into one maintained reference (+4,728 / −6,014 lines).

🤖 Generated with Claude Code

Add a comprehensive public REST + WebSocket API reference page covering
authentication, market data, spot, perpetuals, transfers, and clearnet.

Sourced from the internal API.md, scoped to public/stable surface:
- excludes deprecated/removed legacy margin endpoints
- excludes dev-only (bitfaker) endpoints
- excludes internal Admin Service references

Wired into SUMMARY.md under API & SDK.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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