docs(schema): clarify value field is decimal-scaled, not USD#536
Merged
Conversation
The `value` field returned on balances, holders, and transfers endpoints (EVM/SVM/TVM, regular and native) is computed as `amount / 10^decimals` — the human-readable token amount, not a USD valuation. The label was previously undocumented, leading consumers to interpret large balances as dollar values. Add a description on each schema so the OpenAPI export and SDK types make the semantics explicit. No behavioural change; same numbers are returned. Polymarket activity intentionally excluded — its `value` is USDC and genuinely is a dollar amount given USDC's 6 decimals. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
YaroShkvorets
temporarily deployed
to
fix/clarify-value-field-description - token-api PR #536
Render
Destroyed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
valuefield on balances, holders, and transfers endpoints (EVM/SVM/TVM, regular and native) is computed asamount / 10^decimals— the human-readable token amount, not a USD valuation. The label was previously undocumented, leading consumers to interpret a large balance as a dollar value (e.g. reading "value: 2.95e9" on a GRT holder as ~$2.95B)..describe(...)on each schema so the OpenAPI export and downstream SDK types make the semantics explicit.markets/activityintentionally excluded — itsvalueis USDC and genuinely is a dollar amount given USDC's 6 decimals.Closes #525.
🤖 Generated with Claude Code