Source code for kpler.sdk.enums

from enum import Enum


[docs]class BallastCapacityPortCallsSources(Enum): """""" Forecast = "Forecast" #: Market = "Market" #: AIS = "AIS" #: Port = "Port" #: Analyst = "Analyst" #: Fixture = "Fixture" #:
[docs]class BallastCapacityPortCallsVesselStates(Enum): """""" Ballast = "Ballast" #: Loaded = "Loaded" #:
[docs]class BallastCapacitySeriesPeriod(Enum): """""" Monthly = "monthly" #: Weekly = "weekly" #: Daily = "daily" #:
[docs]class BallastCapacitySeriesSplit(Enum): """""" Total = "total" #: Country = "country" #: Source = "source" #: VesselType = "vesselType" #: VesselTypeCpp = "vesselTypeCpp" #: VesselTypeOil = "vesselTypeOil" #:
[docs]class BallastCapacitySeriesUnit(Enum): """""" MT = "mt" #: KT = "kt" #:
[docs]class BallastCapacitySeriesMetric(Enum): """""" Count = "count" #: DeadWeight = "deadWeight" #: Capacity = "capacity" #:
[docs]class CongestionSeriesPeriod(Enum): """""" Annually = "years" #: Monthly = "months" #: Weekly = "weeks" #: Quarterly = "quarters" #: Daily = "days" #: EIA = "eia" #:
[docs]class CongestionVesselsPeriod(Enum): """""" Annually = "years" #: Monthly = "months" #: Weekly = "weeks" #: Quarterly = "quarters" #: Daily = "days" #: EIA = "eia" #:
[docs]class CongestionSeriesSplit(Enum): """""" Total = "total" #: Port = "port" #: Installation = "installation" #: Country = "country" #: VesselType = "vesselType" #: VesselTypeCpp = "vesselTypeCpp" #: VesselTypeOil = "vesselTypeOil" #: VesselOperations = "VesselOperations" #: WaitingStatus = "waitingStatus" #: Product = "product" #: Grade = "grade" #:
[docs]class CongestionSeriesUnit(Enum): """""" MT = "mt" #: KT = "kt" #:
[docs]class CongestionSeriesMetric(Enum): """""" Count = "count" #: DeadWeight = "deadWeight" #: Duration = "duration" #: Capacity = "capacity" #:
[docs]class CongestionSeriesOperation(Enum): """""" Load = "Load" #: Discharge = "Discharge" #: All = "All" #:
[docs]class CongestionVesselsOperation(Enum): """""" Load = "Load" #: Discharge = "Discharge" #: All = "All" #:
class Platform(Enum): """""" LNG = "https://api-lng.kpler.com/v1" #: LPG = "https://api-lpg.kpler.com/v1" #: Dry = "https://api-coal.kpler.com/v1" #: Liquids = "https://api.kpler.com/v1" #:
[docs]class TradesStatus(Enum): """""" Delivered = "delivered" #: Scheduled = "scheduled" #: Loading = "loading" #: InTransit = "in transit" #:
[docs]class FleetDevelopmentSeriesAggregationMetric(Enum): """""" Count = "count" #: SumCapacity = "sumcapacity" #: SumDeadWeight = "sumdeadweight" #:
[docs]class FleetDevelopmentSeriesMetric(Enum): """""" Available = "available" #: Deliveries = "deliveries" #: Scrapping = "scrapping" #: Contracting = "contracting" #:
[docs]class FleetDevelopmentSeriesPeriod(Enum): """""" Annually = "years" #: Monthly = "months" #: Quarterly = "quarters" #:
[docs]class FleetDevelopmentSeriesSplit(Enum): """""" Total = "total" #: ComplianceMethod = "complianceMethod" #: VesselType = "vesselType" #: VesselTypeOil = "vesselTypeOil" #: VesselTypeCpp = "vesselTypeCpp" #:
[docs]class FleetDevelopmentSeriesUnit(Enum): """""" MT = "mt" #: KT = "kt" #:
[docs]class FlowsDirection(Enum): """""" Import = "import" #: Export = "export" #: NetImport = "netimport" #: NetExport = "netexport" #:
[docs]class FlowsSplit(Enum): """""" Total = "total" #: Grades = "grades" #: Products = "products" #: OriginCountries = "origin countries" #: OriginSubcontinents = "origin subcontinents" #: OriginContinents = "origin continents" #: OriginTradingRegions = "origin trading regions" #: OriginPorts = "origin ports" DestinationTradingRegions = "destination trading regions" #: DestinationCountries = "destination countries" #: DestinationSubcontinents = "destination subcontinents" #: DestinationContinents = "destination continents" #: OriginInstallations = "origin installations" #: DestinationInstallations = "destination installations" #: DestinationPorts = "destination ports" OriginPadds = "origin padds" #: DestinationPadds = "destination padds" #: VesselType = "vessel type" #: TradeStatus = "trade status" #: Sources = "sources" #: Charterers = "charterers" #: Routes = "routes" #: Buyers = "buyer" #: Sellers = "seller" #: VesselTypeOil = "vessel type oil" #: VesselTypeCpp = "vessel type cpp" #: CrudeQuality = "crude quality" #:
[docs]class FlowsPeriod(Enum): """""" Annually = "annually" #: Monthly = "monthly" #: Weekly = "weekly" #: EiaWeekly = "eia-weekly" #: Daily = "daily" #:
[docs]class FlowsMeasurementUnit(Enum): """""" KBD = "kbd" #: BBL = "bbl" #: KB = "kb" #: MMBBL = "mmbbl" #: MT = "mt" #: KT = "kt" #: T = "t" #: CM = "cm" #:
[docs]class FreightMetricsSeriesMetric(Enum): """""" TonMiles = "TonMiles" #: TonDays = "TonDays" #: AvgSpeed = "AvgSpeed" #: AvgDistance = "AvgDistance" #:
[docs]class FreightMetricsSeriesPeriod(Enum): """""" Monthly = "monthly" #: Quarterly = "quarterly" #: Annually = "annually" #:
[docs]class FreightMetricsSeriesSplit(Enum): """""" Total = "total" #: DestinationCountry = "destinationCountry" #: OriginCountry = "originCountry" #: VesselType = "vesselType" #: VesselTypeOil = "vesselTypeOil" #: VesselTypeCpp = "vesselTypeCpp" #: DestinationInstallation = "destinationInstallation" #: OriginInstallation = "originInstallation" #: DestinationSourceEta = "destinationSourceEta" #: OriginSourceEta = "originSourceEta" #:
[docs]class FreightMetricsSeriesUnit(Enum): """""" MTNMI = "mt/nmi" #: KTNMI = "kt/nmi" #: TNMI = "t/nmi" #: TDAY = "t/day" #: KTDAY = "kt/day" #:
[docs]class VesselTypesDry(Enum): """""" BabyCapes = "Baby Capes" #: Capesize = "Capesize" #: Handymax = "Handymax" #: Handysize = "Handysize" #: Newcastlemax = "Newcastlemax" #: Kamsarmax = "Kamsarmax" #: Panamax = "Panamax" #: PostPanamax = "Post-Panamax" #: Supramax = "Supramax" #: Ultramax = "Ultramax" #: Valemax = "Valemax" #: VLOC = "VLOC" #:
[docs]class VesselTypesLPG(Enum): """""" SGC = "SGC" #: VLGC = "VLGC" #: Handysize = "Handysize" #: MGC = "MGC" #: LGC = "LGC" #: VLEC = "VLEC" #:
[docs]class VesselTypesLNG(Enum): """""" XLUpperConventional = "XL (Upper Conventional)" #: LLowerConventional = "L (Lower Conventional)" #: QFlex = "Q-Flex" #: XSPressureGas = "XS (Pressure Gas)" #: MMedMax = "M (Med Max)" #: SSmallSCale = "S (Small Scale)" #: QMax = "Q-Max" #:
[docs]class VesselTypesCPP(Enum): """""" LR2 = "LR2" #: VLCC = "VLCC" #: LR3 = "LR3" #: MR = "MR" #: GP = "GP" #: LR1 = "LR1" #:
[docs]class VesselTypesOil(Enum): """""" Aframax = "Aframax" #: ProductTanker = "Product Tanker" #: Suezmax = "Suezmax" #: VLCC = "VLCC" #: Panamax = "Panamax" #: ULCC = "ULCC" #:
[docs]class FleetDevelopmentVesselsComplianceMethods(Enum): """""" Scrubber = "Scrubber" #: ScrubberPlanned = "Scrubber Planned" #: ScrubberReady = "Scrubber Ready" #:
[docs]class FleetDevelopmentVesselsMetric(Enum): """""" Available = "available" #: Deliveries = "deliveries" #: Scrapping = "scrapping" #: Contracting = "contracting" #:
[docs]class FleetMetricsAlgo(Enum): """""" FloatingStorage = "floating_storage" #: LoadedVessels = "loaded_vessels" #:
[docs]class FleetMetricsPeriod(Enum): """""" Weekly = "weekly" #: Daily = "daily" #: EIA = "eia" #:
[docs]class FleetMetricsMeasurementUnit(Enum): """""" BBL = "bbl" #: T = "t" #: CM = "cm" #:
[docs]class FleetMetricsSplit(Enum): """""" Total = "total" #: Grades = "grades" #: Products = "products" #: OriginCountries = "origin countries" #: OriginTradingRegions = "origin trading regions" DestinationTradingRegions = "destination trading regions" OriginContinents = "origin continents" OriginSubcontinents = "origin subcontinents" DestinationSubcontinents = "destination subcontinents" OriginPorts = "origin ports" DestinationPorts = "destination ports" DestinationContinents = "destination continents" DestinationCountries = "destination countries" #: OriginInstallations = "origin installations" #: DestinationInstallations = "destination installations" #: VesselType = "vessel type" #: VesselTypeOil = "vessel type oil" VesselTypeCpp = "vessel type cpp" TradeStatus = "trade status" #: Charterers = "charterers" #: Buyer = "buyer" #: Seller = "seller" #: CurrentContinents = "current continents" #: CurrentSubcontinents = "current subcontinents" #: CurrentCountries = "current countries" #: CurrentSubregions = "current subregions" #: CurrentSeas = "current seas" #: FloatingDays = "floating days" #: CrudeQuality = "crude quality" #:
[docs]class FleetMetricsVesselsAlgo(Enum): """""" FloatingStorage = "floating_storage" #: LoadedVessels = "loaded_vessels" #:
[docs]class FleetMetricsVesselsMeasurementUnit(Enum): """""" BBL = "bbl" #: KB = "kb" #: MMBBL = "mmbbl" #: MT = "mt" #: KT = "kt" #: T = "t" #: CM = "cm" #:
[docs]class OutagesTypes(Enum): """""" Planned = "planned" #: Unplanned = "unplanned" #:
[docs]class PricesIndexes(Enum): """""" NBP = "NBP" #: TTF = "TTF" #: HenryHub = "Henry Hub" #: SingaporeSling = "Singapore Sling" #: NorthAsiaSling = "North Asia Sling" #: DKISling = "DKI Sling" #: RIMNEAsia = "RIM NE Asia" #: Brent = "Brent" #: JLC = "JLC" #: JCC = "JCC" #:
[docs]class ContractsTypes(Enum): """""" SPA = "SPA" #: TUA = "TUA" #: LTA = "LTA" #: Tender = "Tender" #:
[docs]class FleetUtilizationSeriesPeriod(Enum): """""" Annually = "years" #: Monthly = "months" #: Weekly = "weeks" #: Quarterly = "quarters" #: Daily = "days" #:
[docs]class FleetUtilizationVesselsPeriod(Enum): """""" Annually = "years" #: Monthly = "months" #: Weekly = "weeks" #: Quarterly = "quarters" #: Daily = "days" #:
[docs]class FleetUtilizationSeriesSplit(Enum): """""" Total = "total" #: Product = "product" #: State = "state" #: VesselType = "vesselType" #: VesselTypeOil = "vesselTypeOil" #: VesselTypeCpp = "vesselTypeCpp" #: SubState = "subState" #: Direction = "direction" #: CurrentSubContinents = "currentSubcontinents" #: CurrentContinents = "currentContinents" #: CurrentSubregions = "currentSubregions" #: CurrentCountries = "currentCountries" #: CurrentSeas = "currentSeas" #: PreviousTradingRegions = "previousTradingRegions" #: PreviousContinents = "previousContinents" #: PreviousSubContinents = "previousSubContinents" #: PreviousCountries = "previousCountries" #: PreviousPorts = "previousPorts" #: NextTradingRegions = "nextTradingRegions" #: NextContinents = "nextContinents" #: NextSubContinents = "nextSubContinents" #: NextCountries = "nextCountries" #: NextPorts = "nextPorts" #:
[docs]class FleetUtilizationSeriesUnit(Enum): """""" MT = "mt" #: KT = "kt" #:
[docs]class FleetUtilizationSeriesVesselsState(Enum): """""" Ballast = "Ballast" #: Loaded = "Loaded" #:
[docs]class FleetUtilizationSeriesMetric(Enum): """""" Count = "count" #: DeadWeight = "deadWeight" #:
[docs]class FleetUtilizationVesselsState(Enum): """""" Ballast = "Ballast" #: Loaded = "Loaded" #:
[docs]class FleetUtilizationVesselsUnit(Enum): """""" MT = "mt" #: KT = "kt" #:
[docs]class InventoriesPeriod(Enum): """""" Annually = "annually" #: Monthly = "monthly" #: Weekly = "weekly" #: EiaWeekly = "eia-weekly" #: Daily = "daily" #:
[docs]class InventoriesSplit(Enum): """""" Total = "total" #: ByCountry = "byCountry" #: ByInstallation = "byInstallation" #: ByPlayer = "byPlayer" #: ByTankType = "byTankType" #: ByOnshoreOffshoreStatus = "byOnshoreOffshoreStatus" #:
[docs]class InventoriesDronePeriod(Enum): """""" MidWeeks = "midweeks" #: EiaWeeks = "eia" #: Days = "days" #:
[docs]class DiversionsVesselState(Enum): """""" Ballast = "Ballast" #: Loaded = "Loaded" #:
[docs]class SupplyDemandSplit(Enum): """""" Total = "total" #: Country = "country" #:
[docs]class SupplyDemandMetric(Enum): """""" Supply = "supply" #: Demand = "demand" #: RefineryRun = "refineryRun" #: DirectCrudeUse = "directCrudeUse" #: Balance = "balance" #: NetExport = "netExport" #: StockChange = "stockChange" #: BalancingFactor = "balancingFactor" #:
[docs]class FixturesStatuses(Enum): """""" OnSubs = "on subs" #: InProgress = "in progress" #: FullyFixed = "fully fixed" #: Finished = "finished" #: Failed = "failed" #: Cancelled = "cancelled" #: