oilpriceapi 0.5.3 → 0.7.0

package/dist/resources/ei/oil-inventories.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Energy Intelligence - Oil Inventories Resource
+ *
+ * Access EIA crude oil inventory data including total US stocks, Cushing levels,
+ * and regional breakdowns.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * Oil inventory record
+ */
+export interface OilInventoryRecord {
+    /** Record ID */
+    id: string;
+    /** Inventory level in thousand barrels */
+    level: number;
+    /** Unit of measurement */
+    unit: string;
+    /** Product type (e.g., "crude_oil", "gasoline", "distillate") */
+    product?: string;
+    /** Location (e.g., "US_TOTAL", "CUSHING", "PADD1") */
+    location?: string;
+    /** Change from previous week */
+    change?: number;
+    /** Report date */
+    date: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Oil inventory summary
+ */
+export interface OilInventorySummary {
+    /** Total US crude oil stocks */
+    total_crude: number;
+    /** Cushing stocks */
+    cushing?: number;
+    /** SPR stocks */
+    spr?: number;
+    /** Total products */
+    total_products?: number;
+    /** Unit */
+    unit: string;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * Inventory by product type
+ */
+export interface InventoryByProduct {
+    /** Product type */
+    product: string;
+    /** Inventory level */
+    level: number;
+    /** Change from previous week */
+    change?: number;
+    /** Unit */
+    unit: string;
+    /** Date */
+    date: string;
+}
+/**
+ * Historical inventory data point
+ */
+export interface HistoricalInventory {
+    /** Date */
+    date: string;
+    /** Inventory level */
+    level: number;
+    /** Change */
+    change?: number;
+    /** Unit */
+    unit: string;
+}
+/**
+ * Cushing inventory data
+ */
+export interface CushingInventory {
+    /** Inventory level */
+    level: number;
+    /** Change from previous week */
+    change?: number;
+    /** Percentage of capacity */
+    capacity_percent?: number;
+    /** Unit */
+    unit: string;
+    /** Date */
+    date: string;
+}
+/**
+ * EI Oil Inventories Resource
+ *
+ * Access EIA crude oil and petroleum product inventory data.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest inventories
+ * const latest = await client.ei.oilInventories.latest();
+ * console.log(`Total crude: ${latest.level} ${latest.unit}`);
+ *
+ * // Get Cushing stocks
+ * const cushing = await client.ei.oilInventories.cushing();
+ * console.log(`Cushing: ${cushing.level} ${cushing.unit}`);
+ * ```
+ */
+export declare class EIOilInventoriesResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all oil inventory records
+     *
+     * @returns Array of inventory records
+     */
+    list(): Promise<OilInventoryRecord[]>;
+    /**
+     * Get a specific inventory record
+     *
+     * @param id - Record ID
+     * @returns Inventory record
+     */
+    get(id: string): Promise<OilInventoryRecord>;
+    /**
+     * Get latest oil inventory data
+     *
+     * @returns Latest inventory record
+     */
+    latest(): Promise<OilInventoryRecord>;
+    /**
+     * Get inventory summary
+     *
+     * @returns Inventory summary across all products
+     */
+    summary(): Promise<OilInventorySummary>;
+    /**
+     * Get inventories by product type
+     *
+     * @returns Array of inventories by product
+     */
+    byProduct(): Promise<InventoryByProduct[]>;
+    /**
+     * Get historical inventory data
+     *
+     * @returns Array of historical inventory levels
+     */
+    historical(): Promise<HistoricalInventory[]>;
+    /**
+     * Get Cushing, OK inventory data
+     *
+     * @returns Cushing inventory data
+     */
+    cushing(): Promise<CushingInventory>;
+}

package/dist/resources/ei/oil-inventories.js

@@ -0,0 +1,92 @@
+/**
+ * Energy Intelligence - Oil Inventories Resource
+ *
+ * Access EIA crude oil inventory data including total US stocks, Cushing levels,
+ * and regional breakdowns.
+ */
+/**
+ * EI Oil Inventories Resource
+ *
+ * Access EIA crude oil and petroleum product inventory data.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest inventories
+ * const latest = await client.ei.oilInventories.latest();
+ * console.log(`Total crude: ${latest.level} ${latest.unit}`);
+ *
+ * // Get Cushing stocks
+ * const cushing = await client.ei.oilInventories.cushing();
+ * console.log(`Cushing: ${cushing.level} ${cushing.unit}`);
+ * ```
+ */
+export class EIOilInventoriesResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all oil inventory records
+     *
+     * @returns Array of inventory records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/oil_inventories", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific inventory record
+     *
+     * @param id - Record ID
+     * @returns Inventory 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/oil_inventories/${id}`, {});
+    }
+    /**
+     * Get latest oil inventory data
+     *
+     * @returns Latest inventory record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/oil_inventories/latest", {});
+    }
+    /**
+     * Get inventory summary
+     *
+     * @returns Inventory summary across all products
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/oil_inventories/summary", {});
+    }
+    /**
+     * Get inventories by product type
+     *
+     * @returns Array of inventories by product
+     */
+    async byProduct() {
+        const response = await this.client["request"]("/v1/ei/oil_inventories/by_product", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical inventory data
+     *
+     * @returns Array of historical inventory levels
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/oil_inventories/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get Cushing, OK inventory data
+     *
+     * @returns Cushing inventory data
+     */
+    async cushing() {
+        return this.client["request"]("/v1/ei/oil_inventories/cushing", {});
+    }
+}

package/dist/resources/ei/opec-production.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Energy Intelligence - OPEC Production Resource
+ *
+ * Access OPEC crude oil production data by country with historical trends.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * OPEC production record
+ */
+export interface OPECProductionRecord {
+    /** Record ID */
+    id: string;
+    /** Country name */
+    country?: string;
+    /** Production volume in barrels per day */
+    production_bpd: number;
+    /** Unit of measurement */
+    unit: string;
+    /** Change from previous month */
+    change?: number;
+    /** Report date */
+    date: string;
+    /** Month */
+    month?: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Total OPEC production
+ */
+export interface TotalOPECProduction {
+    /** Total production in barrels per day */
+    total_production_bpd: number;
+    /** Change from previous month */
+    change?: number;
+    /** Unit */
+    unit: string;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * Production by country
+ */
+export interface ProductionByCountry {
+    /** Country name */
+    country: string;
+    /** Production in barrels per day */
+    production_bpd: number;
+    /** Change from previous month */
+    change?: number;
+    /** Percentage of total OPEC production */
+    percentage?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Historical production data point
+ */
+export interface HistoricalProduction {
+    /** Date */
+    date: string;
+    /** Production in barrels per day */
+    production_bpd: number;
+    /** Change */
+    change?: number;
+}
+/**
+ * Top producer data
+ */
+export interface TopProducer {
+    /** Country name */
+    country: string;
+    /** Production in barrels per day */
+    production_bpd: number;
+    /** Percentage of total */
+    percentage: number;
+    /** Rank */
+    rank: number;
+}
+/**
+ * EI OPEC Production Resource
+ *
+ * Access OPEC crude oil production data and analytics.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get total OPEC production
+ * const total = await client.ei.opecProduction.total();
+ * console.log(`Total OPEC: ${total.total_production_bpd} bpd`);
+ *
+ * // Get top producers
+ * const top = await client.ei.opecProduction.topProducers();
+ * top.forEach(p => console.log(`${p.rank}. ${p.country}: ${p.production_bpd} bpd`));
+ * ```
+ */
+export declare class EIOPECProductionResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all OPEC production records
+     *
+     * @returns Array of production records
+     */
+    list(): Promise<OPECProductionRecord[]>;
+    /**
+     * Get a specific production record
+     *
+     * @param id - Record ID
+     * @returns Production record
+     */
+    get(id: string): Promise<OPECProductionRecord>;
+    /**
+     * Get latest OPEC production data
+     *
+     * @returns Latest production record
+     */
+    latest(): Promise<OPECProductionRecord>;
+    /**
+     * Get total OPEC production
+     *
+     * @returns Total OPEC production summary
+     */
+    total(): Promise<TotalOPECProduction>;
+    /**
+     * Get production by country
+     *
+     * @returns Array of production by country
+     */
+    byCountry(): Promise<ProductionByCountry[]>;
+    /**
+     * Get historical production data
+     *
+     * @returns Array of historical production levels
+     */
+    historical(): Promise<HistoricalProduction[]>;
+    /**
+     * Get top OPEC producers
+     *
+     * @returns Array of top producing countries
+     */
+    topProducers(): Promise<TopProducer[]>;
+}

