Skip to content

docs(api): add Trading API integration guide#1108

Merged
ocandocrypto-uniswap merged 1 commit intomainfrom
docs/trading-api-integration-guide
Feb 3, 2026
Merged

docs(api): add Trading API integration guide#1108
ocandocrypto-uniswap merged 1 commit intomainfrom
docs/trading-api-integration-guide

Conversation

@codyborn
Copy link
Contributor

@codyborn codyborn commented Feb 3, 2026

Summary

Adds comprehensive Trading API documentation to the public docs site, providing external developers with everything they need to integrate with the Uniswap Trading API.

Changes

New Documentation:

File Lines Content
docs/api/trading/overview.md +130 Trading API overview with quick start
docs/api/trading/integration-guide.md +825 Complete integration guide
docs/api/trading/_category_.json +5 Sidebar configuration

Updated Files:

File Change
docs/api/overview.md Added Trading API section
docs/api/subgraph/_category_.json Reordered to position 3

Key Sections

The integration guide covers:

  • API Endpoints: Quote, Swap, Check Approval, EIP-5792/7702 variants, Cross-chain Plans
  • Schema Reference: TransactionRequest with critical data field validation
  • Permit2 Flow: EIP-712 signature requirements and field omission rules
  • Error Handling: HTTP status codes, common errors, revert scenarios
  • Best Practices: Quote freshness, gas management, slippage, retry logic
  • Troubleshooting: Common issues with checklists and solutions

Sidebar Order

The APIs section will now display:

APIs
├── Overview
├── Trading API (NEW)
│   ├── Overview
│   └── Integration Guide
└── Subgraph

Related

Based on internal documentation from PR https://github.com/Uniswap/backend/pull/5631

Test Plan

  • Verify docs build successfully
  • Confirm sidebar ordering is correct
  • Check all internal links work
  • Review code examples for accuracy

🤖 Generated with Claude Code

Add comprehensive Trading API documentation including:
- Overview page with quick start and architecture
- Integration guide with full schema reference
- Permit2 flow documentation with field requirements
- Error handling and troubleshooting guide
- Best practices for production integrations

Updates API overview to feature Trading API prominently
and reorders sidebar to show Trading API before Subgraph.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Feb 3, 2026 4:26pm

Request Review

@ocandocrypto-uniswap ocandocrypto-uniswap merged commit 4b8cae0 into main Feb 3, 2026
5 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