Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PositionApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PositionApi(apiUri?: string, httpConfig?: AxiosRequestConfig, apiKey?: string, secretKey?: string, passphrase?: string): PositionApi

  • Parameters

    • Default value apiUri: string = "https://capi.bitget.com"
    • Default value httpConfig: AxiosRequestConfig = { timeout: 3000 }
    • Default value apiKey: string = ""
    • Default value secretKey: string = ""
    • Default value passphrase: string = ""

    Returns PositionApi

Properties

axiosInstance

axiosInstance: AxiosInstance

Protected signer

signer: (httpMethod: string, url: string, qsOrBody: Dict<any> | null, locale?: undefined | string) => BitgetApiHeader

Type declaration

    • (httpMethod: string, url: string, qsOrBody: Dict<any> | null, locale?: undefined | string): BitgetApiHeader

    • Parameters

      • httpMethod: string
      • url: string
      • qsOrBody: Dict<any> | null
      • Optional locale: undefined | string

      Returns BitgetApiHeader

Methods

getAllPosition

  • 获取全部合约仓位信息 限速规则：5次/s

    Returns Promise<AxiosResponse<BitgetPositionPage[]>>

getHolds

  • 获取合约挂单冻结数量 限速规则：10次/s

    Parameters

    • symbol: string

    Returns Promise<AxiosResponse<BitgetPositionHoldInfo>>

getSinglePosition

  • 获取单个合约仓位信息 限速规则：10次/s

    Parameters

    • symbol: string

    Returns Promise<AxiosResponse<BitgetPositionPage>>

virtualCapital

  • virtualCapital(symbol: string, ftype: string, limit: number, gt?: undefined | number, lt?: undefined | number): Promise<AxiosResponse<BitgetVirtualRecordInfo[]>>

  • 出入金记录

    Parameters

    • symbol: string
    • ftype: string

      类型 1-充值 2-提现

    • limit: number
    • Optional gt: undefined | number
    • Optional lt: undefined | number

    Returns Promise<AxiosResponse<BitgetVirtualRecordInfo[]>>

Generated using TypeDoc