Interface ISettlementRepo

interface ISettlementRepo {
    getSettlementAt(
        code: string,
        at: string,
        rc?: string[],
    ): Promise<SettlementResponse>;
    getSettlementRatioTopBottom(
        direction: Direction,
        period: SettlementPeriod,
        size: NumberRange<1, 50>,
        brokerType?: SettlementBrokerType,
    ): Promise<SettlementRatioTopBottomResponse>;
}

Index

Methods

getSettlementAt getSettlementRatioTopBottom

Methods

getSettlementAt

getSettlementAt(
    code: string,
    at: string,
    rc?: string[],
): Promise<SettlementResponse>
Parameters
- code: string
  code
- at: string
  at date format: yyyyMMdd
- Optionalrc: string[]
  rc only return given broker information.
Returns Promise<SettlementResponse>
Description
this service provides settlement values of symbols. You can obtain settlement info by providing symbol code or broker code and date.
- Defined in commons/repositories/SettlementRepo.ts:15

getSettlementRatioTopBottom

getSettlementRatioTopBottom(
    direction: Direction,
    period: SettlementPeriod,
    size: NumberRange<1, 50>,
    brokerType?: SettlementBrokerType,
): Promise<SettlementRatioTopBottomResponse>
Parameters
- direction: Direction
  the order of settlement data by ratio change
- period: SettlementPeriod
  the period of the ratio change
- size: NumberRange<1, 50>
  count of the symbols
- OptionalbrokerType: SettlementBrokerType
  specifies the broker type.
Returns Promise<SettlementRatioTopBottomResponse>
Description
this service provides the most increased (top) and decreased (bottom) sum of settlement ratios
- Defined in commons/repositories/SettlementRepo.ts:25