Skip to content

Query Maker Positions

Endpoint Information

Endpoint: GET /api/v1/positions

Description: Query held stock token information

Authentication: Authorization header with JWT token

Query Parameters

ParameterTypeRequiredDescription
tickerstringNoStock symbol (exact or fuzzy match)
ticker_likebooleanNoEnable fuzzy search, default false
pageintNoPage number, default 1
page_sizeintNoPage size, default 20, max 100

Response Parameters

FieldTypeDescription
totalintTotal records
pageintCurrent page
page_sizeintPage size
total_pagesintTotal pages
positionsarrayPosition list

Position Object Field

FieldTypeDescription
positions[].tickerstringStock symbol
positions[].exchangeintMarket code enum index. See Exchange
positions[].token_addressstringToken address
positions[].balancestringPosition balance
positions[].locked_balancestringLocked position balance
positions[].available_balancestringAvailable position balance
positions[].avg_pricestringaverage transaction price

Request Example

bash
curl -X GET "/api/v1/positions?page=1&page_size=20&ticker_like=true&ticker=AAPL" \
     -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
     -H "Content-Type: application/json"

Response Example

json
{
    "code": 0,
    "data": {
        "positions": [
            {
                "ticker": "AAPL",
                "exchange": 0,
                "token_address": "0xc48eec40...",
                "balance": "6",
                "locked_balance": "0",
                "available_balance": "6",
                "avg_price": "256598079145728583333"
            },
            {
                "ticker": "AMZN",
                "exchange": 0,
                "token_address": "0xfd5d300742...",
                "balance": "12",
                "locked_balance": "0",
                "available_balance": "12",
                "avg_price": "233225286432160750000"
            }
        ],
        "total": 2,
        "page": 1,
        "page_size": 20,
        "total_pages": 1
    }
}