> ## 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 position events
> List changes in effective asset quantity for reconciliation. An event can have no associated order.
```bash cURL
curl --request GET \
--url 'https://api-sandbox.uqpaytech.com/api/v1/stocks/position/event' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
```
```json 200
{
"data": [
{
"asset_id": "7453f146-b267-11f1-b4f4-0abd773ba497",
"created_at": "2026-09-21T01:50:53.561Z",
"event_id": "664bcfe5-5a26-45dc-82d2-b3f62a35ef4f",
"order_id": "53fe3d55-85ff-4804-b6f0-a25a32aa082f",
"quantity_after": "0.00297066689243735",
"quantity_delta": "0.00297066689243735",
"symbol": "AAPLx",
"type": "TRADE"
}
],
"total_items": 1,
"total_pages": 1
}
```
## OpenAPI
````yaml /stocks/stocks.yaml get /position/event
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:
/position/event:
get:
tags:
- Stocks
summary: List position events
description: >-
List changes in effective asset quantity for reconciliation. An event
can have no associated order.
operationId: listStocksPositionEvents
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: asset_id
in: query
required: false
schema:
type: string
format: uuid
description: Asset identifier returned by List assets.
- name: symbol
in: query
required: false
schema:
type: string
maxLength: 32
description: Filter by asset symbol.
- name: order_id
in: query
required: false
schema:
type: string
format: uuid
description: Order identifier returned when creating or listing orders.
- name: from
in: query
required: false
schema:
type: string
format: date-time
description: >-
Inclusive start of the event-time window. When both are provided,
from must be earlier than to.
- name: to
in: query
required: false
schema:
type: string
format: date-time
description: >-
Exclusive end of the event-time window. When both are provided, from
must be earlier than to.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PositionEventPage'
examples:
sandbox:
summary: Sandbox response
value:
data:
- asset_id: 7453f146-b267-11f1-b4f4-0abd773ba497
created_at: '2026-09-21T01:50:53.561Z'
event_id: 664bcfe5-5a26-45dc-82d2-b3f62a35ef4f
order_id: 53fe3d55-85ff-4804-b6f0-a25a32aa082f
quantity_after: '0.00297066689243735'
quantity_delta: '0.00297066689243735'
symbol: AAPLx
type: TRADE
total_items: 1
total_pages: 1
'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/position/event' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
components:
schemas:
PositionEventPage:
type: object
additionalProperties: false
properties:
data:
type: array
items:
$ref: '#/components/schemas/PositionEvent'
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: 1
total_items:
type: integer
format: int64
minimum: 0
description: Number of matching items across all pages.
example: 1
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.
PositionEvent:
type: object
additionalProperties: false
properties:
event_id:
type: string
format: uuid
description: >-
Identifier of the position change, separate from a Webhook delivery
identifier.
example: 664bcfe5-5a26-45dc-82d2-b3f62a35ef4f
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
order_id:
type: string
format: uuid
nullable: true
description: >-
Associated order identifier, or null when the event has no
associated order.
example: 53fe3d55-85ff-4804-b6f0-a25a32aa082f
type:
type: string
enum:
- TRADE
- ADJUSTMENT
description: Position change category.
example: TRADE
quantity_delta:
type: string
pattern: ^-?[0-9]+(\.[0-9]+)?$
description: >-
Signed change in effective quantity: positive for an increase and
negative for a decrease.
example: '0.00297066689243735'
quantity_after:
type: string
pattern: ^-?[0-9]+(\.[0-9]+)?$
description: Effective quantity after applying this event.
example: '0.00297066689243735'
created_at:
type: string
format: date-time
description: Time the position change occurred.
example: '2026-09-21T01:50:53.561Z'
required:
- event_id
- asset_id
- symbol
- order_id
- type
- quantity_delta
- quantity_after
- created_at
securitySchemes:
AuthToken:
type: apiKey
in: header
name: x-auth-token
description: The API token for login provided by UQPAY.
````