HTTP Interfaces and External Systems for Gas Yield Rates

The data source for gas yield rates primarily comes from public market interfaces of the national urban gas association and daily submission data from

What this category's data looks like

The data source for gas yield rates primarily comes from public market interfaces of the national urban gas association and daily submission data from local energy regulatory authorities. Data updates occur approximately 12 hours after the end of the previous natural day, with full aggregated daily market data for the prior day published once complete. The document structure follows standard JSON array format. Each element corresponds to single-category single-day yield rate data, including fields such as transaction date, gas category code, unit purchase cost, unit sales price, cumulative price difference coefficient, and others. The unit for purchase and sales prices is yuan per cubic meter. The cumulative price difference coefficient is a dimensionless value, and no percentage-based units are used.

Constraints imposed on HTTP interfaces and external systems

Public interfaces for gas yield rate data require authentication for access. HTTP interface configurations must include valid authentication parameters, otherwise valid data cannot be retrieved. Data updates occur once per day. Polling request intervals must align with the update schedule to avoid exceeding third-party interface rate limits. Fields include clear category codes and units. Requests must specify category codes to filter target data. Parsing must strictly follow unit rules, otherwise subsequent calculation deviations will occur. The total volume of full data returned in a single request is large. Pagination pull parameters must be configured to avoid overloading a single request and affecting system stability.

How to set configurations

Configuration ItemRecommended ValueRationale
external_api_urlPublic market interface address of the national urban gas associationThis data source covers mainstream domestic gas categories, and its data authority meets compliance requirements for daily report broadcasting
request_interval86400 secondsGas yield rate data updates once per day. Aligning the polling interval with the data update schedule avoids triggering interface rate limits
request_timeout30 secondsThe average response time of third-party gas market interfaces ranges from 10 to 20 seconds. Setting a 30-second timeout reserves sufficient buffer to prevent timeout failures
filter_category_codeSpecify the target gas category code, such as LNG001Distinguish market data for different gas categories, ensuring that yield rate information for the target category is pulled
parse_field_mappingMap original fields to date/purchase_price/sale_price/yield_coeffUnify internal data formats to facilitate subsequent knowledge base calls and daily report generation
api_auth_typeAPI_KEY authenticationMost official gas market interfaces use this authentication method to ensure the legality of data access

The parameter values provided on this page are common starting points for configuration. Actual values are affected by material forms, data volume, and business rules. Specific issues require case-by-case analysis. It is recommended to test on your own samples before finalizing settings.

Three common configuration errors

  • An Api response error: undefined log entry appears, with a 200 status code but no valid data. The cause is that the filter_category_code parameter is not correctly configured, pulling empty data with no matching category, resulting in the interface returning empty content.
  • A 504 Gateway Timeout error occurs after external system invocation. The cause is that request_timeout is set to less than 10 seconds, which does not match the actual response time of the third-party interface.
  • Field missing or format errors appear when the knowledge base parses gas market data. The cause is that the parse_field_mapping parameter is not configured, and internal data mapping rules are not unified, leading to abnormalities in subsequent report generation.

How to confirm correct configuration

  • Call the configured HTTP interface and check if the returned JSON data includes category data corresponding to the configured filter_category_code.
  • View interface invocation logs to confirm that the set request_timeout duration is greater than the actual interface response time, with no timeout errors.
  • Compare the fields from the original data source with the internally mapped fields to confirm that the parse_field_mapping configuration correctly covers all required fields.
  • Trigger the daily report generation process of the knowledge base and check if the output content includes correct gas yield rate related data.

Question material comes from public community discussions. Configuration values are common starting points and should be measured against your own samples. Verified on 2026-09-14.