@bitget-ai/getagent-skill 0.2.2 → 0.3.0

package/skills/getagent/references/sdk/data/commodity.md

@@ -42,6 +42,18 @@ Summary: Petroleum Status Report
 | `table` | `no` | `string | null` | `-` | The specific table element within the category to be returned, default is 'stocks', if the category is 'weekly_estimates', else 'all'. Note: Choices represent all available tables from the entire collection and are not all available for every category. Invalid choices will raise a ValidationError with a message indicating the valid choices for the selected category. Choices are: all conventional_gas crude crude_production crude_production_avg diesel ethanol_plant_production ethanol_plant_production_avg exports exports_avg heating_oil imports imports_avg imports_by_country imports_by_country_avg inputs_and_utilization inputs_and_utilization_avg jet_fuel monthly net_imports_inc_spr_avg net_imports_incl_spr net_production net_production_avg net_production_by_product net_production_by_production_avg product_by_region product_by_region_avg product_supplied product_supplied_avg propane rbob refiner_blender_net_production refiner_blender_net_production_avg stocks supply supply_avg ulta_low_sulfur_distillate_reclassification ulta_low_sulfur_distillate_reclassification_avg weekly Multiple comma separated items allowed. |
 | `use_cache` | `no` | `boolean` | `true` | Subsequent requests for the same source data are cached for the session using ALRU cache. |
 
+#### Response fields
+
+| Field | Type | Notes |
+|---|---|---|
+| `date` | `string` | The date of the data. |
+| `table` | `string` | Table name for the data. |
+| `symbol` | `string` | Symbol representing the entity requested in the data. |
+| `order` | `integer` | Presented order of the data, relative to the table. |
+| `title` | `string` | Title of the data. |
+| `value` | `integer` | Value of the data. |
+| `unit` | `string` | Unit or scale of the data. |
+
 ---
 
 ### `commodity.price.spot`
@@ -72,6 +84,16 @@ Summary: Spot
 | `aggregation_method` | `no` | `string` | `eop` | enum: avg, sum, eop A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period |
 | `transform` | `no` | `string | null` | `-` | Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log |
 
+#### Response fields
+
+| Field | Type | Notes |
+|---|---|---|
+| `date` | `string` | The date of the data. |
+| `symbol` | `string` | Symbol representing the entity requested in the data. |
+| `commodity` | `string` | Commodity name. |
+| `price` | `number` | Price of the commodity. |
+| `unit` | `string` | Unit of the commodity price. |
+
 ---
 
 ### `commodity.psd_data`
@@ -103,6 +125,18 @@ Summary: Psd Data
 | `start_year` | `no` | `integer | null` | `-` | Start year for filtering time series data. None returns from the beginning of the series. Parameter is ignored when 'commodity' is None. |
 | `end_year` | `no` | `integer | null` | `-` | End year for filtering time series data. If None, returns up to the most recent year. Parameter is ignored when 'commodity' is None. |
 
+#### Response fields
+
+| Field | Type | Notes |
+|---|---|---|
+| `region` | `string` | Region group category. |
+| `country` | `string` | Country or area name. |
+| `commodity` | `string` | Commodity name. |
+| `attribute` | `string` | Name of the row value. |
+| `marketing_year` | `string` | Marketing year for the commodity. |
+| `value` | `number` | Value for the commodity attribute in the given marketing year. |
+| `unit` | `string` | Unit of measurement for the value. |
+
 ---
 
 ### `commodity.psd_report`
@@ -159,6 +193,18 @@ Summary: Short Term Energy Outlook
 | `table` | `no` | `string` | `01` | enum: 01, 02, 03a, 03b, 03c, 03d, 03e, 04a, 04b, 04c, 04d, 05a, 05b, 06, 07a, 07b, 07c, 07d1, 07d2, 07e, 08, 09a, 09b, 09c, 10a, 10b The specific table within the STEO dataset. Default is '01'. When 'symbol' is provided, this parameter is ignored. 01: US Energy Markets Summary 02: Nominal Energy Prices 03a: World Petroleum and Other Liquid Fuels Production, Consumption, and Inventories 03b: Non-OPEC Petroleum and Other Liquid Fuels Production 03c: World Petroleum and Other Liquid Fuels Production 03d: World Crude Oil Production 03e: World Petroleum and Other Liquid Fuels Consumption 04a: US Petroleum and Other Liquid Fuels Supply, Consumption, and Inventories 04b: US Hydrocarbon Gas Liquids (HGL) and Petroleum Refinery Balances 04c: US Regional Motor Gasoline Prices and Inventories 04d: US Biofuel Supply, Consumption, and Inventories 05a: US Natural Gas Supply, Consumption, and Inventories 05b: US Regional Natural Gas Prices 06: US Coal Supply, Consumption, and Inventories 07a: US Electricity Industry Overview 07b: US Regional Electricity Retail Sales 07c: US Regional Electricity Prices 07d1: US Regional Electricity Generation, Electric Power Sector 07d2: US Regional Electricity Generation, Electric Power Sector, continued 07e: US Electricity Generating Capacity 08: US Renewable Energy Consumption 09a: US Macroeconomic Indicators and CO2 Emissions 09b: US Regional Macroeconomic Data 09c: US Regional Weather Data 10a: Drilling Productivity Metrics 10b: Crude Oil and Natural Gas Production from Shale and Tight Formations |
 | `frequency` | `no` | `string` | `month` | enum: month, quarter, annual The frequency of the data. Default is 'month'. |
 
+#### Response fields
+
+| Field | Type | Notes |
+|---|---|---|
+| `date` | `string` | The date of the data. |
+| `table` | `string` | Table name for the data. |
+| `symbol` | `string` | Symbol representing the entity requested in the data. |
+| `order` | `integer` | Presented order of the data, relative to the table. |
+| `title` | `string` | Title of the data. |
+| `value` | `integer` | Value of the data. |
+| `unit` | `string` | Unit or scale of the data. |
+
 ---
 
 ### `commodity.weather_bulletins`