Models
oilpriceapi.models
OilPriceAPI Data Models
Pydantic models for API responses.
Price
Bases: BaseModel
Single price data point.
is_up
property
Check if price is up.
is_down
property
Check if price is down.
parse_timestamp(v)
classmethod
Parse timestamp from various formats.
__str__()
String representation.
PriceResponse
Bases: BaseModel
Response from current price endpoint.
MultiplePricesResponse
Bases: BaseModel
Response with multiple prices.
HistoricalPrice
Bases: BaseModel
Historical price data point.
parse_date(v)
classmethod
Parse date from various formats.
HistoricalResponse
Bases: BaseModel
Response from historical data endpoint.
PaginationMeta
Bases: BaseModel
Pagination metadata.
Commodity
Bases: BaseModel
Commodity information.
CommodityListResponse
Bases: BaseModel
Response with available commodities.
ApiStatus
Bases: BaseModel
API status information.
UsageStats
Bases: BaseModel
API usage statistics.
DieselPrice
Bases: BaseModel
State average diesel price data.
parse_updated_at(v)
classmethod
Parse updated_at from various formats.
DieselStationLocation
Bases: BaseModel
Geographic coordinates for a diesel station.
DieselStation
Bases: BaseModel
Diesel station with pricing information.
parse_last_updated(v)
classmethod
Parse last_updated from various formats.
DieselRegionalAverage
Bases: BaseModel
Regional average diesel price for comparison.
DieselSearchArea
Bases: BaseModel
Search area details for station query.
DieselStationsMetadata
Bases: BaseModel
Metadata about diesel stations query.
parse_timestamp(v)
classmethod
Parse timestamp from various formats.
DieselStationsResponse
Bases: BaseModel
Response from diesel stations endpoint.
PriceAlert
Bases: BaseModel
Price alert configuration and status.
parse_datetime(v)
classmethod
Parse datetime from various formats.
WebhookTestResponse
Bases: BaseModel
Response from webhook test endpoint.
MarketBriefForecast
Bases: BaseModel
1-month forecast block attached to a market-brief commodity.
MarketBriefCommodity
Bases: BaseModel
A single commodity entry within a market brief.
MarketBrief
Bases: BaseModel
Multi-commodity structured (+ optional narrative) market summary.
Returned by client.market_brief(...) / await client.market_brief(...).
parse_as_of(v)
classmethod
Parse as_of timestamp from various formats.
Subscription
Bases: BaseModel
An agent subscription ("watch") that periodically evaluates commodities.
parse_datetimes(v)
classmethod
Parse datetime fields from various formats.
SubscriptionEvent
Bases: BaseModel
A single event emitted by a subscription, returned from the poll endpoint.
parse_created_at(v)
classmethod
Parse created_at from various formats.
DataConnectorPrice
Bases: BaseModel
Price from connected data source (BYOS - Bring Your Own Subscription).
parse_timestamp(v)
classmethod
Parse timestamp from various formats.
__str__()
String representation.