Naming conventions
How Nutrimatic names SDK read methods. The method name tells you what you get back.
List vs get
| Pattern | Meaning | Example |
|---|---|---|
list{Entities}(…) | A collection (0..N items) | catalog.listInstruments() |
get{Entity}(…) | One item by canonical ID or key | catalog.getInstrument(id) |
get{Entity}Profile(…) | Editorial metadata (separate from identity) | catalog.getInstrumentProfile(id) |
Rules:
- List methods always include the word
list— never rely on plural method names alone (instruments()is not used). - Get methods always start with
getplus the resource name. - Market data and live state use
get*View,get*State, orgetChartintelemetry,venues, oreasy.read— not incatalog.
By module
catalog
| Entity | List | Get one | Profile |
|---|---|---|---|
| Ledger | listLedgers() | — | — |
| Instrument | listInstruments() | getInstrument(id) | getInstrumentProfile(id) |
| Venue | listVenues() | getVenue(id) | — |
| Deployment | — | getDeployment(ledgerScope) | — |
easy.read
| Entity | List | Get one |
|---|---|---|
| Pair | listPairs() | getPair({ pair }) |
Other easy.read methods (getChart, getTokenPrice, getPoolView) return market views, not catalog entries.
telemetry / venues
No list methods — discover IDs via catalog or easy.read, then call get* by ID.
Units
Basis points (bps)
Slippage fields such as slippageBps use basis points:
| Value | Percent |
|---|---|
1 | 0.01% |
50 | 0.50% |
100 | 1% |
Defaults: on QuoteRequest and liquidity add/remove, omit slippageBps → Nutrimatic uses 50. On SwapRequest, omit it → reuse the quote’s slippageBps (you may only pass a tighter value).
Write costs
Swap quotes may include QuoteCost lines on Quote.costs so you can show a breakdown before the user swaps. Other writes can still cost money without that pre-execute list — Fees and costs.
Time units
| Where | Unit |
|---|---|
Candle time, feed event time, chart/feed cursors (after / before) | Unix time in seconds |
Write fields: expiresAt, deadline, SignRequest.expiresAt, SettlementStatus.updatedAt | Unix time in milliseconds |
Do not mix them — a chart after value is not the same scale as a quote expiresAt.
Related
| Goal | Start here |
|---|---|
| Object shapes | Types |
| Cost breakdown on swap quotes | Fees and costs |
| Every read method | Read operations |
| Write module map | Write operations |