Interface getSetParams

interface getSetParams {
    extendedData?: true;
    orderBy?: orderBy;
    owned?: true;
    pageNumber?: number;
    pageSize?: number;
    query?: string;
    setID?: number;
    setNumber?: string | string[];
    subtheme?: string | string[];
    tag?: string;
    theme?: string | string[];
    updatedSince?: Date;
    wanted?: true;
    year?: number | number[];
}

Properties

extendedData? orderBy? owned? pageNumber? pageSize? query? setID? setNumber? subtheme? tag? theme? updatedSince? wanted? year?

Properties

OptionalextendedData

extendedData?: true

Set to 1 to retrieve the full data set, including tags, description and notes.

OptionalorderBy

orderBy?: orderBy

Optionalowned

owned?: true

OptionalpageNumber

pageNumber?: number

OptionalpageSize

pageSize?: number

default 20, max 500

Optionalquery

query?: string

Search term: searches set number, name, theme and subtheme

OptionalsetID

setID?: number

OptionalsetNumber

setNumber?: string | string[]

Full set number, in the format {number}-{variant}, e.g. 6876-1

Optionalsubtheme

subtheme?: string | string[]

Optionaltag

tag?: string

Optionaltheme

theme?: string | string[]

OptionalupdatedSince

updatedSince?: Date

yyyy-mm-dd format

Optionalwanted

wanted?: true

Optionalyear

year?: number | number[]

Settings

Member Visibility

On This Page

Properties