OptionalcadenceOutput bar cadence for the prepared range. Coarser cadences are produced on demand by
resampling the source and stored alongside the native blob in cache. A target finer
than the source, or not an exact multiple of it, returns 400. What's accepted, and
what omitting it means, depends on the source:
ticker or funding — one of 1s, 5s, 1m, 3m, 5m, 15m,
30m, 1h, 2h, 4h, 8h, 12h, 1d, 1w, 1q; any other label returns 400.
Omitted = 1s, the publisher's native cadence.kline — one of 1s, 1m, 5m, 15m, 30m, 1h, 4h, 1d;
any other label, including 5s, 3m and 8h, returns 400 and names the accepted
ones. Omitted = 1s. This is the width of the bars a run reads: it is chosen here,
once, and the same strategy can be run at several cadences by preparing the range at
each.exchangeId: user) — omitted = the dataset version's own discovered
cadence (see DatasetVersion.cadence), served as-is. Any cadence equal to or
coarser than it and an exact multiple of it is accepted, including ones outside the
managed-exchange list (e.g. 15s); an rt dataset can be resampled to any fixed
cadence.OptionaldatasetOnly for exchangeId: user: the id of a dataset created via POST /datasets, in place
of instrument. Ignored against a managed exchange.
OptionaldatasetOnly for exchangeId: user, and optional even then: pins a specific past version of
the dataset instead of its current one. Defaults to the dataset's current version.
Start date for the preparation process. Supports the following formats:
OptionalinstrumentRequired unless exchangeId is the reserved value user, in which case send
datasetId instead.
End date for the preparation process. Supports the following formats:
Two shapes, chosen by the
exchangeIdpath segment. Against a managed exchange,instrumentis required anddatasetId/datasetVersionIdare ignored. Against the reservedexchangeId: user, senddatasetIdinstead ofinstrument—instrumentis ignored there, since it comes from the dataset itself.