> ## Documentation Index
> Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve an asset
> Retrieve an asset and its supported network capabilities. Asset and network availability can differ.
```bash cURL
curl --request GET \
--url 'https://api-sandbox.uqpaytech.com/api/v1/stocks/asset/7453f146-b267-11f1-b4f4-0abd773ba497' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
```
```json 200
{
"asset": {
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "7453f146-b267-11f1-b4f4-0abd773ba497",
"symbol": "AAPLx",
"name": "Apple xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "334.85",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
"networks": [
{
"can_buy": true,
"can_sell": true,
"funding_currencies": [
"USDC"
],
"limits": [],
"multiplier": "1",
"network": "Ethereum",
"quantity_decimals": 18,
"token_id": "f8ae8432-14d6-4142-a733-8b989c33ecfb"
}
]
}
```
## OpenAPI
````yaml /stocks/stocks.yaml get /asset/{asset_id}
openapi: 3.0.3
info:
title: UQPAY Stocks API
version: 1.0.0
description: >-
Browse assets, request quotes, create orders, and query orders and
positions. Amounts and quantities use decimal strings.
servers:
- url: https://api-sandbox.uqpaytech.com/api/v1/stocks
description: Sandbox
security:
- AuthToken: []
paths:
/asset/{asset_id}:
get:
tags:
- Stocks
summary: Retrieve an asset
description: >-
Retrieve an asset and its supported network capabilities. Asset and
network availability can differ.
operationId: getStocksAsset
parameters:
- name: asset_id
in: path
required: true
schema:
type: string
format: uuid
description: Asset identifier returned by List assets.
example: 7453f146-b267-11f1-b4f4-0abd773ba497
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssetDetail'
examples:
sandbox:
summary: Sandbox response
value:
asset:
deposit_enabled: true
withdraw_enabled: true
asset_id: 7453f146-b267-11f1-b4f4-0abd773ba497
symbol: AAPLx
name: Apple xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '334.85'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
networks:
- can_buy: true
can_sell: true
funding_currencies:
- USDC
limits: []
multiplier: '1'
network: Ethereum
quantity_decimals: 18
token_id: f8ae8432-14d6-4142-a733-8b989c33ecfb
'400':
description: >-
The request failed. Read type, code, and message in the error
response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: >-
The request failed. Read type, code, and message in the error
response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: >-
The request failed. Read type, code, and message in the error
response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: >-
The request failed. Read type, code, and message in the error
response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: >-
The request failed. Read type, code, and message in the error
response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: >-
The request failed. Read type, code, and message in the error
response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: >-
The gateway could not complete the request. For a write, reconcile
the result before retrying with the same idempotency key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: >-
The request failed. Read type, code, and message in the error
response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codeSamples:
- lang: cURL
source: |-
curl --request GET \
--url 'https://api-sandbox.uqpaytech.com/api/v1/stocks/asset/7453f146-b267-11f1-b4f4-0abd773ba497' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
components:
schemas:
AssetDetail:
type: object
additionalProperties: false
properties:
asset:
$ref: '#/components/schemas/Asset'
description: Asset information.
networks:
type: array
items:
$ref: '#/components/schemas/NetworkCapability'
description: >-
Configured networks and capabilities. Buying and selling are
disabled for read-only accounts.
required:
- asset
- networks
Error:
type: object
additionalProperties: false
required:
- type
- code
- message
properties:
type:
type: string
description: Error category for classifying the failure.
pattern: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
code:
type: string
description: >-
Machine-readable business error code. Use this together with the
HTTP status; do not match on message text.
pattern: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
message:
type: string
description: Human-readable explanation of the error.
Asset:
type: object
additionalProperties: false
properties:
asset_id:
type: string
format: uuid
description: >-
Asset identifier used across asset, quote, order, and position
requests.
example: 7453f146-b267-11f1-b4f4-0abd773ba497
symbol:
type: string
description: Asset symbol.
example: AAPLx
name:
type: string
description: Asset name.
example: Apple xStock
asset_type:
type: string
description: Asset category from the asset catalog.
example: stock
status:
type: string
enum:
- ACTIVE
- INACTIVE
description: >-
Catalog availability. Check the account-specific buying and selling
flags before requesting a quote.
example: ACTIVE
can_buy:
type: boolean
description: >-
Whether the asset and your account permit buying. Eligibility is
checked again when you submit.
example: true
can_sell:
type: boolean
description: >-
Whether the asset and your account permit selling. Eligibility is
checked again when you submit.
example: true
unavailable_reason:
type: string
description: >-
Reason trading is unavailable. An empty string means no blocking
reason is reported.
example: ''
reference_price:
type: string
pattern: ^-?[0-9]+(\.[0-9]+)?$
nullable: true
description: >-
Reference price per unit of the asset, for display only. Use a quote
and the settled order for trading and reconciliation; null means no
reference price is available.
example: '334.85'
price_currency:
type: string
enum:
- USD
description: Currency used for the reference price.
example: USD
price_updated_at:
type: string
format: date-time
nullable: true
description: Time at which the reference price was sampled.
example: '2026-09-21T01:30:00.000Z'
deposit_enabled:
type: boolean
description: >-
Whether deposits are enabled for this asset and account. This does
not indicate whether buying is enabled.
example: true
withdraw_enabled:
type: boolean
description: >-
Whether withdrawals are enabled for this asset and account. This
does not indicate whether selling is enabled.
example: true
required:
- asset_id
- symbol
- name
- asset_type
- status
- can_buy
- can_sell
- unavailable_reason
- reference_price
- price_currency
- price_updated_at
- deposit_enabled
- withdraw_enabled
NetworkCapability:
type: object
additionalProperties: false
properties:
network:
type: string
description: Network associated with this token deployment.
example: Ethereum
token_id:
type: string
format: uuid
description: >-
Identifier of the token deployment on this network; not a contract
address.
example: f8ae8432-14d6-4142-a733-8b989c33ecfb
can_buy:
type: boolean
description: >-
Whether the asset and your account permit buying. Eligibility is
checked again when you submit.
example: true
can_sell:
type: boolean
description: >-
Whether the asset and your account permit selling. Eligibility is
checked again when you submit.
example: true
quantity_decimals:
type: integer
description: >-
On-chain token precision. Request precision is constrained
separately by the API.
example: 18
multiplier:
type: string
pattern: ^-?[0-9]+(\.[0-9]+)?$
nullable: true
description: >-
Share multiplier associated with the token deployment; null when
unavailable.
example: '1'
funding_currencies:
type: array
items:
type: string
enum:
- USDC
example: USDC
description: Supported funding currencies.
limits:
type: array
items:
type: object
additionalProperties: false
properties: {}
description: >-
An empty collection does not establish a minimum or maximum trade
size. Quote requests are validated separately.
required:
- network
- token_id
- can_buy
- can_sell
- quantity_decimals
- multiplier
- funding_currencies
- limits
securitySchemes:
AuthToken:
type: apiKey
in: header
name: x-auth-token
description: The API token for login provided by UQPAY.
````