com.kucoin.sdk.rest.request.OrderCreateApiRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kucoin-java-sdk Show documentation

Fixed fork of the official Kucoin SDK

The newest version!

/**
 * Copyright 2019 Mek Global Limited.
 */
package com.kucoin.sdk.rest.request;

import java.math.BigDecimal;

import lombok.Builder;
import lombok.Getter;

/**
 * 订单创建对象
 *
 * @author 屈亮
 * @since 2018-09-17
 */
@Getter
@Builder
public class OrderCreateApiRequest {

    /**
     * a valid trading symbol code. e.g. ETH-BTC
     */
    private final String symbol;

    /**
     * [optional] limit or market (default is limit)
     */
    @Builder.Default
    private final String type = "limit";

    /**
     * buy or sell
     */
    private final String side;

    /**
     * price per base currency
     */
    private final BigDecimal price;

    /**
     * amount of base currency to buy or sell
     */
    private final BigDecimal size;

    /**
     * [optional] Desired amount of quote currency to use
     */
    private final BigDecimal funds;

    /**
     * [optional] self trade protect , CN, CO, CB or DC
     */
    @Builder.Default
    private final String stp = "";

    /**
     * [optional] Either loss or entry. Requires stopPrice to be defined
     */
    @Builder.Default
    private final String stop = "";

    /**
     * [optional] Only if stop is defined. Sets trigger price for stop order
     */
    private final BigDecimal stopPrice;

    /**
     * [optional] GTC, GTT, IOC, or FOK (default is GTC)
     */
    @Builder.Default
    private final String timeInForce = "GTC";

    /**
     * [optional] * cancel after n seconds
     */
    private final long cancelAfter;

    /**
     * [optional] ** Post only flag
     */
    private final boolean postOnly;

    /**
     * [optional] Orders not displayed in order book
     */
    private final boolean hidden;

    /**
     * [optional] Only visible portion of the order is displayed in the order book
     */
    private final boolean iceberge;

    /**
     * [optional] The maximum visible size of an iceberg order
     */
    private final BigDecimal visibleSize;

    /**
     * Unique order id selected by you to identify your order e.g. UUID
     */
    private final String clientOid;

    /**
     * [optional] remark for the order, length cannot exceed 100 utf8 characters
     */
    private final String remark;
}