Skip to content

Add documentation for token discovery and swap API endpoints#3

Open
ckorhonen wants to merge 2 commits intomainfrom
devin/1770403258-token-api-docs
Open

Add documentation for token discovery and swap API endpoints#3
ckorhonen wants to merge 2 commits intomainfrom
devin/1770403258-token-api-docs

Conversation

@ckorhonen
Copy link

@ckorhonen ckorhonen commented Feb 6, 2026

Summary

Adds developer documentation for the new token discovery and swap REST API endpoints introduced in os2-core#30466.

New documentation covers:

  • GET /api/v2/tokens/top - Top tokens by 24h volume
  • GET /api/v2/tokens/trending - Trending tokens
  • GET /api/v2/chain/{chain}/token/{address} - Token details
  • GET /api/v2/swap/quote - Swap quote with transaction data

Review & Testing Checklist for Human

  • Verify response schemas match actual API - The example responses were inferred from the implementation code; test against the actual API to confirm field names and structure
  • Verify parameter names - Confirm query parameter names (e.g., sell_token, buy_token, taker_address, sell_amount) match the actual API implementation
  • Test example curl commands - Run the documented curl examples against staging/production to verify they work
  • Verify ReadMe.com frontmatter - Confirm the category ID, slug, and parentDocSlug are correct for proper publishing

Recommended test plan:

  1. Deploy os2-core#30466 to staging
  2. Run the documented curl commands and compare responses to the examples
  3. Trigger the rdme docs publish workflow and verify the new page appears correctly on docs.opensea.io

Notes


Open with Devin

Co-Authored-By: Chris K <ckorhonen@gmail.com>
@devin-ai-integration
Copy link

Original prompt from Chris K
Can you prepare updates to developer docs based on changes in this PR:
https://github.com/ProjectOpenSea/os2-core/pull/30466


You only need to look in the following repo: ProjectOpenSea/developer-docs

@devin-ai-integration
Copy link

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration devin-ai-integration bot marked this pull request as ready for review February 6, 2026 20:58
Copy link

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

View 3 additional findings in Devin Review.

Open in Devin Review

Co-Authored-By: Chris K <ckorhonen@gmail.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