Skip to content

docs: add API Reference section (JSON-RPC documentation) - #31

Merged
AnilChinchawale merged 2 commits into
XinFinOrg:mainfrom
AnilChinchawale:feature/api-reference
Jan 27, 2026
Merged

docs: add API Reference section (JSON-RPC documentation)#31
AnilChinchawale merged 2 commits into
XinFinOrg:mainfrom
AnilChinchawale:feature/api-reference

Conversation

@AnilChinchawale

Copy link
Copy Markdown
Member

Summary

Adds comprehensive API reference documentation for developers integrating with XDC.

New Files

  • docs/api/index.md - API overview
  • docs/api/json-rpc.md - JSON-RPC method reference

Why

Developers need clear API documentation to build on XDC. This provides a central reference for all RPC methods.

🔷

This PR consolidates and expands API documentation:

- docs/api/index.md - API overview with quick start examples
- docs/api/json-rpc.md - Complete JSON-RPC method reference

Includes:
- Multiple language examples (JavaScript, Python, cURL)
- All common eth_ methods documented
- Request/response examples
- Batch request support
- RPC endpoints for mainnet and testnet
@coderabbitai

coderabbitai Bot commented Jan 27, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@AnilChinchawale has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 3 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jan 27, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-01-27 11:58 UTC

@AnilChinchawale
AnilChinchawale merged commit ca468bd into XinFinOrg:main Jan 27, 2026
3 checks passed
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.

2 participants