oilpriceapi 0.6.0 → 0.7.0

package/dist/resources/ei/drilling-productivity.d.ts

@@ -0,0 +1,173 @@
+/**
+ * Energy Intelligence - Drilling Productivity Resource
+ *
+ * Access EIA Drilling Productivity Report data including new well production,
+ * legacy decline rates, and DUC well inventories by basin.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * Drilling productivity record
+ */
+export interface DrillingProductivityRecord {
+    /** Record ID */
+    id: string;
+    /** Basin name */
+    basin?: string;
+    /** New well oil production per rig (barrels/day) */
+    new_well_oil_production?: number;
+    /** New well gas production per rig (mcf/day) */
+    new_well_gas_production?: number;
+    /** Legacy production change (oil) */
+    legacy_oil_change?: number;
+    /** Legacy production change (gas) */
+    legacy_gas_change?: number;
+    /** DUC well count */
+    duc_count?: number;
+    /** Report date */
+    date: string;
+    /** Month */
+    month?: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Drilling productivity summary
+ */
+export interface DrillingProductivitySummary {
+    /** Total new well oil production */
+    total_new_well_oil?: number;
+    /** Total new well gas production */
+    total_new_well_gas?: number;
+    /** Total DUC wells */
+    total_duc_wells?: number;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * DUC well data
+ */
+export interface DUCWellInventory {
+    /** Basin name */
+    basin: string;
+    /** DUC well count */
+    duc_count: number;
+    /** Change from previous month */
+    change?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Productivity by basin
+ */
+export interface ProductivityByBasin {
+    /** Basin name */
+    basin: string;
+    /** New well oil production */
+    new_well_oil_production?: number;
+    /** New well gas production */
+    new_well_gas_production?: number;
+    /** DUC count */
+    duc_count?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Historical productivity data point
+ */
+export interface HistoricalProductivity {
+    /** Date */
+    date: string;
+    /** New well oil production */
+    new_well_oil_production?: number;
+    /** New well gas production */
+    new_well_gas_production?: number;
+    /** DUC count */
+    duc_count?: number;
+}
+/**
+ * Productivity trend data
+ */
+export interface ProductivityTrend {
+    /** Basin name */
+    basin: string;
+    /** Trend direction */
+    trend: "up" | "down" | "flat";
+    /** Change percentage */
+    change_percent?: number;
+    /** Metric type */
+    metric: string;
+}
+/**
+ * EI Drilling Productivity Resource
+ *
+ * Access EIA Drilling Productivity Report data for major US basins.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest productivity data
+ * const latest = await client.ei.drillingProductivity.latest();
+ * console.log(`Basin: ${latest.basin}`);
+ * console.log(`New well oil: ${latest.new_well_oil_production} bpd/rig`);
+ *
+ * // Get DUC wells
+ * const duc = await client.ei.drillingProductivity.ducWells();
+ * duc.forEach(d => console.log(`${d.basin}: ${d.duc_count} DUC wells`));
+ * ```
+ */
+export declare class EIDrillingProductivityResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all drilling productivity records
+     *
+     * @returns Array of productivity records
+     */
+    list(): Promise<DrillingProductivityRecord[]>;
+    /**
+     * Get a specific productivity record
+     *
+     * @param id - Record ID
+     * @returns Productivity record
+     */
+    get(id: string): Promise<DrillingProductivityRecord>;
+    /**
+     * Get latest drilling productivity data
+     *
+     * @returns Latest productivity record
+     */
+    latest(): Promise<DrillingProductivityRecord>;
+    /**
+     * Get drilling productivity summary
+     *
+     * @returns Productivity summary across all basins
+     */
+    summary(): Promise<DrillingProductivitySummary>;
+    /**
+     * Get DUC well inventories
+     *
+     * @returns Array of DUC well counts by basin
+     */
+    ducWells(): Promise<DUCWellInventory[]>;
+    /**
+     * Get productivity by basin
+     *
+     * @returns Array of productivity data by basin
+     */
+    byBasin(): Promise<ProductivityByBasin[]>;
+    /**
+     * Get historical productivity data
+     *
+     * @returns Array of historical productivity metrics
+     */
+    historical(): Promise<HistoricalProductivity[]>;
+    /**
+     * Get productivity trends
+     *
+     * @returns Array of productivity trends by basin
+     */
+    trends(): Promise<ProductivityTrend[]>;
+}

package/dist/resources/ei/drilling-productivity.js

@@ -0,0 +1,103 @@
+/**
+ * Energy Intelligence - Drilling Productivity Resource
+ *
+ * Access EIA Drilling Productivity Report data including new well production,
+ * legacy decline rates, and DUC well inventories by basin.
+ */
+/**
+ * EI Drilling Productivity Resource
+ *
+ * Access EIA Drilling Productivity Report data for major US basins.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest productivity data
+ * const latest = await client.ei.drillingProductivity.latest();
+ * console.log(`Basin: ${latest.basin}`);
+ * console.log(`New well oil: ${latest.new_well_oil_production} bpd/rig`);
+ *
+ * // Get DUC wells
+ * const duc = await client.ei.drillingProductivity.ducWells();
+ * duc.forEach(d => console.log(`${d.basin}: ${d.duc_count} DUC wells`));
+ * ```
+ */
+export class EIDrillingProductivityResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all drilling productivity records
+     *
+     * @returns Array of productivity records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific productivity record
+     *
+     * @param id - Record ID
+     * @returns Productivity record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new Error("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/drilling_productivities/${id}`, {});
+    }
+    /**
+     * Get latest drilling productivity data
+     *
+     * @returns Latest productivity record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/drilling_productivities/latest", {});
+    }
+    /**
+     * Get drilling productivity summary
+     *
+     * @returns Productivity summary across all basins
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/drilling_productivities/summary", {});
+    }
+    /**
+     * Get DUC well inventories
+     *
+     * @returns Array of DUC well counts by basin
+     */
+    async ducWells() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/duc_wells", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get productivity by basin
+     *
+     * @returns Array of productivity data by basin
+     */
+    async byBasin() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/by_basin", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical productivity data
+     *
+     * @returns Array of historical productivity metrics
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get productivity trends
+     *
+     * @returns Array of productivity trends by basin
+     */
+    async trends() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/trends", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}

package/dist/resources/ei/forecasts.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Energy Intelligence - Forecasts Resource
+ *
+ * Access EIA and IEA price and production forecasts with historical accuracy metrics.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * Forecast record
+ */
+export interface ForecastRecord {
+    /** Record ID */
+    id: string;
+    /** Forecast source (e.g., "EIA", "IEA") */
+    source?: string;
+    /** Commodity or metric being forecasted */
+    commodity?: string;
+    /** Forecast value */
+    forecast_value: number;
+    /** Unit of measurement */
+    unit?: string;
+    /** Forecast period (e.g., "Q1 2025", "2025") */
+    period?: string;
+    /** Publication date */
+    published_date: string;
+    /** Target date */
+    target_date?: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Forecast summary
+ */
+export interface ForecastSummary {
+    /** Number of forecasts */
+    total_forecasts: number;
+    /** Latest forecast value */
+    latest_forecast?: number;
+    /** Average forecast */
+    average_forecast?: number;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * Price forecast data
+ */
+export interface PriceForecast {
+    /** Commodity */
+    commodity: string;
+    /** Forecast source */
+    source: string;
+    /** Forecast price */
+    forecast_price: number;
+    /** Unit */
+    unit: string;
+    /** Target period */
+    period: string;
+    /** Published date */
+    published_date: string;
+}
+/**
+ * Production forecast data
+ */
+export interface ProductionForecast {
+    /** Region or country */
+    region: string;
+    /** Forecast source */
+    source: string;
+    /** Forecast production */
+    forecast_production: number;
+    /** Unit */
+    unit: string;
+    /** Target period */
+    period: string;
+    /** Published date */
+    published_date: string;
+}
+/**
+ * Historical forecast data point
+ */
+export interface HistoricalForecast {
+    /** Date */
+    date: string;
+    /** Forecast value */
+    forecast_value: number;
+    /** Actual value (if available) */
+    actual_value?: number;
+    /** Accuracy percentage */
+    accuracy_percent?: number;
+}
+/**
+ * Forecast comparison data
+ */
+export interface ForecastComparison {
+    /** Period */
+    period: string;
+    /** EIA forecast */
+    eia_forecast?: number;
+    /** IEA forecast */
+    iea_forecast?: number;
+    /** Actual value (if available) */
+    actual_value?: number;
+    /** Difference between forecasts */
+    difference?: number;
+}
+/**
+ * EI Forecasts Resource
+ *
+ * Access EIA and IEA price and production forecasts.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest forecasts
+ * const latest = await client.ei.forecasts.latest();
+ * console.log(`Latest forecast: ${latest.forecast_value} ${latest.unit}`);
+ *
+ * // Get price forecasts
+ * const prices = await client.ei.forecasts.prices();
+ * prices.forEach(p => console.log(`${p.commodity}: $${p.forecast_price} (${p.source})`));
+ * ```
+ */
+export declare class EIForecastsResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all forecast records
+     *
+     * @returns Array of forecast records
+     */
+    list(): Promise<ForecastRecord[]>;
+    /**
+     * Get a specific forecast record
+     *
+     * @param id - Record ID
+     * @returns Forecast record
+     */
+    get(id: string): Promise<ForecastRecord>;
+    /**
+     * Get latest forecast data
+     *
+     * @returns Latest forecast record
+     */
+    latest(): Promise<ForecastRecord>;
+    /**
+     * Get forecast summary
+     *
+     * @returns Forecast summary statistics
+     */
+    summary(): Promise<ForecastSummary>;
+    /**
+     * Get price forecasts
+     *
+     * @returns Array of price forecasts
+     */
+    prices(): Promise<PriceForecast[]>;
+    /**
+     * Get production forecasts
+     *
+     * @returns Array of production forecasts
+     */
+    production(): Promise<ProductionForecast[]>;
+    /**
+     * Get historical forecast data
+     *
+     * @returns Array of historical forecasts with accuracy
+     */
+    historical(): Promise<HistoricalForecast[]>;
+    /**
+     * Compare forecasts from different sources
+     *
+     * @returns Array of forecast comparisons
+     */
+    compare(): Promise<ForecastComparison[]>;
+}

package/dist/resources/ei/forecasts.js

@@ -0,0 +1,101 @@
+/**
+ * Energy Intelligence - Forecasts Resource
+ *
+ * Access EIA and IEA price and production forecasts with historical accuracy metrics.
+ */
+/**
+ * EI Forecasts Resource
+ *
+ * Access EIA and IEA price and production forecasts.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest forecasts
+ * const latest = await client.ei.forecasts.latest();
+ * console.log(`Latest forecast: ${latest.forecast_value} ${latest.unit}`);
+ *
+ * // Get price forecasts
+ * const prices = await client.ei.forecasts.prices();
+ * prices.forEach(p => console.log(`${p.commodity}: $${p.forecast_price} (${p.source})`));
+ * ```
+ */
+export class EIForecastsResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all forecast records
+     *
+     * @returns Array of forecast records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/forecasts", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific forecast record
+     *
+     * @param id - Record ID
+     * @returns Forecast record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new Error("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/forecasts/${id}`, {});
+    }
+    /**
+     * Get latest forecast data
+     *
+     * @returns Latest forecast record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/forecasts/latest", {});
+    }
+    /**
+     * Get forecast summary
+     *
+     * @returns Forecast summary statistics
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/forecasts/summary", {});
+    }
+    /**
+     * Get price forecasts
+     *
+     * @returns Array of price forecasts
+     */
+    async prices() {
+        const response = await this.client["request"]("/v1/ei/forecasts/prices", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get production forecasts
+     *
+     * @returns Array of production forecasts
+     */
+    async production() {
+        const response = await this.client["request"]("/v1/ei/forecasts/production", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical forecast data
+     *
+     * @returns Array of historical forecasts with accuracy
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/forecasts/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Compare forecasts from different sources
+     *
+     * @returns Array of forecast comparisons
+     */
+    async compare() {
+        const response = await this.client["request"]("/v1/ei/forecasts/compare", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}