@qtsurfer/api-client
    Preparing search index...

    Type Alias Dataset

    A dataset's own metadata — not its data. currentVersionId is what a prepare against exchangeId: user reads by default; see DatasetVersion for what a version carries.

    from/to/cadence/timestampUnit/bytes/rows/gaps/largestGapSteps mirror that current version's own discovered range, cadence, timestamp unit and metrics, so you don't need a second call to GET /datasets/{datasetId}/uploads/{uploadId} just to see what a dataset covers.

    type Dataset = {
        bytes?: number;
        cadence?: string;
        createdAt: string;
        currentVersionId?: string;
        datasetId: string;
        deletedAt?: string;
        error?: string;
        from?: string;
        gaps?: number;
        instrument: Instrument;
        largestGapSteps?: number;
        name: string;
        rows?: number;
        status: "ready" | "failed" | "pending";
        timestampUnit?: "iso" | "s" | "ms" | "us";
        to?: string;
        type: "ticker" | "klines";
        updatedAt?: string;
    }
    Index
    bytes? cadence? createdAt currentVersionId? datasetId deletedAt? error? from? gaps? instrument largestGapSteps? name rows? status timestampUnit? to? type updatedAt?
    bytes?: number

    Size of currentVersionId's own stored file. Present only when status is ready — see DatasetVersion.bytes for what it measures exactly.

    cadence?: string

    currentVersionId's own discovered cadence — a fixed grid (e.g. 1s, 1m, 1h) or rt (see DatasetVersion.cadence). Absent until a version exists.

    createdAt: string

    When the dataset was created.

    currentVersionId?: string

    The id of the most recently finalized, successfully ingested version. Absent until at least one upload has finished ingesting.

    datasetId: string

    Opaque id, returned by POST /datasets.

    deletedAt?: string

    When you deleted this dataset. Only ever present in GET /datasets?includeDeleted=true, and only on datasets you have deleted.

    error?: string

    A human-readable reason the most recent upload/import attempt failed. Present only when status is failed.

    from?: string

    Start of currentVersionId's own data range, as discovered at ingest time. Absent until a version exists.

    gaps?: number

    currentVersionId's own gap count at its discovered cadence. Present only when status is ready.

    instrument: Instrument
    largestGapSteps?: number

    currentVersionId's own largest gap, in units of its discovered cadence step. Present only when status is ready.

    name: string

    Unique among your datasets.

    rows?: number

    currentVersionId's own row count. Present only when status is ready.

    status: "ready" | "failed" | "pending"
    • ready — currentVersionId is set; from/to/cadence/bytes/rows/gaps/ largestGapSteps describe it.
    • failed — the most recent upload/import attempt failed. currentVersionId and the fields above are absent — there is nothing to read yet. See error.
    • pending — nothing has ever been attempted (just created, or an upload was never finalized).
    timestampUnit?: "iso" | "s" | "ms" | "us"

    currentVersionId's own timestamp unit (see DatasetVersion.timestampUnit) — decode the timestamp column of dataUrl's file accordingly. Present only when status is ready.

    to?: string

    End of currentVersionId's own data range, as discovered at ingest time. Absent until a version exists.

    type: "ticker" | "klines"

    ticker for an upload, a dex import with no cadence requested (native per-trade data) or a cex import with dataType: ticker. klines for a dex import that requested a candle cadence — pre-aggregated bars rather than raw ticks — or a cex import with dataType: klines. Purely informational; both shapes are read the same way.

    updatedAt?: string

    When currentVersionId last changed. Absent until it has a value.

    Settings
    Member Visibility

    On This Page
    Properties