Catalogue

The following guide describes how to access the catalogue in Sparta's API

The /catalogue endpoint provides structured metadata for all datasets available in the Sparta platform. Each item in the response represents a single curve quotation, offering users a powerful way to discover data relevant to their needs. API Reference: <https://documentation.sparta.app/v2.0/docs/sparta-catalogue>.

πŸ“˜

Example

GET /catalogue?filter[region]=NWE&filter[quotation]=Margin price by load&filter[vertical]=ULSD&pageSize=1


    "items": [
        {
            "id": "0007f4dd-673a-5309-b606-178aadbd2d2c",
            "name": "RAS LAFFAN - BARCELONA VIACAPE Jet-A1 LR2 - Margin by Load",
            "units": "$/mt",
            "filters": {
                "region": "AG",
                "vessel": "LR2",
                "loadPort": "RAS LAFFAN",
                "vertical": "Jet",
                "productType": "Physical",
                "dischargePort": "BARCELONA",
                "quotation": "Margin by load"
            },
            "properties": {
                "vessel": "LR2",
                "routing": "VIACAPE",
                "specName": "Jet-A1",
                "incoterms": "EXS",
                "routeCode": "LAFBCNVIACAPELR2",
                "loadPortName": "RAS LAFFAN",
                "loadPortRegion": "AG",
                "dischargePortName": "BARCELONA",
                "dischargePortRegion": "MED"
            },
            "contracts": [
                "11-15 Aug 25",
                "11-15 Nov 25",
                "11-15 Jul 25",
                "16-20 Oct 25",
                ...
            ]
        }
    ],
    "self": "https://api.sparta.app/v2/catalogue?page=1&pageSize=1",
    "next": "https://api.sparta.app/v2/catalogue?page=2&pageSize=1",
    "prev": null,
    "last": "https://api.sparta.app/v2/catalogue?page=4221&pageSize=1"
}

πŸ” Filtering the catalogue

The curve quotations may include their own custom filters like gradeor loadPort.

There are filters that apply to every curver quotation to refine search results from the beginning:

  • vertical
  • quotation
  • region

Quotations by vertical

GasolineULSDJetNaphthaCrudeFuel Oil
Ara Ref Margin by loadDelivered price by loadDelivered price by loadDelivered price by loadDelivered Outright PriceBlend
Blender Margin by loadFobFobFobDelivered price by loadMargin
Delivered price by loadFreight CostsFreight CostsFreight CostsFobPrice
Freight CostsFreight RateFreight RateFreight RateFreight CostsSales
Freight RateMargin by loadMargin by loadMargin by loadFreight Rate
PriceSalesSalesSalesGPW Complex Setup
SalesGPW Medium Setup
GPW Simple Setup
Ref Margin Complex by load
Ref Margin Medium by load
Ref Margin simple by load

Regions by vertical

GasolineULSDJetNaphthaCrudeFuel Oil
AGAGAGAGAGARA
ARAFAR EASTFAR EASTMedLATAMFUJ
HOUMedRED SEANWENORTH SEAMED
HOU BldRED SEASOUTH EAST ASIAUSGCWAFSING
HOU RefSOUTH EAST ASIAUSGCWAFWCMEXUSGC
SINGUSGCWCI
WAF
WCI

πŸ—’οΈ Curve quotation information

FieldDescription
idUnique identifier of the curve quotation.
nameName of the curve quotation.
quotationName of the quotation type.
unitsUnits of the curve quotation.
filtersFilterable dimensions specific to the curve quotation.
propertiesAny additional metadata.
contractsList of available contracts for curve quotation.

πŸ“† Contracts

Each curve quotation lists the contract periods for which data is available. Contracts are represented like:

Monthly Contracts5-Day Rolling WindowsQuarterly Contracts
.......
.........
May 251-5 Jun 25Q1 25
Jun 256-10 Jun 25Q2 25
Jul 2511-15 Jun 25Q3 25
Aug 2516-20 Jun 25Q4 25
Sep 2521-25 Jun 25Q1 26
Oct 2526-EOM Jun 25Q2 26
.........

What’s Next