package/dist/resources/ei/opec-production.js

@@ -0,0 +1,92 @@
+/**
+ * Energy Intelligence - OPEC Production Resource
+ *
+ * Access OPEC crude oil production data by country with historical trends.
+ */
+/**
+ * EI OPEC Production Resource
+ *
+ * Access OPEC crude oil production data and analytics.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get total OPEC production
+ * const total = await client.ei.opecProduction.total();
+ * console.log(`Total OPEC: ${total.total_production_bpd} bpd`);
+ *
+ * // Get top producers
+ * const top = await client.ei.opecProduction.topProducers();
+ * top.forEach(p => console.log(`${p.rank}. ${p.country}: ${p.production_bpd} bpd`));
+ * ```
+ */
+export class EIOPECProductionResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all OPEC production records
+     *
+     * @returns Array of production records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/opec_productions", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific production record
+     *
+     * @param id - Record ID
+     * @returns Production 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/opec_productions/${id}`, {});
+    }
+    /**
+     * Get latest OPEC production data
+     *
+     * @returns Latest production record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/opec_productions/latest", {});
+    }
+    /**
+     * Get total OPEC production
+     *
+     * @returns Total OPEC production summary
+     */
+    async total() {
+        return this.client["request"]("/v1/ei/opec_productions/total", {});
+    }
+    /**
+     * Get production by country
+     *
+     * @returns Array of production by country
+     */
+    async byCountry() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/by_country", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical production data
+     *
+     * @returns Array of historical production levels
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get top OPEC producers
+     *
+     * @returns Array of top producing countries
+     */
+    async topProducers() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/top_producers", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}

package/dist/resources/ei/rig-counts.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Energy Intelligence - Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with basin, state, and historical breakdowns.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * Rig count record
+ */
+export interface RigCountRecord {
+    /** Record ID */
+    id: string;
+    /** Total rig count */
+    total_rigs: number;
+    /** Oil rigs */
+    oil_rigs?: number;
+    /** Gas rigs */
+    gas_rigs?: number;
+    /** Miscellaneous rigs */
+    misc_rigs?: number;
+    /** Report date */
+    date: string;
+    /** Week number */
+    week?: number;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Rig count by basin
+ */
+export interface RigCountByBasin {
+    /** Basin name */
+    basin: string;
+    /** Rig count */
+    rig_count: number;
+    /** Change from previous week */
+    change?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Rig count by state
+ */
+export interface RigCountByState {
+    /** State name */
+    state: string;
+    /** Rig count */
+    rig_count: number;
+    /** Change from previous week */
+    change?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Historical rig count data point
+ */
+export interface HistoricalRigCount {
+    /** Date */
+    date: string;
+    /** Total rigs */
+    total_rigs: number;
+    /** Oil rigs */
+    oil_rigs?: number;
+    /** Gas rigs */
+    gas_rigs?: number;
+}
+/**
+ * EI Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with comprehensive breakdowns.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest rig count
+ * const latest = await client.ei.rigCounts.latest();
+ * console.log(`Total rigs: ${latest.total_rigs}`);
+ *
+ * // Get by basin
+ * const basins = await client.ei.rigCounts.byBasin();
+ * basins.forEach(b => console.log(`${b.basin}: ${b.rig_count} rigs`));
+ * ```
+ */
+export declare class EIRigCountsResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all rig count records
+     *
+     * @returns Array of rig count records
+     *
+     * @throws {OilPriceAPIError} If API request fails
+     */
+    list(): Promise<RigCountRecord[]>;
+    /**
+     * Get a specific rig count record
+     *
+     * @param id - Record ID
+     * @returns Rig count record
+     *
+     * @throws {NotFoundError} If record not found
+     */
+    get(id: string): Promise<RigCountRecord>;
+    /**
+     * Get latest rig count
+     *
+     * @returns Latest rig count data
+     */
+    latest(): Promise<RigCountRecord>;
+    /**
+     * Get rig counts by basin
+     *
+     * @returns Array of rig counts by basin
+     */
+    byBasin(): Promise<RigCountByBasin[]>;
+    /**
+     * Get rig counts by state
+     *
+     * @returns Array of rig counts by state
+     */
+    byState(): Promise<RigCountByState[]>;
+    /**
+     * Get historical rig count data
+     *
+     * @returns Array of historical rig counts
+     */
+    historical(): Promise<HistoricalRigCount[]>;
+}

