Skip to content
Position Management Inquiry

Position Management Inquiry

Queries Position Management Inquiry data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/va_account_balances

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

assets.position_anagement_inquiry_query

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
account_idstring

Original Account No.. Filters results by Original Account No..

updated_atstring

Updated At. Filters results by Updated At.

currency_typestring

Currency Type. Filters results by Currency Type.

1 · Fiat2 · Crypto

asset_idstring

Currency. Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/va_balance_currency to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

account_typestring

Channel Account Type. Filters results by Channel Account Type.

Values are dynamic. Call GET /v1/datasets/refs/va_balance_account_type to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Position Management Inquiry records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

ID. Returned value: Unique identifier of the current record.

marketstring

Channel. Returned value: Channel.

account_idstring

Original Account No.. Returned value: Original Account No..

account_typestring

Channel Account Type. Returned value: Channel Account Type.

currency_typestring

Currency Type. Returned value: Currency Type.

currency_type_valstring

Currency Type (raw value). Raw value of currency_type. The currency_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

asset_idstring

Currency. Returned value: Currency.

external_total_amountstring

Total Channel Balance. Returned value: Total Channel Balance.

external_free_amountstring

Available Channel Balance. Returned value: Available Channel Balance.

external_locked_amountstring

Frozen Channel Funds. Returned value: Frozen Channel Funds.

self_free_amountstring

Client - Used Limit. Returned value: Client - Used Limit.

available_posstring

Available Pos.. Returned value: Available Pos..

prompt_posstring

Prompt Pos.. Returned value: Prompt Pos..

intercepted_posstring

Intercepted Pos.. Returned value: Intercepted Pos..

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

updaterstring

Updater. Returned value: Updater.

updater_valstring

Updater (raw value). Raw value of updater. The updater field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs