poloniex-node-api
    Preparing search index...

    Class AuthenticatedClient

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get base_url(): URL

      Returns URL

    • get init(): RequestInit

      Returns RequestInit

    • get reject(): boolean

      Returns boolean

    • get symbol(): string

      Returns string

    • get transform(): null | ITransformType

      Returns null | ITransformType

    Methods

    • Cancel an active order.

      Parameters

      • options: { clientOrderId: string } | { id: string }

      Returns Promise<ICanceledOrder>

    • Batch cancel one or many active orders.

      Parameters

      • orders: ({ clientOrderId: string } | { id: string })[]

      Returns Promise<ICanceledOrder[]>

    • Batch cancel one or many active smart orders.

      Parameters

      • orders: ({ clientOrderId: string } | { id: string })[]

      Returns Promise<ICanceledSmartOrder[]>

    • Get borrow status of currencies.

      Parameters

      • options: { currency?: string } = {}

      Returns Promise<IBorrow>

    • Get data for a supported currency all supported currencies.

      Parameters

      • query: { currency: string; includeMultiChainCurrencies: true }

      Returns Promise<IExtendedCurrency>

    • Get data for a supported currency all supported currencies.

      Parameters

      • query: { currency?: undefined; includeMultiChainCurrencies: true }

      Returns Promise<IExtendedCurrency[]>

    • Get data for a supported currency all supported currencies.

      Parameters

      • query: { currency: string; includeMultiChainCurrencies?: false }

      Returns Promise<ICurrency>

    • Get data for a supported currency all supported currencies.

      Parameters

      • Optionalquery: { currency?: string; includeMultiChainCurrencies?: false }

      Returns Promise<ICurrency[]>

    • Get maximum and available buy/sell amount for a given symbol.

      Parameters

      • __namedParameters: { symbol?: string } = {}

      Returns Promise<IMaxSize>

    • Get an order’s status.

      Parameters

      • options: { clientOrderId: string } | { id: string }

      Returns Promise<IOrder>

    • Get a list of all trades for an order specified by its orderId.

      Parameters

      • __namedParameters: { id: string }

      Returns Promise<ITrade[]>

    • Get the latest trade price for a symbol.

      Parameters

      • __namedParameters: { symbol?: string } = {}

      Returns Promise<IPrice>

    • Get a smart order’s status.

      Parameters

      • options: { clientOrderId: string } | { id: string }

      Returns Promise<null | ISmartOrder>

    • Get ticker in last 24 hours for a given symbol.

      Parameters

      • __namedParameters: { symbol?: string } = {}

      Returns Promise<ITicker>

    • Get deposit addresses.

      Parameters

      • options: { currency?: string } = {}

      Returns Promise<Record<string, string>>

    • Parameters

      • Optionalpath: string
      • Optionalinit: IFetchOptions

      Returns Promise<Response>

    • Create a new address for a currency.

      Parameters

      • options: { currency: string }

      Returns Promise<{ address: string }>

    • Type Parameters

      • T = unknown

      Parameters

      • Optionalpath: string
      • Optionalinit: IFetchOptions

      Returns Promise<T>

    • Type Parameters

      • T = unknown

      Parameters

      • Optionalpath: string
      • Optionalinit: IFetchOptions

      Returns Promise<T>

    post

    • Cancel an existing active order, new or partially filled, and place a new order on the same symbol with details from existing order unless amended by new parameters.

      Parameters

      Returns Promise<IOrderId>

    • Cancel an existing untriggered smart order and place a new smart order on the same symbol with details from existing smart order unless amended by new parameters.

      Parameters

      Returns Promise<IOrderId>

    • Immediately place a withdrawal for a given currency, with no email confirmation.

      Parameters

      Returns Promise<{ withdrawalRequestsId: number }>