package/dist/resources/ei/rig-counts.js

@@ -0,0 +1,88 @@
+/**
+ * Energy Intelligence - Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with basin, state, and historical breakdowns.
+ */
+/**
+ * EI Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with comprehensive breakdowns.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest rig count
+ * const latest = await client.ei.rigCounts.latest();
+ * console.log(`Total rigs: ${latest.total_rigs}`);
+ *
+ * // Get by basin
+ * const basins = await client.ei.rigCounts.byBasin();
+ * basins.forEach(b => console.log(`${b.basin}: ${b.rig_count} rigs`));
+ * ```
+ */
+export class EIRigCountsResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all rig count records
+     *
+     * @returns Array of rig count records
+     *
+     * @throws {OilPriceAPIError} If API request fails
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/rig_counts", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific rig count record
+     *
+     * @param id - Record ID
+     * @returns Rig count record
+     *
+     * @throws {NotFoundError} If record not found
+     */
+    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/rig_counts/${id}`, {});
+    }
+    /**
+     * Get latest rig count
+     *
+     * @returns Latest rig count data
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/rig_counts/latest", {});
+    }
+    /**
+     * Get rig counts by basin
+     *
+     * @returns Array of rig counts by basin
+     */
+    async byBasin() {
+        const response = await this.client["request"]("/v1/ei/rig_counts/by_basin", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get rig counts by state
+     *
+     * @returns Array of rig counts by state
+     */
+    async byState() {
+        const response = await this.client["request"]("/v1/ei/rig_counts/by_state", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical rig count data
+     *
+     * @returns Array of historical rig counts
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/rig_counts/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}