vortexasdk.endpoints.refineries

Try me out in your browser:

Binder

Refineries

Refineries(self)

Refineries endpoint.

load_all

Refineries.load_all()

Load all refineries.

search

Refineries.search(
  term: typing.Union[str, typing.List[str], NoneType] = None,
  size: typing.Optional[int] = None,
  ids: typing.Union[str, typing.List[str], NoneType] = None,
  refinery_name: typing.Optional[str] = None,
  status:
    typing.Optional[typing.Literal['Active', 'Shut', 'Unknown', 'Upcoming']] = None,
  owner_id: typing.Union[str, typing.List[str], NoneType] = None,
  operator_id: typing.Union[str, typing.List[str], NoneType] = None,
  exact_term_match: bool = False)

Find all refineries matching the given search arguments. Search arguments are combined in an AND manner.

Arguments

  • term: The name(s) (or partial name(s)) of a refinery to search.
  • ids: ID or IDs of refineries to search.
  • refinery_name: The exact refinery name to search.
  • status: The current status of the refinery. Must be one of "Active", "Shut", "Unknown", or "Upcoming".
  • owner_id: Owner ID or list of owner IDs to filter the refineries.
  • operator_id: Operator ID or list of operator IDs to filter the refineries.
  • exact_term_match: If True, only exact name matches will be returned. If False, similar matches are allowed.

Returns

List of refineries matching the search arguments.

Examples

  • Let's find all the Refineries with 'San' in their name.
>>> from vortexasdk import Refineries
>>> refineries = Refineries().search("San").to_df(columns=['name', 'country_name'])
name country_name
0 San Lorenzo Refinery Oil Combustibles Argentina
1 Gibraltar-San Roque Refinery Spain

Further Documentation

VortexaAPI Refineries Reference

reference

Refineries.reference(id: str)

Perform a refinery lookup.

Arguments

  • id: Refinery ID to lookup

Returns

Refinery record matching the ID

Further Documentation:

VortexaAPI Refinery Reference