oilpriceapi 0.5.3 → 0.7.0

package/dist/resources/ei/frac-focus.d.ts

@@ -0,0 +1,212 @@
+/**
+ * Energy Intelligence - FracFocus Resource
+ *
+ * Access hydraulic fracturing disclosure data including chemicals, operators,
+ * and well-level information from the FracFocus registry.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * FracFocus disclosure record
+ */
+export interface FracFocusRecord {
+    /** Record ID */
+    id: string;
+    /** API well number */
+    api_number: string;
+    /** State */
+    state: string;
+    /** County */
+    county?: string;
+    /** Operator name */
+    operator?: string;
+    /** Well name */
+    well_name?: string;
+    /** Job start date */
+    job_start_date?: string;
+    /** Job end date */
+    job_end_date?: string;
+    /** Total base water volume (gallons) */
+    total_base_water_volume?: number;
+    /** Total base non-water volume (gallons) */
+    total_base_non_water_volume?: number;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * FracFocus summary
+ */
+export interface FracFocusSummary {
+    /** Total disclosures */
+    total_disclosures: number;
+    /** Disclosures by state */
+    by_state?: Record<string, number>;
+    /** Disclosures by operator */
+    by_operator?: Record<string, number>;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * Disclosures by state
+ */
+export interface DisclosuresByState {
+    /** State name */
+    state: string;
+    /** Disclosure count */
+    disclosure_count: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Disclosures by operator
+ */
+export interface DisclosuresByOperator {
+    /** Operator name */
+    operator: string;
+    /** Disclosure count */
+    disclosure_count: number;
+    /** Percentage of total */
+    percentage?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Chemical usage data
+ */
+export interface ChemicalUsage {
+    /** Chemical name */
+    chemical_name: string;
+    /** CAS number */
+    cas_number?: string;
+    /** Usage count */
+    usage_count: number;
+    /** Percentage of total */
+    percentage?: number;
+}
+/**
+ * Chemical detail for a specific well
+ */
+export interface WellChemical {
+    /** Chemical name */
+    chemical_name: string;
+    /** CAS number */
+    cas_number?: string;
+    /** Purpose */
+    purpose?: string;
+    /** Ingredient concentration (%) */
+    concentration_percent?: number;
+    /** Mass used (lbs) */
+    mass_lbs?: number;
+}
+/**
+ * FracFocus search query
+ */
+export interface FracFocusSearchQuery {
+    /** State filter */
+    state?: string;
+    /** Operator filter */
+    operator?: string;
+    /** Chemical filter */
+    chemical?: string;
+    /** Start date */
+    start_date?: string;
+    /** End date */
+    end_date?: string;
+}
+/**
+ * EI FracFocus Resource
+ *
+ * Access hydraulic fracturing disclosure data from the FracFocus registry.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest disclosure
+ * const latest = await client.ei.fracFocus.latest();
+ * console.log(`Well: ${latest.well_name} (API: ${latest.api_number})`);
+ *
+ * // Get disclosures by state
+ * const states = await client.ei.fracFocus.byState();
+ * states.forEach(s => console.log(`${s.state}: ${s.disclosure_count} disclosures`));
+ *
+ * // Get chemicals for a specific well
+ * const chemicals = await client.ei.fracFocus.chemicals('42-123-12345');
+ * chemicals.forEach(c => console.log(`${c.chemical_name}: ${c.concentration_percent}%`));
+ *
+ * // Search disclosures
+ * const results = await client.ei.fracFocus.search({
+ *   state: 'Texas',
+ *   operator: 'EOG Resources'
+ * });
+ * ```
+ */
+export declare class EIFracFocusResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all FracFocus disclosure records
+     *
+     * @returns Array of disclosure records
+     */
+    list(): Promise<FracFocusRecord[]>;
+    /**
+     * Get a specific FracFocus disclosure record
+     *
+     * @param id - Record ID
+     * @returns Disclosure record
+     */
+    get(id: string): Promise<FracFocusRecord>;
+    /**
+     * Get latest FracFocus disclosure
+     *
+     * @returns Latest disclosure record
+     */
+    latest(): Promise<FracFocusRecord>;
+    /**
+     * Get FracFocus summary
+     *
+     * @returns Disclosure summary statistics
+     */
+    summary(): Promise<FracFocusSummary>;
+    /**
+     * Get disclosures by state
+     *
+     * @returns Array of disclosures grouped by state
+     */
+    byState(): Promise<DisclosuresByState[]>;
+    /**
+     * Get disclosures by operator
+     *
+     * @returns Array of disclosures grouped by operator
+     */
+    byOperator(): Promise<DisclosuresByOperator[]>;
+    /**
+     * Get chemical usage statistics
+     *
+     * @returns Array of chemicals used in fracturing
+     */
+    byChemical(): Promise<ChemicalUsage[]>;
+    /**
+     * Search FracFocus disclosures
+     *
+     * @param query - Search query parameters
+     * @returns Array of matching disclosure records
+     */
+    search(query: FracFocusSearchQuery): Promise<FracFocusRecord[]>;
+    /**
+     * Get chemicals used in a specific well
+     *
+     * @param id - Disclosure record ID
+     * @returns Array of chemicals used in the well
+     */
+    chemicals(id: string): Promise<WellChemical[]>;
+    /**
+     * Get FracFocus disclosures for a specific well by API number
+     *
+     * @param apiNumber - API well number (e.g., "42-123-12345")
+     * @returns Array of disclosure records for the well
+     */
+    forWell(apiNumber: string): Promise<FracFocusRecord[]>;
+}

package/dist/resources/ei/frac-focus.js

@@ -0,0 +1,150 @@
+/**
+ * Energy Intelligence - FracFocus Resource
+ *
+ * Access hydraulic fracturing disclosure data including chemicals, operators,
+ * and well-level information from the FracFocus registry.
+ */
+/**
+ * EI FracFocus Resource
+ *
+ * Access hydraulic fracturing disclosure data from the FracFocus registry.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest disclosure
+ * const latest = await client.ei.fracFocus.latest();
+ * console.log(`Well: ${latest.well_name} (API: ${latest.api_number})`);
+ *
+ * // Get disclosures by state
+ * const states = await client.ei.fracFocus.byState();
+ * states.forEach(s => console.log(`${s.state}: ${s.disclosure_count} disclosures`));
+ *
+ * // Get chemicals for a specific well
+ * const chemicals = await client.ei.fracFocus.chemicals('42-123-12345');
+ * chemicals.forEach(c => console.log(`${c.chemical_name}: ${c.concentration_percent}%`));
+ *
+ * // Search disclosures
+ * const results = await client.ei.fracFocus.search({
+ *   state: 'Texas',
+ *   operator: 'EOG Resources'
+ * });
+ * ```
+ */
+export class EIFracFocusResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all FracFocus disclosure records
+     *
+     * @returns Array of disclosure records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/frac-focus", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific FracFocus disclosure record
+     *
+     * @param id - Record ID
+     * @returns Disclosure 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/frac-focus/${id}`, {});
+    }
+    /**
+     * Get latest FracFocus disclosure
+     *
+     * @returns Latest disclosure record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/frac-focus/latest", {});
+    }
+    /**
+     * Get FracFocus summary
+     *
+     * @returns Disclosure summary statistics
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/frac-focus/summary", {});
+    }
+    /**
+     * Get disclosures by state
+     *
+     * @returns Array of disclosures grouped by state
+     */
+    async byState() {
+        const response = await this.client["request"]("/v1/ei/frac-focus/by-state", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get disclosures by operator
+     *
+     * @returns Array of disclosures grouped by operator
+     */
+    async byOperator() {
+        const response = await this.client["request"]("/v1/ei/frac-focus/by-operator", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get chemical usage statistics
+     *
+     * @returns Array of chemicals used in fracturing
+     */
+    async byChemical() {
+        const response = await this.client["request"]("/v1/ei/frac-focus/by-chemical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Search FracFocus disclosures
+     *
+     * @param query - Search query parameters
+     * @returns Array of matching disclosure records
+     */
+    async search(query) {
+        const params = {};
+        if (query.state)
+            params.state = query.state;
+        if (query.operator)
+            params.operator = query.operator;
+        if (query.chemical)
+            params.chemical = query.chemical;
+        if (query.start_date)
+            params.start_date = query.start_date;
+        if (query.end_date)
+            params.end_date = query.end_date;
+        const response = await this.client["request"]("/v1/ei/frac-focus/search", params);
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get chemicals used in a specific well
+     *
+     * @param id - Disclosure record ID
+     * @returns Array of chemicals used in the well
+     */
+    async chemicals(id) {
+        if (!id || typeof id !== "string") {
+            throw new Error("Disclosure ID must be a non-empty string");
+        }
+        const response = await this.client["request"](`/v1/ei/frac-focus/${id}/chemicals`, {});
+        return Array.isArray(response) ? response : response.chemicals;
+    }
+    /**
+     * Get FracFocus disclosures for a specific well by API number
+     *
+     * @param apiNumber - API well number (e.g., "42-123-12345")
+     * @returns Array of disclosure records for the well
+     */
+    async forWell(apiNumber) {
+        if (!apiNumber || typeof apiNumber !== "string") {
+            throw new Error("API number must be a non-empty string");
+        }
+        const response = await this.client["request"](`/v1/ei/frac-focus/for-well/${apiNumber}`, {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}

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

@@ -0,0 +1,140 @@
+/**
+ * Energy Intelligence Resource
+ *
+ * Comprehensive energy market intelligence including rig counts, inventories,
+ * OPEC production, drilling productivity, forecasts, well permits, and FracFocus data.
+ */
+import type { OilPriceAPI } from "../../client.js";
+import { EIRigCountsResource } from "./rig-counts.js";
+import { EIOilInventoriesResource } from "./oil-inventories.js";
+import { EIOPECProductionResource } from "./opec-production.js";
+import { EIDrillingProductivityResource } from "./drilling-productivity.js";
+import { EIForecastsResource } from "./forecasts.js";
+import { EIWellPermitsResource } from "./well-permits.js";
+import { EIFracFocusResource } from "./frac-focus.js";
+/**
+ * Well timeline event
+ */
+export interface WellTimelineEvent {
+    /** Event type */
+    event_type: string;
+    /** Event date */
+    date: string;
+    /** Event description */
+    description?: string;
+    /** Source of data */
+    source?: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Well timeline data
+ */
+export interface WellTimeline {
+    /** API well number */
+    api_number: string;
+    /** Well name */
+    well_name?: string;
+    /** Operator */
+    operator?: string;
+    /** State */
+    state?: string;
+    /** Timeline events */
+    events: WellTimelineEvent[];
+}
+/**
+ * Energy Intelligence Resource
+ *
+ * Access comprehensive energy market intelligence from EIA, Baker Hughes,
+ * FracFocus, and other authoritative sources.
+ *
+ * @example
+ * ```typescript
+ * import { OilPriceAPI } from 'oilpriceapi';
+ *
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Rig counts
+ * const rigCounts = await client.ei.rigCounts.latest();
+ * console.log(`Total rigs: ${rigCounts.total_rigs}`);
+ *
+ * // Oil inventories
+ * const inventories = await client.ei.oilInventories.latest();
+ * console.log(`Crude stocks: ${inventories.level} ${inventories.unit}`);
+ *
+ * // OPEC production
+ * const opec = await client.ei.opecProduction.total();
+ * console.log(`OPEC production: ${opec.total_production_bpd} bpd`);
+ *
+ * // Well timeline
+ * const timeline = await client.ei.wellTimeline('42-123-12345');
+ * timeline.events.forEach(e => {
+ *   console.log(`${e.date}: ${e.event_type}`);
+ * });
+ * ```
+ */
+export declare class EnergyIntelligenceResource {
+    private client;
+    /**
+     * Baker Hughes rig count data
+     */
+    readonly rigCounts: EIRigCountsResource;
+    /**
+     * EIA crude oil inventory data
+     */
+    readonly oilInventories: EIOilInventoriesResource;
+    /**
+     * OPEC production data
+     */
+    readonly opecProduction: EIOPECProductionResource;
+    /**
+     * EIA drilling productivity report data
+     */
+    readonly drillingProductivity: EIDrillingProductivityResource;
+    /**
+     * EIA and IEA forecast data
+     */
+    readonly forecasts: EIForecastsResource;
+    /**
+     * Well permit data
+     */
+    readonly wellPermits: EIWellPermitsResource;
+    /**
+     * FracFocus disclosure data
+     */
+    readonly fracFocus: EIFracFocusResource;
+    constructor(client: OilPriceAPI);
+    /**
+     * Get well timeline by API number
+     *
+     * Returns chronological timeline of events for a specific well including
+     * permits, drilling, completion, production, and FracFocus disclosures.
+     *
+     * @param apiNumber - API well number (e.g., "42-123-12345")
+     * @returns Well timeline with events
+     *
+     * @throws {NotFoundError} If well not found
+     * @throws {OilPriceAPIError} If API request fails
+     *
+     * @example
+     * ```typescript
+     * const timeline = await client.ei.wellTimeline('42-123-12345');
+     * console.log(`Well: ${timeline.well_name}`);
+     * console.log(`Operator: ${timeline.operator}`);
+     * console.log(`Events: ${timeline.events.length}`);
+     *
+     * timeline.events.forEach(event => {
+     *   console.log(`${event.date}: ${event.event_type} - ${event.description}`);
+     * });
+     * ```
+     */
+    wellTimeline(apiNumber: string): Promise<WellTimeline>;
+}
+export type { RigCountRecord, RigCountByBasin, RigCountByState, HistoricalRigCount, } from "./rig-counts.js";
+export type { OilInventoryRecord, OilInventorySummary, InventoryByProduct, HistoricalInventory, CushingInventory, } from "./oil-inventories.js";
+export type { OPECProductionRecord, TotalOPECProduction, ProductionByCountry, HistoricalProduction, TopProducer, } from "./opec-production.js";
+export type { DrillingProductivityRecord, DrillingProductivitySummary, DUCWellInventory, ProductivityByBasin, HistoricalProductivity, ProductivityTrend, } from "./drilling-productivity.js";
+export type { ForecastRecord, ForecastSummary, PriceForecast, ProductionForecast, HistoricalForecast, ForecastComparison, } from "./forecasts.js";
+export type { WellPermitRecord, WellPermitSummary, PermitsByState, PermitsByOperator, PermitsByFormation, WellPermitSearchQuery, } from "./well-permits.js";
+export type { FracFocusRecord, FracFocusSummary, DisclosuresByState, DisclosuresByOperator, ChemicalUsage, WellChemical, FracFocusSearchQuery, } from "./frac-focus.js";
+export { EIRigCountsResource, EIOilInventoriesResource, EIOPECProductionResource, EIDrillingProductivityResource, EIForecastsResource, EIWellPermitsResource, EIFracFocusResource, };

package/dist/resources/ei/index.js

@@ -0,0 +1,87 @@
+/**
+ * Energy Intelligence Resource
+ *
+ * Comprehensive energy market intelligence including rig counts, inventories,
+ * OPEC production, drilling productivity, forecasts, well permits, and FracFocus data.
+ */
+import { EIRigCountsResource } from "./rig-counts.js";
+import { EIOilInventoriesResource } from "./oil-inventories.js";
+import { EIOPECProductionResource } from "./opec-production.js";
+import { EIDrillingProductivityResource } from "./drilling-productivity.js";
+import { EIForecastsResource } from "./forecasts.js";
+import { EIWellPermitsResource } from "./well-permits.js";
+import { EIFracFocusResource } from "./frac-focus.js";
+/**
+ * Energy Intelligence Resource
+ *
+ * Access comprehensive energy market intelligence from EIA, Baker Hughes,
+ * FracFocus, and other authoritative sources.
+ *
+ * @example
+ * ```typescript
+ * import { OilPriceAPI } from 'oilpriceapi';
+ *
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Rig counts
+ * const rigCounts = await client.ei.rigCounts.latest();
+ * console.log(`Total rigs: ${rigCounts.total_rigs}`);
+ *
+ * // Oil inventories
+ * const inventories = await client.ei.oilInventories.latest();
+ * console.log(`Crude stocks: ${inventories.level} ${inventories.unit}`);
+ *
+ * // OPEC production
+ * const opec = await client.ei.opecProduction.total();
+ * console.log(`OPEC production: ${opec.total_production_bpd} bpd`);
+ *
+ * // Well timeline
+ * const timeline = await client.ei.wellTimeline('42-123-12345');
+ * timeline.events.forEach(e => {
+ *   console.log(`${e.date}: ${e.event_type}`);
+ * });
+ * ```
+ */
+export class EnergyIntelligenceResource {
+    constructor(client) {
+        this.client = client;
+        this.rigCounts = new EIRigCountsResource(client);
+        this.oilInventories = new EIOilInventoriesResource(client);
+        this.opecProduction = new EIOPECProductionResource(client);
+        this.drillingProductivity = new EIDrillingProductivityResource(client);
+        this.forecasts = new EIForecastsResource(client);
+        this.wellPermits = new EIWellPermitsResource(client);
+        this.fracFocus = new EIFracFocusResource(client);
+    }
+    /**
+     * Get well timeline by API number
+     *
+     * Returns chronological timeline of events for a specific well including
+     * permits, drilling, completion, production, and FracFocus disclosures.
+     *
+     * @param apiNumber - API well number (e.g., "42-123-12345")
+     * @returns Well timeline with events
+     *
+     * @throws {NotFoundError} If well not found
+     * @throws {OilPriceAPIError} If API request fails
+     *
+     * @example
+     * ```typescript
+     * const timeline = await client.ei.wellTimeline('42-123-12345');
+     * console.log(`Well: ${timeline.well_name}`);
+     * console.log(`Operator: ${timeline.operator}`);
+     * console.log(`Events: ${timeline.events.length}`);
+     *
+     * timeline.events.forEach(event => {
+     *   console.log(`${event.date}: ${event.event_type} - ${event.description}`);
+     * });
+     * ```
+     */
+    async wellTimeline(apiNumber) {
+        if (!apiNumber || typeof apiNumber !== "string") {
+            throw new Error("API number must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/wells/${apiNumber}/timeline`, {});
+    }
+}
+export { EIRigCountsResource, EIOilInventoriesResource, EIOPECProductionResource, EIDrillingProductivityResource, EIForecastsResource, EIWellPermitsResource, EIFracFocusResource, };