Skip to content

API-3985: Add documentation for Stablecoin Balances endpoint#148

Open
shaneauerbach wants to merge 4 commits intomainfrom
shane/api-3985-stablecoin-docs
Open

API-3985: Add documentation for Stablecoin Balances endpoint#148
shaneauerbach wants to merge 4 commits intomainfrom
shane/api-3985-stablecoin-docs

Conversation

@shaneauerbach
Copy link
Collaborator

Summary

Adds documentation for the new Stablecoin Balances endpoint (/v1/evm/balances/{address}/stablecoins).

Changes

  • New page: evm/stablecoins.mdx - Dedicated documentation for the stablecoin endpoint
  • New OpenAPI spec: evm/openapi/stablecoins.json - API specification
  • Updated: docs.json - Added page to navigation and OpenAPI reference
  • Updated: evm/balances.mdx - Added tip about stablecoin filter option

Documentation Highlights

  • Documents three stablecoin types: Standard (USDC, USDT), Yield-bearing (sDAI), Euro-pegged (EURC)
  • Notes that Gnosis chain's native token xDAI is included as a stablecoin
  • Explains the alternative asset_class=stablecoin parameter on the main Balances endpoint
  • Same chain support as the Balances endpoint

Preview

The new page will appear in the sidebar under EVM > Stablecoin Balances, right after Balances.

Linear

Closes API-3985

🤖 Generated with Claude Code

- Add evm/stablecoins.mdx page documenting the dedicated stablecoin endpoint
- Add evm/openapi/stablecoins.json OpenAPI spec for /v1/evm/balances/{address}/stablecoins
- Update docs.json to add page to navigation and OpenAPI reference
- Update evm/balances.mdx to mention stablecoin filter option

The Stablecoin Balances endpoint is a specialized version of the Balances endpoint
that filters results to include only configured stablecoins (USD-pegged, yield-bearing,
and euro-pegged). It supports the same chains and parameters as the main Balances endpoint.

Notable feature: On Gnosis chain, the native token xDAI is included as a stablecoin.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add asset_class query param to balances.json (enum: stablecoin)
- Add missing query params to stablecoins.json (filters, exclude_spam_tokens)
- Add missing response fields to stablecoins.json (pool_size, low_liquidity, errors)
- Add BalanceErrors and BalanceErrorInformation schemas to stablecoins.json
- Fix doc wording: clarify stablecoin category is for filtering, not returned in response

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

cursor bot commented Feb 6, 2026

PR Summary

Low Risk
Documentation-only changes (new page/spec and minor docs updates) with no runtime or security-impacting code paths.

Overview
Adds documentation for a new EVM Stablecoin Balances endpoint (GET /v1/evm/balances/{address}/stablecoins), including a dedicated evm/stablecoins.mdx page and a full OpenAPI spec (evm/openapi/stablecoins.json).

Updates navigation and OpenAPI registration in docs.json, and enhances the existing balances docs/spec to point users to the stablecoin option (new tip in evm/balances.mdx and new asset_class=stablecoin query param in evm/openapi/balances.json).

Written by Cursor Bugbot for commit ca259d6. Configure here.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
These sections duplicate information already covered in the main
Balances endpoint documentation. Users can reference /evm/balances
for detailed information about token pricing and historical prices.

Co-Authored-By: Claude Opus 4.5 <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