API Detailed Documentation
API URL:
https://api.hkma.gov.hk/public/market-data-and-statistics/daily-monetary-statistics/daily-figures-interbank-liquidity
| |
Output Fields (JSON) | Swagger Format |
Name | Type | Unit Of Measure | Description |
---|---|---|---|
end_of_date | Date | Daily figure Date in ISO format yyyy-mm-dd, For example, 1997-01-01 |
|
cu_weakside | Number | USD/HKD for Value Spot | Convertibility Undertaking Offer Rate |
cu_strongside | Number | USD/HKD for Value Spot | Convertibility Undertaking Bid Rate |
disc_win_base_rate | Number | % per annum | Discount Window Base Rate |
hibor_overnight | Number | % per annum | Overnight HIBOR |
hibor_fixing_1m | Number | % per annum | HKAB 1-Month HIBOR Fixing |
twi | Number | TWI | |
opening_balance | Number | HK$ million | Opening Aggregate Balance |
closing_balance | Number | HK$ million | Closing Aggregate Balance |
market_activities | String | HK$ million | Change Attributable to Market activities |
interest_payment | String | HK$ million | Change Attributable to Interest Payment/Issuance of Exchange Fund Bills and Notes |
discount_window_reversal | String | HK$ million | Change Attributable to Discount Window reversal |
discount_window_activities | String | HK$ million | Change Attributable to Discount Window activities of the day |
intraday_movements_of_aggregate_balance_at_0930 | Number | HK$ million | Intraday movements of Aggregate Balance – 9:30am |
intraday_movements_of_aggregate_balance_at_1000 | Number | HK$ million | Intraday movements of Aggregate Balance – 10am |
intraday_movements_of_aggregate_balance_at_1100 | Number | HK$ million | Intraday movements of Aggregate Balance – 11am |
intraday_movements_of_aggregate_balance_at_1200 | Number | HK$ million | Intraday movements of Aggregate Balance – 12nn |
intraday_movements_of_aggregate_balance_at_1500 | Number | HK$ million | Intraday movements of Aggregate Balance – 3pm |
intraday_movements_of_aggregate_balance_at_1600 | Number | HK$ million | Intraday movements of Aggregate Balance – 4pm |
forex_trans_t1 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Forex Transactions of the day + 1 |
other_market_activities_t1 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Other Market Activities of the day + 1 |
reversal_of_discount_window_t1 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Reversal of Discount Window of the day + 1 |
interest_payment_issuance_efbn_t1 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Interest Payment/ Issuance of EFBN of the day + 1 |
forecast_aggregate_bal_t1 | Number | HK$ million | Forecast Aggregate Balance after Discount Window Reversal of the day + 1 |
forex_trans_t2 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Forex Transactions of the day + 2 |
other_market_activities_t2 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Other Market Activities of the day + 2 |
reversal_of_discount_window_t2 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Reversal of Discount Window of the day + 2 |
interest_payment_issuance_efbn_t2 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Interest Payment/ Issuance of EFBN of the day + 2 |
forecast_aggregate_bal_t2 | Number | HK$ million | Forecast Aggregate Balance after Discount Window Reversal of the day + 2 |
forex_trans_t3 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Forex Transactions of the day + 3 |
other_market_activities_t3 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Other Market Activities of the day + 3 |
reversal_of_discount_window_t3 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Reversal of Discount Window of the day + 3 |
interest_payment_issuance_efbn_t3 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Interest Payment/ Issuance of EFBN of the day + 3 |
forecast_aggregate_bal_t3 | Number | HK$ million | Forecast Aggregate Balance after Discount Window Reversal of the day + 3 |
forex_trans_t4 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Forex Transactions of the day + 4 |
other_market_activities_t4 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Other Market Activities of the day + 4 |
reversal_of_discount_window_t4 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Reversal of Discount Window of the day + 4 |
interest_payment_issuance_efbn_t4 | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Interest Payment/ Issuance of EFBN of the day + 4 |
forecast_aggregate_bal_t4 | Number | HK$ million | Forecast Aggregate Balance after Discount Window Reversal of the day + 4 |
forex_trans_u | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Forex Transactions – Upcoming |
other_market_activities_u | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Other Market Activities – Upcoming |
reversal_of_discount_window_u | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Reversal of Discount Window – Upcoming |
interest_payment_issuance_efbn_u | String | HK$ million | Forecast of changes in Aggregate Balance attributable to Interest Payment/ Issuance of EFBN – Upcoming |
forecast_aggregate_bal_u | Number | HK$ million | Forecast Aggregate Balance after Discount Window Reversal – Upcoming |
API Examples
Javascript Example
$.ajax({url: 'https://api.hkma.gov.hk/public/market-data-and-statistics/daily-monetary-statistics/daily-figures-interbank-liquidity?offset=0',dataType:'json',success:function(data){alert('results found:'+ data.result.datasize)}});
Python Example
import urllib.requesturl = 'https://api.hkma.gov.hk/public/market-data-and-statistics/daily-monetary-statistics/daily-figures-interbank-liquidity?offset=0'with urllib.request.urlopen (url) as req:print (req.read())