From 49038d26ed19734f8d8fb41876214537e9a3ad98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Tom=C3=A9=20Gon=C3=A7alves?= Date: Sun, 23 Aug 2026 22:44:59 +0100 Subject: [PATCH 1/4] Update tickers documentation --- _tickers.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/_tickers.md b/_tickers.md index 0b1419c..3bdcbb6 100644 --- a/_tickers.md +++ b/_tickers.md @@ -3,6 +3,9 @@ At any time, you can query the rates we utilize when exchanging one form of value for another. These are expressed in [currency pairs](#currency-pair-object). +Currency pairs are represented in two formats, both in the `pair` field of ticker responses and in the pair-based request paths below. +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`. + ## Get Tickers for Currency ```bash @@ -192,6 +195,12 @@ curl https://api.uphold.com/v0/ticker/USD "currency": "USD", "pair": "SGDUSD" }, +{ + "ask": "165.62", + "bid": "165.44", + "currency": "USD", + "pair": "SOL-USD" +}, { "ask": "3.67302", "bid": "3.67302", @@ -372,6 +381,12 @@ curl https://api.uphold.com/v0/ticker/USD "currency": "SGD", "pair": "USDSGD" }, +{ + "ask": "0.00604", + "bid": "0.00603", + "currency": "SOL", + "pair": "USD-SOL" +}, { "ask": "7.20046083", "bid": "7.18752246", @@ -452,10 +467,18 @@ Lists all exchange rates relative to a given currency. `GET https://api.uphold.com/v0/ticker/:currency` +`GET https://api.uphold.com/v0/ticker` + +If no currency is specified on the endpoint — i.e. the bare `GET /v0/ticker` route — USD is used as the base currency. + ### Response -Returns an associative array containing the current rates Uphold has on record for the currency specified. -If no currency is specified on the endpoint, USD currency pair will be returned by default. +Returns a JSON array of objects containing the current rates Uphold has on record for the currency specified. + +The results depend on authentication: +unauthenticated requests return rates for publicly available currencies only, +while authenticated requests may also include rates for additional currencies available to the current user. +Requesting a non-public currency without authentication results in a 404 error. ## Get Tickers for Currency Pair From 0676c027cf3e5aba22910184df3252e67777a515 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Tom=C3=A9=20Gon=C3=A7alves?= Date: Sun, 23 Aug 2026 22:44:59 +0100 Subject: [PATCH 2/4] Update currencies documentation --- _currencies.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/_currencies.md b/_currencies.md index 56b305e..ea790c1 100644 --- a/_currencies.md +++ b/_currencies.md @@ -28,26 +28,32 @@ curl https://api.uphold.com/v0/assets [ { "code": "BTC", + "features": ["buy", "deposit", "sell", "transfer", "withdraw"], "formatting": { "decimal": ".", "format": "__symbol__ __value__ __code__", "grouping": ",", "precision": 8 }, + "image": "https://cdn.uphold.com/assets/BTC.svg", "name": "Bitcoin", + "shortName": "BTC", "status": "open", "symbol": "₿", "type": "cryptocurrency" }, { "code": "USD", + "features": ["buy", "deposit", "sell", "transfer", "withdraw"], "formatting": { "decimal": ".", "format": "__symbol__ __value__ __code__", "grouping": ",", "precision": 2 }, + "image": "https://cdn.uphold.com/assets/USD.svg", "name": "US Dollar", + "shortName": "USD", "status": "open", "symbol": "$", "type": "fiat" @@ -97,17 +103,20 @@ Get the list of supported currencies and other financial assets, with details as Property | Description ---------- | -------------------------------------------------------------------------------------------------------- -code | Uppercase abbreviation of the asset, e.g. "BTC", USD", "C", or "BRK.B". +code | Uppercase abbreviation of the asset, e.g. "BTC", "USD", or "BRK.B". +features | List of the operations currently enabled for the asset, e.g. `buy`, `deposit`, `sell`, `transfer`, and `withdraw`. formatting | Specification for user-facing display, including number formatting and placement of the code and symbol. +image | URL of an image representing the asset, e.g. its logo. name | Full name of the asset, e.g. "Euro", "Basic Attention Token", or "0x". +shortName | A shorter or alternative name for the asset, often the same as the code. status | Current trading status. See [below](#asset-status) for more details. symbol | A short and well-known representation of the asset, if one exists — e.g. "$", "₿", or "Kč". type | Type of asset. Possible values are `commodity`, `cryptocurrency`, `equity`, `fiat`, `stablecoin` and `utility_token`. -If the request is unauthenticated, the full list of assets supported by Uphold is returned. -Authenticated requests, on the other hand, will filter the output, -returning only the assets available for the current user, -which can depend on factors such as their country and state of residency. +If the request is unauthenticated, the list of publicly available assets is returned. +Authenticated requests, on the other hand, will adjust the output, +returning the assets available for the current user — which may include additional, non-public assets — +depending on factors such as their country and state of residency. The list of assets returned can also be filtered by `type` using a query string parameter, as shown in the example to the side. @@ -132,3 +141,5 @@ The possible values are: Most assets remain in this status save for exceptional circumstances, where they can become `halted`. Equities, on the other hand, will regularly transition between `open` and either `closed` or `extended`, depending on their availability for 24/7 operation. +* `unavailable` — the asset cannot currently be transacted. + This is also the fallback value, used when no status information is known for the asset. From 9854f68daf4f1caf5cfe2d864de107f65c5e64c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Tom=C3=A9=20Gon=C3=A7alves?= Date: Sun, 23 Aug 2026 22:44:59 +0100 Subject: [PATCH 3/4] Update countries documentation --- _countries.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_countries.md b/_countries.md index 95386ad..ad4fb24 100644 --- a/_countries.md +++ b/_countries.md @@ -142,7 +142,7 @@ Returns an array of payment objects containing two fields: Property | Description ---------- | -------------------------------------------------------------------------------------------------------- currency | The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency supported for this payment method in this country. -method | The type of payment method. One of "[ach](https://en.wikipedia.org/wiki/ACH_Network)", "[card](https://en.wikipedia.org/wiki/Credit_card)", or "[sepa](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area)". +method | The type of payment method, such as "[ach](https://en.wikipedia.org/wiki/ACH_Network)", "[card](https://en.wikipedia.org/wiki/Credit_card)", or "[sepa](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area)". Alternative payment methods can also appear, such as "apple-pay", "google-pay", "interac", "paypal", "pix", "spei", or "venmo".