ELC Short Fall Details

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

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_margin_call.risk_monitoring_stock_level_query

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

Query parameters

filtersobject

Filters

Child attributes

aaidstring

A/C No.

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

origin_idstring

A/C No.

currencystring

Currency

loan_amountstring

Loan Amount

market_valuestring

Market Value (based CCY)

liquid_assetstring

Liquid Assect

adj_loanstring

Adj Loan

short_fallstring

Shortfall

thirty_percent_short_fallstring

Shortfall Drop By 30%

fifty_percent_short_fallstring

Shortfall Drop By 50%

totalintegerrequired

Total

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/risk_elc_shortfall' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "origin_id": "string",
        "currency": "string",
        "loan_amount": "string",
        "market_value": "string",
        "liquid_asset": "string",
        "adj_loan": "string",
        "short_fall": "string",
        "thirty_percent_short_fall": "string",
        "fifty_percent_short_fall": "string"
      }
    ],
    "total": 1
  }
}