Skip to content
Longport WhaleLongport Whale
Combination Rule

Market Rule Detail

Retrieve the full configuration of a single market (combination) rule by id.

Request parameters

  • Required: id (market rule id), supplied as a query parameter.

Result

On success, data contains the full configuration. See the 200 response fields for the meaning of each field.

GEThttps://b-api.longbridge.xyz/billing/market/rule

Authorization

AuthorizationstringheaderRequired

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

Parameters

idstringRequired

Market rule id.

Responses

HTTP 200The request was processed successfully. data contains the full configuration of the market rule.
Standard response envelopecodemessagedata
dataobjectdata structure

Full configuration of the market rule.

idstring

Market rule id.

namestring

Market rule name.

marketstring

Applicable market, e.g. US, HK.

mergestring

Whether to merge billing: 1 merge, 0 do not merge.

grey_market_mergestring

Whether grey-market trades are merged for billing: 1 merge, 0 do not merge.

itemsarray<object>

List of rule items. Each item has order_sources (order source list) and merge_tag.

Child attributes
order_sourcesarray<string>

Order source list.

merge_taginteger

Merge tag.

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