kucoin-universal-sdk/dist/generate/futures/market/model_get_premium_index_req.d.ts

Official KuCoin Universal SDK.

import { Serializable } from '../../../internal/interfaces/serializable';
export declare class GetPremiumIndexReq implements Serializable {
    /**
     * Symbol of the contract. Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220)
     */
    symbol?: string;
    /**
     * Start time (milliseconds)
     */
    startAt?: number;
    /**
     * End time (milliseconds)
     */
    endAt?: number;
    /**
     * This parameter functions to judge whether the lookup is reversed. True means “yes”. False means “no”. This parameter is set as True by default.
     */
    reverse?: boolean;
    /**
     * Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default.
     */
    offset?: number;
    /**
     * This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.
     */
    forward?: boolean;
    /**
     * Max. record count. The default record count is 10; the maximum length cannot exceed 100
     */
    maxCount?: number;
    /**
     * Private constructor, please use the corresponding static methods to construct the object.
     */
    private constructor();
    /**
     * Creates a new instance of the `GetPremiumIndexReq` class.
     * The builder pattern allows step-by-step construction of a `GetPremiumIndexReq` object.
     */
    static builder(): GetPremiumIndexReqBuilder;
    /**
     * Creates a new instance of the `GetPremiumIndexReq` class with the given data.
     */
    static create(data: {
        /**
         * Symbol of the contract. Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220)
         */
        symbol?: string;
        /**
         * Start time (milliseconds)
         */
        startAt?: number;
        /**
         * End time (milliseconds)
         */
        endAt?: number;
        /**
         * This parameter functions to judge whether the lookup is reversed. True means “yes”. False means “no”. This parameter is set as True by default.
         */
        reverse?: boolean;
        /**
         * Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default.
         */
        offset?: number;
        /**
         * This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.
         */
        forward?: boolean;
        /**
         * Max. record count. The default record count is 10; the maximum length cannot exceed 100
         */
        maxCount?: number;
    }): GetPremiumIndexReq;
    /**
     * Convert the object to a JSON string.
     */
    toJson(): string;
    /**
     * Create an object from a JSON string.
     */
    static fromJson(input: string): GetPremiumIndexReq;
    /**
     * Create an object from Js Object.
     */
    static fromObject(jsonObject: Object): GetPremiumIndexReq;
}
export declare class GetPremiumIndexReqBuilder {
    readonly obj: GetPremiumIndexReq;
    constructor(obj: GetPremiumIndexReq);
    /**
     * Symbol of the contract. Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220)
     */
    setSymbol(value: string): GetPremiumIndexReqBuilder;
    /**
     * Start time (milliseconds)
     */
    setStartAt(value: number): GetPremiumIndexReqBuilder;
    /**
     * End time (milliseconds)
     */
    setEndAt(value: number): GetPremiumIndexReqBuilder;
    /**
     * This parameter functions to judge whether the lookup is reversed. True means “yes”. False means “no”. This parameter is set as True by default.
     */
    setReverse(value: boolean): GetPremiumIndexReqBuilder;
    /**
     * Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default.
     */
    setOffset(value: number): GetPremiumIndexReqBuilder;
    /**
     * This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.
     */
    setForward(value: boolean): GetPremiumIndexReqBuilder;
    /**
     * Max. record count. The default record count is 10; the maximum length cannot exceed 100
     */
    setMaxCount(value: number): GetPremiumIndexReqBuilder;
    /**
     * Get the final object.
     */
    build(): GetPremiumIndexReq;
}