Skip to content
Longport WhaleLongport Whale
Exchange Pool Quota

Exchange Pool Quota

Queries Exchange Pool Quota 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/atm_exchange_pool_limit_changes

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

Authorizationstringheaderlb_hk_conversion.exchange_pool_change_queryRequired

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

Query parameters

filtersobject

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

Child attributes
idstring

Record ID. Filters results by Record ID.

change_typestring

Business Type. Filters results by Business Type.

Allowed values:

  • plus - Manual Increase
  • minus - Manual Reduce
  • exchange_in - Exchange & Deposit
  • exchange_out - Exchange & Withdrawal

plusminusexchange_inexchange_out

currencystring

Currency. Filters results by Currency.

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

created_atobject

Created Time. Filters results by Created Time.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

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 Exchange Pool Quota 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

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

change_typestring

Business Type. Returned value: Business Type.

change_type_valstring

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

currencystring

Currency. Returned value: Currency.

currency_valstring

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

order_nostring

Order ID. Returned value: Order ID.

before_occurredstring

Initial Remaining Daily Quota. Returned value: Initial Remaining Daily Quota.

occurred_amountstring

Amount Incurred. Returned value: Amount Incurred.

after_occurredstring

Remaining Daily Quota. Returned value: Remaining Daily Quota.

occurred_fromstring

Automatically By The System?. Returned value: Automatically By The System?.

occurred_from_valstring

Automatically By The System? (raw value). Raw value of occurred_from. The occurred_from field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Created Time. Returned value: Created Time. The date or time format follows the value returned by the API.

updated_atstring

Update Time. Returned value: Update Time. The date or time format follows the value returned by the API.

remarkstring

Remark. Returned value: Remark.

operatorstring

Operator. Returned value: Operator.

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