vortexasdk.endpoints.onshore_inventories_search

Try me out in your browser:

OnshoreInventoriesSearch

OnshoreInventoriesSearch(self)

Crude Onshore Inventories Endpoint, use this to search through Vortexa's Onshore Inventory data. Please note: you will require a subscription to our Crude Onshore Inventories module to access this endpoint.

search

OnshoreInventoriesSearch.search(
  asset_tank_ids: typing.Union[str, typing.List[str], NoneType] = None,
  corporate_entity_ids:
    typing.Union[str, typing.List[str], NoneType] = None,
  crude_confidence: typing.Optional[typing.List[str]] = None,
  location_ids: typing.Union[str, typing.List[str], NoneType] = None,
  measurement_ids: typing.Union[str, typing.List[str], NoneType] = None,
  order: typing.Optional[str] = None,
  order_direction: typing.Optional[str] = None,
  size: typing.Optional[int] = None,
  storage_types: typing.Optional[typing.List[str]] = None,
  time_min: typing.Optional[datetime.datetime] = None,
  time_max: typing.Optional[datetime.datetime] = None)

List of crude onshore inventories across the globe.

Arguments

asset_tank_ids: An array of tank IDs to filter on.
corporate_entity_ids: An array of owner ID(s) to filter on.
crude_confidence: An array of confidence metrics to filter on. Possible values are: `'confirmed'`, `'probable'`, `'unlikely'`
location_ids: An array of geography ID(s) to filter on.
measurement_ids: An array of unique measurements (each COI measurement) to filter on.
order: Used to sort the returned results. Can be one of:`'measurement_id'`, `'tank_id'`.
order_direction: Determines the direction of sorting. ‘asc’ for ascending, ‘desc’ for descending.
size: Used to page results. The size of the result set. Between 0 and 500.
storage_types: An array of storage types to filter on. Possible values are: `'refinery'`, `'commercial'`, `'spr'`.
time_min: The UTC start date of the time filter.
time_max: The UTC end date of the time filter.

Returns

OnshoreInventoriesResult

Data frame example

Top 5 Crude Onshore Inventories where 'crude_confidence' status is 'confirmed'.

>>> from vortexasdk import OnshoreInventoriesSearch
>>> df = OnshoreInventoriesSearch().search(crude_confidence=['confirmed']).to_df().head(5)

	measurement_id	tank_id	tank_details.capacity_bbl	...	fill_bbl	fill_tons	fill_cbm
0	1e41bdfc8fa21a1f3d874d41a	af83f5475ebd45b9167254667	225055	...	194898	26648.208642	30986.443224
1	211d96e43ff6893d555f8e7e0	f7c583b26ff8d4e50d4ba9da5	658327	...	131804	18021.429116	20955.254352
2	5ef5595cadf0161f6b59a0769	7047360864070b7a08802ae82	209196	...	468790	64097.187910	74531.984520
3	b70f105d6309fb1acdb4b18c5	2ae82a3b79f32105716725460	664169	...	105934	14484.249886	16842.234792
4	72841f54183a082de91d9er43	802ae82a3b79f321167254667	75669	...	474814	64920.843406	75489.728232

List example

First COI object in the list where 'crude_confidence' status is 'confirmed'.

>>> from vortexasdk import OnshoreInventoriesSearch
>>> list = OnshoreInventoriesSearch().search(crude_confidence='confirmed').to_list()[0]

{
    measurement_id: '5731385e7b0ce8',
    tank_id: 'c5a6bf5e95e969cf7',
    tank_details: {
        id: 'c5a6bf5e95e969cf7',
        capacity_bbl: 875573,
        capacity_cbm: 139205,
        capacity_ton: 119716,
        corporate_entity_details: {
            id: 'b25523ae823b9e38bb11a161eb60d42194f1a886e58dfe39592dcc324f06f60e',
            label: 'Repsol'
        },
        corporate_entity_id: 'b25523ae823b9e38bb11a161eb60d42194f1a886e58dfe39592dcc324f06f60e',
        crude_confidence: 'confirmed',
        last_updated: '2021-08-03T14: 34: 18.533Z',
        leaf: True,
        location_id: 'a98c21d06633d86c8c55',
        location_details: [
            {
                id: 'a98c21d06633d86c8c55',
                label: 'CartagenaLNGTerminal(Enagas)',
                layer: 'terminal'
            },
            {
                id: 'c7baa1cfb2a11e7c2eca',
                label: 'Cartagena[
                    ES
                ]',
                layer: 'port'
            }
        ],
        name: 'CGA030',
        pos: (-0.926539,
        37.574),
        radius: 45,
        ref_type: 'asset_tank',
        storage_terminal_id: 'e757382d4aa5a8aa77d0f11ac7f535fb32993bae89bdf581771f155d1c0149b8',
        storage_terminal_name: 'RepsolCartagenaRefinery',
        storage_type: 'refinery'
    },
    measurement_timestamp: '2021-09-06T17: 50: 12',
    publish_timestamp: '2021-09-08T13: 59: 45',
    fill_bbl: 732345,
    fill_tons: 100132.79950499999,
    fill_cbm: 116434.06685999999,
    reference_data_version: '20210906-1631611377217',
    latest_in_day: [1720828800000],
    latest_in_doe_week: [1720782000000],
    latest_in_month: [1719792000000],
    latest_in_quarter: [1719792000000],
    latest_in_week: [1720396800000],
    latest_in_year: [1704067200000]
}