Option Change Details List

Query the per-account change details of a US-option corporate action, used to reconcile how a given option-contract adjustment actually affected client positions.

Request parameters

Combine business filters through filters (see the filter field notes below), and use page, page_size, and orderBy for pagination and sorting.
Typically filter by recondiliation_id (the associated option change rule / reconciliation batch) to list every account affected by that change.

Business notes

The data comes from the option corporate-action change-detail records, joined with the corresponding change rule to add the account channel.

Each record represents one affected account's position adjustment in the event, carrying origin_option_counter_id and new_option_counter_id (option code before and after the change), origin_quantity and new_quantity (position quantity before and after the change), plus the securities account number, client name, and account channel.

A typical use is to reconcile, account by account, the position difference before and after a US-option contract code or quantity adjustment.

Returns

On success, returns the matching records with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/instrument_option_change_details

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

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

Request body application/json

filtersobject

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

Child attributes

recondiliation_idstring

Filters results by Recondiliation Id.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Option Change Details List 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

Unique identifier of the current record.

account_channelstring

Returned value: Account Channel.

origin_option_counter_idstring

Returned value: Origin Option Counter Id.

origin_option_counter_id_valstring

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

new_option_counter_idstring

Returned value: New Option Counter Id.

new_option_counter_id_valstring

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

origin_quantitystring

Returned value: Origin Quantity.

new_quantitystring

Returned value: New Quantity.

origin_idstring

Returned value: A/C No..

real_namestring

Returned value: Name.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/instrument_option_change_details' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "1000000001",
        "account_channel": "longport_test",
        "origin_option_counter_id": "1000000001",
        "origin_option_counter_id_val": "1",
        "new_option_counter_id": "1000000001",
        "new_option_counter_id_val": "1",
        "origin_quantity": "1200",
        "new_quantity": "1200",
        "origin_id": "1000000001",
        "real_name": "张三"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/instrument_option_change_details/download

lb_hk_corporate.corporate_query

Export options Export records Download result