Skip to content
Longport WhaleLongport Whale
Quick import

Upstream File Quick Import

Query the upstream file quick-import records. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

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

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

lb_hk_clearing.ob_file_quick_import_list

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

Query parameters

filtersobject

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

Child attributes
ledger_datestring

Filters results by Ledger Date.

marketstring

Filters results by Market.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

US · USHK · HKUK · UKSH · SHSZ · SZSG · SGKR · KRJP · JPAU · AUDE · DECA · CATH · THId · IDMY · MYTR · TRNA · NAOSL · OSLHAS · HASEU · EUUT · UTGTMMF · GTMMF

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

ledger_datestring

Returned value: Ledger Date. The date or time format follows the value returned by the API.

parent_account_channelstring

Returned value: Upstream Bussiness Number.

marketstring

Returned value: Market.

file_typestring

Returned value: File Type.

file_type_valstring

Raw value of file_type. The file_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

file_namestring

Returned value: File Name.

statestring

Returned value: State.

state_valstring

Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

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

updated_atstring

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

totalintegerrequired

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