> ## 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.
# List assets
> List the assets visible to your account. Use the availability flags before requesting a quote.
```bash cURL
curl --request GET \
--url 'https://api-sandbox.uqpaytech.com/api/v1/stocks/asset' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
```
```json 200
{
"data": [
{
"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"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "896fa067-c017-40f4-9b72-4dde9732566f",
"symbol": "ACNx",
"name": "Accenture xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "193.3",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "54f913d6-eeb9-47c8-aa94-3d9fa1fd9304",
"symbol": "ADBEx",
"name": "Adobe xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "249.03",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "7453edf6-b267-11f1-b4f4-0abd773ba497",
"symbol": "AMDx",
"name": "AMD xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "571.275",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "7453f017-b267-11f1-b4f4-0abd773ba497",
"symbol": "AMZNx",
"name": "Amazon.com xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "255.205",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "7453ef2b-b267-11f1-b4f4-0abd773ba497",
"symbol": "AVGOx",
"name": "Broadcom xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "361.13",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "7453ef67-b267-11f1-b4f4-0abd773ba497",
"symbol": "COINx",
"name": "Coinbase xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "196.715",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "322fe763-c069-4d11-be35-b9563f6e22c4",
"symbol": "CORZx",
"name": "Core Scientific xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "18.11",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "7453f225-b267-11f1-b4f4-0abd773ba497",
"symbol": "CRMx",
"name": "Salesforce xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "237.695",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
},
{
"deposit_enabled": true,
"withdraw_enabled": true,
"asset_id": "7453ee44-b267-11f1-b4f4-0abd773ba497",
"symbol": "GOOGLx",
"name": "Alphabet xStock",
"asset_type": "stock",
"status": "ACTIVE",
"can_buy": true,
"can_sell": true,
"unavailable_reason": "",
"reference_price": "351.2",
"price_currency": "USD",
"price_updated_at": "2026-09-21T01:30:00.000Z"
}
],
"total_items": 22,
"total_pages": 3
}
```
## OpenAPI
````yaml /stocks/stocks.yaml get /asset
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:
get:
tags:
- Stocks
summary: List assets
description: >-
List the assets visible to your account. Use the availability flags
before requesting a quote.
operationId: listStocksAssets
parameters:
- name: page_number
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 1000000
default: 1
description: The page number to retrieve.
- name: page_size
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 10
description: The maximum number of items to return per page.
- name: symbol
in: query
required: false
schema:
type: string
maxLength: 32
description: Filter by asset symbol.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssetPage'
examples:
sandbox:
summary: Sandbox response
value:
data:
- 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'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 896fa067-c017-40f4-9b72-4dde9732566f
symbol: ACNx
name: Accenture xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '193.3'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 54f913d6-eeb9-47c8-aa94-3d9fa1fd9304
symbol: ADBEx
name: Adobe xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '249.03'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 7453edf6-b267-11f1-b4f4-0abd773ba497
symbol: AMDx
name: AMD xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '571.275'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 7453f017-b267-11f1-b4f4-0abd773ba497
symbol: AMZNx
name: Amazon.com xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '255.205'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 7453ef2b-b267-11f1-b4f4-0abd773ba497
symbol: AVGOx
name: Broadcom xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '361.13'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 7453ef67-b267-11f1-b4f4-0abd773ba497
symbol: COINx
name: Coinbase xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '196.715'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 322fe763-c069-4d11-be35-b9563f6e22c4
symbol: CORZx
name: Core Scientific xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '18.11'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 7453f225-b267-11f1-b4f4-0abd773ba497
symbol: CRMx
name: Salesforce xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '237.695'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
- deposit_enabled: true
withdraw_enabled: true
asset_id: 7453ee44-b267-11f1-b4f4-0abd773ba497
symbol: GOOGLx
name: Alphabet xStock
asset_type: stock
status: ACTIVE
can_buy: true
can_sell: true
unavailable_reason: ''
reference_price: '351.2'
price_currency: USD
price_updated_at: '2026-09-21T01:30:00.000Z'
total_items: 22
total_pages: 3
'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' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
components:
schemas:
AssetPage:
type: object
additionalProperties: false
properties:
data:
type: array
items:
$ref: '#/components/schemas/Asset'
description: >-
Items on this page. An empty array can indicate no matches or a page
beyond the last result.
total_pages:
type: integer
format: int64
minimum: 0
description: Number of result pages for the requested page size.
example: 3
total_items:
type: integer
format: int64
minimum: 0
description: Number of matching items across all pages.
example: 22
required:
- data
- total_pages
- total_items
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
securitySchemes:
AuthToken:
type: apiKey
in: header
name: x-auth-token
description: The API token for login provided by UQPAY.
````