Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "api/transfers"

Index

Functions

Functions

transfers

  • Endpoint to request and filter transfers.

    example

    transfers(["bitfinexdep1"], {direction: "incoming", quantity_min: 10000})

    Parameters

    • accounts: string[]
    • Default value options: object = {}
      • Optional accumulated?: undefined | false | true

        If set to true transfers between the same sender and receiver are accumulated, instead of returning all single transfers.

        default

        true

      • Optional accumulated_max?: undefined | number

        Maximum accumulated token volume of transfers.

      • Optional accumulated_min?: undefined | number

        Minimum accumulated token volume of transfers.

      • Optional chain?: undefined | string

        Chain. Current available values are EOS and BOS.

        default

        EOS

      • Optional contract?: undefined | string

        EOS account on which the token contract has been deployed on.

        default

        eosio.token

      • Optional count_max?: undefined | number

        Maximum transaction count of accumulated transfers.

      • Optional count_min?: undefined | number

        Minimum transaction count of accumulated transfers.

      • Optional direction?: undefined | string

        Direction of transfers for the requested accounts.

        Can be:

        • incoming - only transfers where the requested accounts are the receiver of the tokens.
        • outgoing - only transfers where the requested accounts are the sender of the tokens.
        • both - the requested accounts are either receiver or sender of the tokens.
        • between - only transfers between the requested accounts are returned, other accounts are not considered.
        default

        both

      • Optional excludes?: string[]

        Accounts to exclude from query.

        default

        []

      • Optional limit?: undefined | number

        Result limit.

        default

        1000

      • Optional offset?: undefined | number

        Result offset.

        default

        0

      • Optional quantity_max?: undefined | number

        Maximum token volume of each transfer. If accumulated is set to true, only transfers below this threshold are included in the accumulation.

      • Optional quantity_min?: undefined | number

        Minimum token volume of each transfer. If accumulated is set to true, only transfers above this threshold are included in the accumulation.

        default

        0.1

      • Optional symbol?: undefined | string

        Token symbol.

        default

        EOS

      • Optional time_max?: Date

        Maximum datetime of each transfer.

      • Optional time_min?: Date

        Minimum datetime of each transfer.

        default

        yesterday

    Returns Promise<ApiResponse<TransfersData>>

Generated using TypeDoc