Skip to content

docs: embedder-segment quick start (#26) #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karlwaldman merged 1 commit into from
Jul 3, 2026
Merged

docs: embedder-segment quick start (#26) #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,28 @@ const prices = await client.getLatestPrices();
console.log(prices);
```

## Beyond Oil — Gas, LNG, Carbon & Fuels

The same client covers EU ETS carbon, European gas (TTF), LNG (JKM), and marine/road/aviation fuels — for maritime compliance (EU ETS / FuelEU Maritime), fleet & logistics fuel costing, LNG and European gas analytics, and CBAM reporting.

```typescript
// EU ETS carbon allowances (EUAs) — typed futures helper
const eua = await client.futures.euaCarbon().latest();
console.log(eua.front_month?.last_price); // €XX.XX per tonne CO2

// Dutch TTF natural gas — front month + full forward curve
// (also: .lngJkm(), .naturalGas(), .ukCarbon(), .brent(), .wti(), .gasoil())
const ttf = await client.futures.ttfGas().latest();
console.log(ttf.front_month?.last_price); // €XX.XX/MWh

// Marine and aviation fuels — spot prices by commodity code
const [vlsfo] = await client.getLatestPrices({ commodity: "VLSFO_USD" });
const [jet] = await client.getLatestPrices({ commodity: "JET_FUEL_USD" });
console.log(vlsfo.formatted, jet.formatted); // $XXX.XX $X.XX
```

More spot codes for these markets: `EU_CARBON_EUR`, `DUTCH_TTF_EUR`, `JKM_LNG_USD`, `DIESEL_USD`, `NATURAL_GAS_USD` — and `client.bunkerFuels` for port-level VLSFO/MGO/IFO380. (Futures and bunker endpoints require a plan with futures data — spot prices work on every tier.)

## Usage Examples

### Get Latest Prices (All Commodities)
Expand Down
Loading