Update tickers, currencies, countries and transparency documentation - #252
Open
ricardobcl wants to merge 4 commits into
Open
Update tickers, currencies, countries and transparency documentation#252ricardobcl wants to merge 4 commits into
ricardobcl wants to merge 4 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the API reference documentation for market data, assets, countries, and reserve transparency to better reflect current API behavior (as verified against uphold/backend master), including corrected sample payloads and clarified authentication-dependent behavior.
Changes:
- Tickers: clarify legacy vs hyphenated currency-pair formats, document the bare
/v0/tickerroute, and clarify auth-dependent results. - Currencies: document additional response fields (
features,image,shortName) and clarify asset visibility/status semantics. - Countries + Transparency: broaden/clarify documented field values and update reserve-ledger auth requirements and ledger/Reservechain samples (including JSON fixes).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
_tickers.md |
Clarifies currency-pair formats and ticker endpoint behavior, including auth-dependent results and /v0/ticker default base currency. |
_currencies.md |
Adds undocumented asset fields to tables/samples and clarifies unauthenticated vs authenticated asset visibility plus status semantics. |
_countries.md |
Documents payment method as an open set and clarifies that blocked subdivisions are excluded from subdivision results. |
_transparency.md |
Updates reserve-ledger auth requirements and refreshes ledger/Reservechain samples, including corrected JSON and field presence changes. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+6
to
+9
| Currency pairs are represented in two formats: | ||
| pairs between two of the currencies supported early in Uphold's history (such as BTC, ETH, EUR, or USD) | ||
| are represented in concatenated form, e.g. `BTCUSD`, | ||
| while all other pairs are hyphenated, e.g. `SOL-USD`. |
ricardobcl
force-pushed
the
support/update-market-data-documentation
branch
from
August 23, 2026 22:37
33da9ac to
2207c24
Compare
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
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.
Description
Fixes drift between the market-data pages and the current API behavior, verified against
uphold/backendmaster._tickers.mdBTCUSD) and hyphenated for everything else (e.g.SOL-USD) — all samples previously showed only the legacy form. Added hyphenated entries to the list sample.GET /v0/tickerroute with its USD default explicitly._currencies.mdfeatures,imageandshortNameresponse fields to the table and samples (values taken from the controller and its tests).unavailableasset status, which is also the fallback when no status is known.codeexamples._countries.mdmethodfield is now documented as an open set: besidesach/card/sepa, alternative payment methods flow through (apple-pay,google-pay,interac,paypal,pix,spei,venmo— all verified in the backend transaction resolver)._transparency.mdreserve:readscope, issued to an application with theauthorization_codegrant. The sample now carries an Authorization header.inside (deposits) or theoutside (withdrawals).application,feesandpriorityfields returned by the public transaction mask.Notes for reviewers
_transparency.mddocuments no request routes for them; the routes (GET /v0/reserve/transactions[/:id]) live in_transactions.md.GET /v0/reserve/transactions/:id/sourcesremains undocumented everywhere — left out deliberately, flagging in case it should be added.Related issues
Follow-up to #250 (documentation audit against
uphold/backendmaster).Impacted areas
Tickers, Currencies, Countries and Transparency pages of the API reference.
Steps to reproduce or test
Development
Every claim was traced to the enforcing code in
uphold/backendmaster (ticker/asset/country/reserve controllers, exchange enums, ledger manager, transaction public mask).QA
Render the four pages; optionally hit
GET /v0/tickerunauthenticated vs authenticated and confirm hyphenated pairs appear for non-legacy assets.Checklist
Breaking Changeif it applies.package.json.Deploy notes
N/A — no files added or removed, so no slate index changes are needed.
🤖 Generated with Claude Code